Commands installed with CMDB Application CLI and API

  • Release version: Xanadu
  • Updated January 30, 2025
  • 17 minutes to read
    • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of Commands installed with CMDB Application CLI and API

    The CMDB Application CLI and API Store App in ServiceNow provides a command-line interface and API framework allowing customers to automate and script operations related to application services within the CMDB. This enables management of application services and their relationships programmatically, bypassing the need to use the user interface for routine or bulk tasks.

    Show full answer Show less

    These commands are available when the app-cmdb-api-cli plugin is installed and require the appserviceadmin role (with additional roles needed for service mapping related operations). The CLI supports both Mac OS and Windows command structures.

    Key Features

    • Convert Application Service: Convert manual or empty application services to calculated ones, moving records into the calculated service table.
    • Create Application Service Relationships: Define upstream relationships between application services, business applications, and service offerings.
    • Delete Application Services and Relationships: Remove application services or their upstream relationships from the CMDB.
    • Find Application Service: Retrieve detailed information about application services, including upstream relationships and critical attributes.
    • Populate Application Service: Populate services using various population methods such as CMDB groups, dynamic services, tag-based service families, service hierarchies, or tag lists.
    • Register Application Service: Create new application services with associated tags and upstream relationships.
    • Update Application Service: Modify existing application service fields and tags (excluding upstream relationships).
    • Update Application Service State: Change lifecycle state of application services to activate, deactivate, or retire with corresponding status updates in CMDB.

    Practical Usage and Commands

    Each command requires a JSON object passed to the CLI via the --data parameter, identifying the target application service primarily by sysid, number, or other identifying fields. Commands support detailed input for specifying relationships, population methods, tags, and states.

    Examples of command usage include:

    • Convert: Convert a service by specifying name, environment, version, and levels.
    • Create Relationship: Define parent-child relationships between services using identifying fields.
    • Delete: Remove services or relationships via identifying attributes.
    • Find: Query services to retrieve comprehensive attribute data and related relationships.
    • Populate: Use different strategies like CMDB groups or dynamic services to populate application services.
    • Register: Create new services with detailed relationship and tag information.
    • Update: Change service attributes such as version or name.
    • Update State: Transition lifecycle states to operational, design, or retired.

    Benefits for ServiceNow Customers

    • Automation: Automate complex CMDB operations related to application services, improving efficiency and accuracy.
    • Consistency: Enforce consistent updates and lifecycle management of application services via scriptable commands.
    • Integration: Integrate CMDB application service management into CI/CD pipelines or enterprise workflows.
    • Comprehensive Control: Manage service relationships, states, population, and metadata without manual UI interaction.

    Requirements and Roles

    Users must have the appserviceadmin role to execute these commands. Additional roles are required when working with service mapping related services.

    Conclusion

    The CMDB Application CLI and API commands provide ServiceNow customers with a robust toolset to script and automate management of application services and their relationships within the CMDB. By leveraging these commands, customers can streamline application service lifecycle management, ensure data consistency, and integrate CMDB operations into broader automation frameworks.

    Commands and command groups available to the ServiceNow CLI when the app-cmdb-api-cli plugin is installed.

    Request apps on the Store

    Visit the ServiceNow Store website to view all the available apps and for information about submitting requests to the store. For cumulative release notes information for all released apps, see the ServiceNow Store version history release notes.

    To script critical operations which support automation across the enterprise, you can leverage APIs or run command line operations that the CMDB Application CLI and API store app provide instead of using the user interface. The CMDB Application CLI and API store app provides a robust framework which consolidates all the APIs that are related to application services and the command lines that let you access the interface to those APIs.

    CMDB Application CLI and API commands enable the following tasks:

    • Registering and creating an application service and establishing upstream relationships
    • Getting details of a given application service and its upstream relationships
    • Connecting higher level constructs such as business applications and business service offerings
    • Populating an application service with a given population type
    • Changing the state of an application service

    For the REST API solution, see SG Services API.

    Convert Application Service

    Converts a manual or empty type application service to a calculated application service. During conversion, the application service record moves into the [cmdb_ci_service_calculated] table with the newly assigned class.

    Command group:
    • Parent group: service-graph
    • Child group: app-service
    Roles required
    app_service_admin
    If using a service mapping related service, the user must have the required roles for that service mapping related service.
    Command structure for Mac OS
    snc service-graph app-service convert --data '{JSON}'
    Command structure for Windows OS
    snc service-graph app-service convert --data "{JSON}"
    Arguments

    This command passes a JSON object using the data parameter.

    The following properties for identifying a CI take precedence as follows:
    1. sys_id – If sys_id, the system only uses the sys_id and ignores any additional values.
    2. number – If provided without the sys_id, the system only uses the number and ignores any additional values.
    3. <IRE field name> – The system only uses these values if the sys_id or number are not provided.
    Table 1. JSON object properties
    Name Description
    <IRE field name> One or more IRE fields identifying the application service. For example, name or version.

    Data type: String
    levels Number of levels to include in the conversion.

    Data type: String
    number Unique number that identifies the application service.

    Data type: String
    sys_id Sys_id of the application service.

    Data type: String
    Example on Mac OS
    snc service-graph app-service convert --data '{"name":"Test Register","environment":"Test","version":"1.0","levels":8}'
    Example on Windows OS
    snc service-graph app-service convert --data "{"name":"Test Register","environment":"Test","version":"1.0","levels":8}"
    Return value
    {
  "result": {
  "status": "success"
  }
}

    Create Application Service Relationship

    Constructs upstream relations such as business applications, business service offerings, and other application services. Running this command creates a relationship, taking input with a single parent and a corresponding child object.

    Command group:
    • Parent group: service-graph
    • Child group: app-service
    Roles required
    app_service_admin
    If using a service mapping related service, the user must have the required roles for that service mapping related service.
    Command structure for Mac OS
    snc service-graph app-service create-relationship --data '{JSON}'
    Command structure for Windows OS
    snc service-graph app-service create-relationship --data "{JSON}"
    Arguments

    This command passes a JSON object using the data parameter.

    The following properties for identifying a CI take precedence as follows:
    1. sys_id – If sys_id, the system only uses the sys_id and ignores any additional values.
    2. number – If provided without the sys_id, the system only uses the number and ignores any additional values.
    3. <IRE field name> – The system only uses these values if the sys_id or number are not provided.
    Table 2. JSON object properties
    Name Description
    child Information identifying the child application service with which to create a relationship. The child is located in the Service Instance [cmdb_ci_service_auto] table.

    A dynamic CI group can be added as a child but cannot be parent.

    Data type: Object

    "child": {
  "<IRE field name>": "String",
  "number": "String",
  "sys_id": "String"
}
    child.<IRE field name> One or more IRE fields identifying the child application service. For example, name or version.

    Data type: String
    child.number Unique number that identifies the child application service.

    Data type: String
    child.sys_id Sys_id of the child application service listed in the Service Instance [cmdb_ci_service_auto].

    Data type: String
    parent Details identifying the parent application service with which to create a relationship.

    Data type: Object

    "parent": {
  "<IRE field name>": "String",
  "number": "String",
  "sys_id": "String",
  "class_name": "String"
}
    parent.<IRE field name> One or more IRE fields identifying the application service. For example, name or version.

    Data type: String
    parent.number Unique number that identifies the application service.

    Data type: String
    parent.sys_id Sys_id of the application service listed in the Service Instance [cmdb_ci_service_auto].

    Data type: String
    parent.class_name Name of the class that contains the application service.
    The parent class name should be from one of the following tables:
    • cmdb_ci_service_auto
    • cmdb_ci_service_discovered
    • cmdb_ci_service_by_tags
    • cmdb_ci_service_calculated
    • service_offering
    • cmdb_ci_business_app

    Default: cmdb_ci_service_auto

    Data type: String
    Example on Mac OS
    snc service-graph app-service create-relationship --data '{"child":{"name":"wdfsdf","environment":"Test","version":"1.0"},"parent":{"sys_id":"abcdefg","name":"business App1","class_name":"service_offering"}}'
    Example on Windows OS
    snc service-graph app-service create-relationship --data "{"child":{"name":"wdfsdf","environment":"Test","version":"1.0"},"parent":{"sys_id":"abcdefg","name":"business App1","class_name":"service_offering"}}"
    Return value
    {
  "result": {
  "status": "success"
  }
}

    Delete Application Service

    Deletes an application service.

    Command group:
    • Parent group: service-graph
    • Child group: app-service
    Roles required
    app_service_admin
    If using a service mapping related service, the user must have the required roles for that service mapping related service.
    Command structure for Mac OS
    snc service-graph app-service delete --data '{JSON}'
    Command structure for Windows OS
    snc service-graph app-service delete --data "{JSON}"
    Arguments

    This command passes a JSON object using the data parameter.

    The following properties for identifying a CI take precedence as follows:
    1. sys_id – If sys_id, the system only uses the sys_id and ignores any additional values.
    2. number – If provided without the sys_id, the system only uses the number and ignores any additional values.
    3. <IRE field name> – The system only uses these values if the sys_id or number are not provided.
    Table 3. JSON object properties
    Name Description
    <IRE field name> One or more IRE fields identifying the application service. For example, name or version.

    Data type: String
    number Unique number that identifies the application service.

    Data type: String
    sys_id Sys_id of the application service listed in the Application Service [cmdb_ci_service_auto] table.

    Data type: String
    Example on Mac OS
    snc service-graph app-service delete --data '{"name":"Test Register","environment":"Test","version":"1.0"}'
    Example on Windows OS
    snc service-graph app-service delete --data "{"name":"Test Register","environment":"Test","version":"1.0"}"
    Return value
    {
  "result": {
  "status": "success"
  }
}

    Delete Application Service Relationship

    Deletes an application service upstream relationship.

    Command group:
    • Parent group: service-graph
    • Child group: app-service
    Roles required
    app_service_admin
    If using a service mapping related service, the user must have the required roles for that service mapping related service.
    Command structure for Mac OS
    snc service-graph app-service delete-relationship --data '{JSON}'
    Command structure for Windows OS
    snc service-graph app-service delete-relationship --data "{JSON}"
    Arguments

    This command passes a JSON object using the data parameter.

    The following properties for identifying a CI take precedence as follows:
    1. sys_id – If sys_id, the system only uses the sys_id and ignores any additional values.
    2. number – If provided without the sys_id, the system only uses the number and ignores any additional values.
    3. <IRE field name> – The system only uses these values if the sys_id or number are not provided.
    Table 4. JSON object properties
    Name Description
    child Information describing the child relationship to be deleted from the service application.

    Data type: Object

    "child": {
  "<IRE field name>": "String",
  "number": "String",
  "sys_id": "String"
}
    child.<IRE field name> One or more IRE fields identifying the child application service. For example, name or version.

    Data type: String
    child.number Unique number that identifies the child application service.

    Data type: String
    child.sys_id Sys_id of the child application service listed in the Service Instance [cmdb_ci_service_auto].

    Data type: String
    parent Details identifying the parent application service from which to remove a relationship.

    Data type: Object

    "parent": {
  "<IRE field name>": "String",
  "number": "String",
  "sys_id": "String",
  "class_name": "String"
}
    parent.<IRE field name> One or more IRE fields identifying the application service. For example, name or version.

    Data type: String
    parent.number Unique number that identifies the application service.

    Data type: String
    parent.sys_id Sys_id of the application service listed in the Application Service [cmdb_ci_service_auto] table.

    Data type: String
    parent.class_name Name of the class that contains the application service.
    The parent class name should be from one of the following tables:
    • cmdb_ci_service_auto
    • cmdb_ci_service_discovered
    • cmdb_ci_service_by_tags
    • cmdb_ci_service_calculated
    • service_offering
    • cmdb_ci_business_app

    Default: cmdb_ci_service_auto

    Data type: String
    Example on Mac OS
    snc service-graph app-service delete-relationship --data '{"child":{"name":"Test Register","environment":"Test","version":"1.0"},"parent":{"name":"business Service Offering1","class_name":"service_offering"}}'
    Example on Windows OS
    snc service-graph app-service delete-relationship --data "{"child":{"name":"Test Register","environment":"Test","version":"1.0"},"parent":{"name":"business Service Offering1","class_name":"service_offering"}}"
    Return value
    {
  "result": {
  "status": "success"
  }
}

    Find Application Service

    Finds the details of a given application service and its upstream relationships.

    Command group:
    • Parent group: service-graph
    • Child group: app-service
    Roles required
    app_service_admin – This role provides unlimited viewing of application services.
    app_service_user – This role only provides viewing application services in Operational status.
    If using a service mapping related service, the user must have the required roles for that service mapping related service.
    Command structure for Mac OS
    snc service-graph app-service find --data '{JSON}'
    Command structure for Windows OS
    snc service-graph app-service find --data "{JSON}"
    Arguments

    This command passes a JSON object using the data parameter.

    The following properties for identifying a CI take precedence as follows:
    1. sys_id – If sys_id, the system only uses the sys_id and ignores any additional values.
    2. number – If provided without the sys_id, the system only uses the number and ignores any additional values.
    3. <IRE field name> – The system only uses these values if the sys_id or number are not provided.
    Table 5. JSON object properties
    Name Description
    <IRE field name> One or more IRE fields identifying the application service. For example, name or version.

    Data type: String
    number Unique number that identifies the application service.

    Data type: String
    sys_id Sys_id of the application service listed in the Application Service [cmdb_ci_service_auto] table.

    Data type: String
    Example on Mac OS
    snc service-graph app-service find --data '{"name" : "Test App Service1"}'
    Example on Windows OS
    snc service-graph app-service find --data "{"name" : "Test App Service1"}"
    Return value
    {
  "result": {
    "aliases": null,
    "asset": null,
    "asset_tag": null,
    "assigned": "",
    "assigned_to": null,
    "assignment_group": null,
    "attestation_score": null,
    "attested": "0",
    "attested_by": null,
    "attested_date": "",
    "attributes": null,
    "bucket": null,
    "business_contact": null,
    "business_need": null,
    "business_relation_manager": null,
    "business_unit": null,
    "busines_criticality": "4 - not critical",
    "can_print": "0",
    "category": null,
    "change_control": null,
    "checked_in": "",
    "checked_out": "",
    "checkout": null,
    "comments": null,
    "company": null,
    "compatibility_dependencies": null,
    "consumer_type": "internal",
    "correlation_id": null,
    "cost": null,
    "cost_cc": "USD",
    "cost_center": null,
    "delivery_date": "",
    "delivery_manager": null,
    "department": null,
    "discovery_source": "Manual Entry",
    "dns_domain": null,
    "due": "",
    "due_in": null,
    "duplicate_of": null,
    "end_date": "",
    "environment": null,
    "fault_count": "0",
    "first_discovered": "2021-07-19 20:09:48",
    "fqdn": null,
    "gl_account": null,
    "hide_from_dashboard": "0",
    "install_date": "",
    "install_status": "1",
    "invoice_number": null,
    "ip_address": null,
    "justification": null,
    "last_discovered": "2021-07-19 20:09:48",
    "last_review_date": "",
    "layer": null,
    "lease_id": null,
    "life_cycle_stage": null,
    "life_cycle_stage_status": null,
    "location": null,
    "mac_address": null,
    "maintenance_schedule": null,
    "managed_by": null,
    "managed_by_group": null,
    "manufacturer": null,
    "model_id": null,
    "model_number": null,
    "monitor": "0",
    "monitoring_requirements": null,
    "name": "Test App Service1",
    "number": "SNSVC0001014",
    "operational_status": "2",
    "order_date": "",
    "owned_by": null,
    "parent": null,
    "portfolio_status": "pipeline",
    "po_number": null,
    "prerequisites": null,
    "price_model": "per_unit",
    "price_unit": null,
    "published_ref": null,
    "purchase_date": "",
    "schedule": null,
    "serial_number": null,
    "service_classification": "Application Service",
    "service_level_requirement": null,
    "service_owner_delegate": null,
    "service_status": "requirements",
    "severity": null,
    "short_description": null,
    "skip_sync": "0",
    "sla": null,
    "spm_service_portfolio": null,
    "spm_taxonomy_node": null,
    "stakeholders": null,
    "start_date": "",
    "state": null,
    "subcategory": null,
    "supported_by": null,
    "support_group": null,
    "sys_class_name": "cmdb_ci_service_auto",
    "sys_class_path": "/!!/!7/!(",
    "sys_created_by": "admin",
    "sys_created_on": "2021-07-19 20:09:48",
    "sys_domain": "global",
    "sys_domain_path": "/",
    "sys_id": "a2f0618040697410f87713b656474255",
    "sys_mod_count": "0",
    "sys_updated_by": "admin",
    "sys_updated_on": "2021-07-19 20:09:48",
    "unit_description": null,
    "unverified": "0",
    "used_for": "Production",
    "user_group": null,
    "vendor": null,
    "version": null,
    "view_service": "61e1cb757f23220002d31ccebefa9120",
    "warranty_expiration": "",
    "relationships": [
      {
        "name": "Test Biz App1",
        "sys_id": "0250a94040697410f87713b656474250",
        "number": "APM0001001",
        "class_name": "cmdb_ci_business_app",
        "relationship": "Consumes::Consumed by"
      },
      {
        "name": "Tech Service Offering1",
        "sys_id": "98d0ed4040697410f87713b6564742ef",
        "number": "BSN0001005",
        "class_name": "service_offering",
        "relationship": "Contains::Contained by"
      }
    ]
  }
}

    Populate Application Service

    Populates an application service with a service population method.

    Command group:
    • Parent group: service-graph
    • Child group: app-service
    Roles required
    app_service_admin
    If using a service mapping related service, the user must have the required roles for that service mapping related service.
    Command structure for Mac OS
    snc service-graph app-service populate --data '{JSON}'
    Command structure for Windows OS
    snc service-graph app-service populate --data "{JSON}"
    Arguments

    This command passes a JSON object using the data parameter.

    The following properties for identifying a CI take precedence as follows:
    1. sys_id – If sys_id, the system only uses the sys_id and ignores any additional values.
    2. number – If provided without the sys_id, the system only uses the number and ignores any additional values.
    3. <IRE field name> – The system only uses these values if the sys_id or number are not provided.
    Table 6. JSON object properties
    Name Description
    <IRE field name> One or more IRE fields identifying the application service. For example, name or version.

    Data type: String
    number Unique number that identifies the application service.

    Data type: String
    population_method Required. Identifies the population method and its accompanying property to identify the content for population.

    Only one accompanying object is valid per type.

    Data type: Object
    population_method.group_id Group ID of the CMDB group configured with the cmdb_group population type.

    Data type: "String"

    "population_method": {
  "group_id": "String",
  "type": "cmdb_group"
}

    Associated population type: cmdb_group
    population_method.levels Number of levels to use in building the service. If the level value is not provided, the system checks the sys_property for the value. If svc.manual.convert.levels.default_value is not populated, a default value of 3 is used.

    Data type: Number

    "population_method": {
  "levels": Number,
  "type": "dynamic_service"
}

    Associated population type: dynamic_service

    Default: 3 if no level value is set for the sys_property
    population_method.service_candidate

    Unique identifier of the service candidate.

    Data type: String

    "population_method": {
  "service_candidate": "String",
  "type": "tag_based_service_family"
}

    Associated population type: tag_based_service_family
    population_method.service_relations List of objects containing hierarchy data for the CIs within the application service. All CIs form pairs with a parent and child CI. The top-level CI, referred to as the entry point of an application service, does not have a parent CI.

    Data type: Array

    "population_method": {

  "service_relations":[
     {
      "child": "String",
      "parent": "String"
     }
  ],

  "type": "service_hierarchy"   
}

    Associated population type: service_hierarchy
    population_method.service_relations.child Name of a child CI related to the CI.

    Data type: String
    population_method.service_relations.parent Name of a parent CI related to the CI.

    Data type: String
    population_method.tags List of objects containing tags to associate with the CI. This information is located in the Key Values [cmdb_key_value] table.

    Data type: Array

    "population_method": {

  "tags": [
     {
      "tag": "String",
      "value": "String"
     }
  ],

  "type": "tag_list"  
}

    Associated population type: tag_list
    population_method.tags.tag Tag name.

    Data type: String
    population_method.tags.value Tag value.

    Data type: String
    population_method.type Required. Population type to add to the application service.

    Data type: Object

    Valid values:
    • cmdb_group
    • service_hierarchy
    • dynamic_service
    • tag_list
    • tag_based_service_family
    sys_id Sys_id of the application service listed in the Application Service [cmdb_ci_service_auto] table.

    Data type: String
    Example on Mac OS
    snc service-graph app-service populate --data '{"name":"Test Register","environment":"Test","version":"1.0","population_method":{"group_id":"String","type":"cmdb_group"}}'
    Example on Windows OS
    snc service-graph app-service populate --data "{"name":"Test Register","environment":"Test","version":"1.0","population_method":{"group_id":"String","type":"cmdb_group"}}"
    Return value
    {
  "result": {
  "status": "success"
  }
}

    Register Application Service

    Creates an application service, tags and constructs upstream relationships such as business applications, business service offerings, and other application services.

    Command group:
    • Parent group: service-graph
    • Child group: app-service
    Roles required
    app_service_admin
    If using a service mapping related service, the user must have the required roles for that service mapping related service.
    Command structure for Mac OS
    snc service-graph app-service register --data '{JSON}'
    Command structure for Windows OS
    snc service-graph app-service register --data "{JSON}"
    Arguments

    This command passes a JSON object using the data parameter.

    The following properties for identifying a CI take precedence as follows:
    1. sys_id – If sys_id, the system only uses the sys_id and ignores any additional values.
    2. number – If provided without the sys_id, the system only uses the number and ignores any additional values.
    3. <IRE field name> – The system only uses these values if the sys_id or number are not provided.
    Table 7. JSON object properties
    Name Description
    <IRE field name> One or more IRE fields identifying the application service. For example, name or version.

    Data type: String
    number Unique number that identifies the application service.

    Data type: String
    relationships Upstream relationships categorized by type.

    Data type: Object

    "relationships": {
 "business_app": [Array],
 "business_service_offering": [Array],
 "parent_app_service": [Array],
 "technical_service_offering": [Array]
}

    Maximum number of relationships is 25.
    relationships.business_app
    List of objects representing Business Application relationship types. These values can be defined using one of the following items as key-value pairs.
    • <IRE field name>
    • number
    • sys_id

    Data type: Array
    relationships.business_service_offering
    List of objects representing Business Service Offering relationship types. These values can be defined using the following items as key-value pairs.
    • <IRE field name>
    • number
    • sys_id

    Data type: Array
    relationships.parent_app_service
    List of objects representing Application Service relationship types. These values can be defined using the following items as key-value pairs.
    • <IRE field name>
    • number
    • sys_id

    Data type: Array
    relationships.technical_service_offering
    List of objects representing Technical Service Offering relationship types. These values can be defined using the following items as key-value pairs.
    • <IRE field name>
    • number
    • sys_id

    Data type: Array
    sys_id Sys_id of the application service listed in the Application Service [cmdb_ci_service_auto] table.

    Data type: String
    tags List of objects containing tag definitions as key-value pairs.
    "tags": [
 {
  "key": "String",
  "value": "String"
 }]

    Data type: Array
    tags.key Tag category name.

    Data type: String
    tags.value Tag value.

    Data type: String
    Example on Mac OS
    snc service-graph app-service register --data '{"name":"Test Register","environment":"Test","version":"1.0","number":" SNSVC0001014","relationships":{"business_application":[{"sys_id":"0250a94040697410f87713b656474250"},{"number":"APM0001002"},{"name":"Test Biz App1"}],"business_service_offering":[{"sys_id":"ed32e98040697410f87713b656474259"}],"technical_service_offering":[{"sys_id":"80e12d8040697410f87713b65647421c"},{"number":"BSN0001005"},{"name":"Tech Service Offering2"}],"parent_app_service":[{"sys_id":"a2f0618040697410f87713b656474255"}]},"tags":[{"key":"key1","value":"value1"},{"key":"key2","value":"value2"}]}'
    Example on Windows OS
    snc service-graph app-service register --data "{"name":"Test Register","environment":"Test","version":"1.0","number":" SNSVC0001014","relationships":{"business_application":[{"sys_id":"0250a94040697410f87713b656474250"},{"number":"APM0001002"},{"name":"Test Biz App1"}],"business_service_offering":[{"sys_id":"ed32e98040697410f87713b656474259"}],"technical_service_offering":[{"sys_id":"80e12d8040697410f87713b65647421c"},{"number":"BSN0001005"},{"name":"Tech Service Offering2"}],"parent_app_service":[{"sys_id":"a2f0618040697410f87713b656474255"}]},"tags":[{"key":"key1","value":"value1"},{"key":"key2","value":"value2"}]}"
    Return value
    {
  "result": {
    "app_service": {
      "sys_id": "99b2a54040697410f87713b6564742ad",
      "name": "Test Register",
      "number": "SNSVC0001014"
    },
    "message": "Service registered successfully",
    "status": "INSERT"
  }
}

    Update Application Service

    Updates an existing application service provided and creates tags for the given application service.

    Command group:
    • Parent group: service-graph
    • Child group: app-service
    Roles required
    app_service_admin
    If using a service mapping related service, the user must have the required roles for that service mapping related service.
    Command structure for Mac OS
    snc service-graph app-service update --data '{JSON}'
    Command structure for Windows OS
    snc service-graph app-service update --data "{JSON}"
    Arguments

    This command passes a JSON object using the data parameter.

    The following properties for identifying a CI take precedence as follows:
    1. sys_id – If sys_id, the system only uses the sys_id and ignores any additional values.
    2. number – If provided without the sys_id, the system only uses the number and ignores any additional values.
    3. <IRE field name> – The system only uses these values if the sys_id or number are not provided.
    Table 8. JSON object properties
    Name Description
    <fields or tags to update> Use key-value pairs to identify each field or tag to be updated.

    Only basic information can be updated, no upstream relationships can be updated.

    Data type: String
    <IRE field name> One or more IRE fields identifying the application service. For example, name or version.

    Data type: String
    number Unique number that identifies the application service.

    Data type: String
    sys_id Sys_id of the application service listed in the Service Instance [cmdb_ci_service_auto].

    Data type: String
    Example on Mac OS
    snc service-graph app-service update --data '{"name": "Test Register", "version": "2.0"}'
    Example on Windows OS
    snc service-graph app-service update --data "{"name": "Test Register", "version": "2.0"}"
    Return value
    {
  "result": {
    "sys_id": "99b2a54040697410f87713b6564742ad",
    "name": "Test Register",
    "number": "SNSVC0001014",
    "version": "2.0"
  }
}

    Update Application Service State

    Changes the application service lifecycle state to activate, deactivate, or retire.

    Command group:
    • Parent group: service-graph
    • Child group: app-service
    Roles required
    app_service_admin
    If using a service mapping related service, the user must have the required roles for that service mapping related service.
    Command structure for Mac OS
    snc service-graph app-service update-state --data '{JSON}'
    Command structure for Windows OS
    snc service-graph app-service update-state --data "{JSON}"
    Arguments

    This command passes a JSON object using the data parameter.

    The following properties for identifying a CI take precedence as follows:
    1. sys_id – If sys_id, the system only uses the sys_id and ignores any additional values.
    2. number – If provided without the sys_id, the system only uses the number and ignores any additional values.
    3. <IRE field name> – The system only uses these values if the sys_id or number are not provided.
    Table 9. JSON object properties
    Name Description
    <IRE field name> One or more IRE fields identifying the application service. For example, name or version.

    Data type: String
    number Unique number that identifies the application service.

    Data type: String
    state Required. Lifecycle state of the application service. These values are updated in the Service Instance [cmdb_ci_service_auto] table.
    Valid values:
    • ACTIVATE – Life cycle is operational and in use.
      • operational_status=Operational
      • life_cycle_stage=Operational
      • life_cycle_stage_status=In Use
    • DEACTIVATE – Life cycle is not operational and is in the design stage.
      • operational_status=Non-Operational
      • life_cycle_stage=Design
      • life_cycle_stage_status=Build
    • RETIRE – End of life.
      • operational_status=Retired
      • life_cycle_stage=End Of Life
      • life_cycle_stage_status=Retired

    Data type: String
    sys_id Sys_id of the application service listed in the Service Instance [cmdb_ci_service_auto].

    Data type: String
    Example on Mac OS
    snc service-graph app-service update-state --data '{"name":"Test Register","environment":"Test","version":"1.0"}'
    Example on Windows OS
    snc service-graph app-service update-state --data "{"name":"Test Register","environment":"Test","version":"1.0"}"
    Return value
    {
  "result": {
  "status": "success"
  }
}