Mit CMDB Application CLI and API installierte Befehle

  • Freigeben Version: Xanadu
  • Aktualisiert 1. August 2024
  • 14 Minuten Lesedauer
  • Befehle und Befehlsgruppen, die für ServiceNow CLI verfügbar sind, wenn das Plugin „app-cmdb-api-cli “ installiert ist.

    Apps im Store anfordern

    Besuchen Sie die ServiceNow Store-Website, um alle verfügbaren Apps anzuzeigen und Informationen zum Senden von Anforderungen an den Store zu erhalten. Kumulative Informationen zum Release für alle veröffentlichten Apps finden Sie in den Release-Hinweisen zum ServiceNow Store-Versionsverlauf.

    Um Skripts für kritische Vorgänge zu erstellen, die die Automatisierung im gesamten Unternehmen unterstützen, können Sie APIs nutzen oder Befehlszeilenvorgänge ausführen, die von der CMDB-Anwendungs-CLI und der API-Store-App bereitgestellt werden, anstatt die Anwenderoberfläche zu verwenden. Die CMDB-Anwendungs-CLI und API-Store-App bieten ein robustes Framework, das alle APIs für Anwendungsservices und die Befehlszeilen konsolidiert, mit denen Sie auf die Schnittstelle für diese APIs zugreifen können.

    Die CLI- und API-Befehle der CMDB-Anwendung ermöglichen die folgenden Aufgaben:

    • Registrieren und Erstellen eines Anwendungsservice sowie Aufbau vorgelagerter Beziehungen
    • Details zu einem bestimmten Anwendungsservice und seinen vorgelagerten Beziehungen abrufen
    • Konstrukte auf höherer Ebene wie Geschäftsanwendungen und Business-Service-Angebote werden miteinander verbunden
    • Beim Ausfüllen eines Anwendungsservice mit einem bestimmten Auffüllungstyp
    • Der Status eines Anwendungsservice wird geändert

    Informationen zur REST-API-Lösung finden Sie unter SG-Services-API.

    Anwendungsservice konvertieren

    Konvertiert einen Anwendungsservice vom Typ „Manuell“ oder „Leer“ in einen berechneten Anwendungsservice. Während der Konvertierung wird der Anwendungsservice-Datensatz mit der neu zugewiesenen Klasse in die Tabelle [cmdb_ci_service_calculated] verschoben.

    Befehlsgruppe:
    • Übergeordnete Gruppe: service-graph
    • Untergeordnete Gruppe: app-service
    Erforderliche Rollen
    app_service_admin
    Wenn Sie einen mit Service-Mapping verbundenen Service verwenden, muss der Benutzer über die erforderlichen Rollen für diesen mit Service-Mapping verbundenen Service verfügen.
    Befehlsstruktur
    snc service-graph app-service convert --data '{JSON}'
    Argumente

    Dieser Befehl übergibt ein JSON-Objekt mit dem Parameter data.

    Die folgenden Eigenschaften zum Identifizieren eines CI haben wie folgt Vorrang:
    1. sys_id: Wenn sys_id, verwendet das System nur die sys_id und ignoriert alle zusätzlichen Werte.
    2. Zahl: Bei Angabe ohne sys_id verwendet das System nur die Zahl und ignoriert alle zusätzlichen Werte.
    3. <IRE field name>– Das System verwendet diese Werte nur, wenn die sys_id oder Nummer nicht angegeben ist.
    Tabelle : 1. JSON-Objekteigenschaften
    Name Beschreibung
    <IRE field name> Ein oder mehrere IRE-Felder, die den Anwendungsservice identifizieren. Zum Beispiel Name oder Version.

    Datentyp: Zeichenfolge

    Ebenen Anzahl der Ebenen, die in die Konvertierung aufgenommen werden sollen.

    Datentyp: Zeichenfolge

    Nummer Eindeutige Nummer, die den Anwendungsservice identifiziert.

    Datentyp: Zeichenfolge

    sys_id Sys_id des Anwendungsservice.

    Datentyp: Zeichenfolge

    Beispiel
    snc service-graph app-service convert --data '{"name":"Test Register","environment":"Test","version":"1.0","levels":8}'
    Rückgabewert
    {
      "result": {
      "status": "success"
      }
    }

    Erstellen Sie eine Anwendungsservice-Beziehung

    Erstellt vorgelagerte Beziehungen wie Geschäftsanwendungen, Business-Service-Angebote und andere Anwendungsservices. Beim Ausführen dieses Befehls wird eine Beziehung erstellt, die Eingaben mit einem einzelnen übergeordneten und einem entsprechenden untergeordneten Objekt übernimmt.

    Befehlsgruppe:
    • Übergeordnete Gruppe: service-graph
    • Untergeordnete Gruppe: app-service
    Erforderliche Rollen
    app_service_admin
    Wenn Sie einen mit Service-Mapping verbundenen Service verwenden, muss der Benutzer über die erforderlichen Rollen für diesen mit Service-Mapping verbundenen Service verfügen.
    Befehlsstruktur
    snc service-graph app-service create-relationship --data '{JSON}'
    Argumente

    Dieser Befehl übergibt ein JSON-Objekt mit dem Parameter data.

    Die folgenden Eigenschaften zum Identifizieren eines CI haben wie folgt Vorrang:
    1. sys_id: Wenn sys_id, verwendet das System nur die sys_id und ignoriert alle zusätzlichen Werte.
    2. Zahl: Bei Angabe ohne sys_id verwendet das System nur die Zahl und ignoriert alle zusätzlichen Werte.
    3. <IRE field name>– Das System verwendet diese Werte nur, wenn die sys_id oder Nummer nicht angegeben ist.
    Tabelle : 2. JSON-Objekteigenschaften
    Name Beschreibung
    child Informationen, die den untergeordneten Anwendungsservice identifizieren, mit dem eine Beziehung erstellt werden soll. Das untergeordnete Element befindet sich in der Tabelle „Anwendungsservice“ [cmdb_ci_service_auto].

    Eine dynamische CI-Gruppe kann als untergeordnetes Element hinzugefügt werden, kann jedoch nicht übergeordnet sein.

    Datentyp: Objekt

    "child": {
      "<IRE field name>": "String",
      "number": "String",
      "sys_id": "String"
    }
    untergeordnetes Element.<IRE field name> Mindestens ein IRE-Feld, das den untergeordneten Anwendungsservice identifiziert Zum Beispiel Name oder Version.

    Datentyp: Zeichenfolge

    untergeordnet.nummer Eindeutige Nummer, die den untergeordneten Anwendungsservice identifiziert.

    Datentyp: Zeichenfolge

    child.sys_id Sys_id des untergeordneten Anwendungsservice, der im Anwendungsservice [cmdb_ci_service_auto] aufgeführt ist.

    Datentyp: Zeichenfolge

    übergeordnet Details, die den übergeordneten Anwendungsservice identifizieren, mit dem eine Beziehung erstellt werden soll.

    Datentyp: Objekt

    "parent": {
      "<IRE field name>": "String",
      "number": "String",
      "sys_id": "String",
      "class_name": "String"
    }
    Übergeordnet.<IRE field name> Ein oder mehrere IRE-Felder, die den Anwendungsservice identifizieren. Zum Beispiel Name oder Version.

    Datentyp: Zeichenfolge

    parent.number Eindeutige Nummer, die den Anwendungsservice identifiziert.

    Datentyp: Zeichenfolge

    parent.sys_id Sys_id des im Anwendungsservice [cmdb_ci_service_auto] aufgeführten Anwendungsservices

    Datentyp: Zeichenfolge

    parent.class_name Name der Klasse, die den Anwendungsservice enthält.
    Der Name der übergeordneten Klasse muss aus einer der folgenden Tabellen stammen:
    • cmdb_ci_service_auto
    • cmdb_ci_service_discovered
    • cmdb_ci_service_by_tags
    • cmdb_ci_service_calculated
    • Service.Offering
    • cmdb_ci_business_app

    Standard: cmdb_ci_service_auto

    Datentyp: Zeichenfolge

    Beispiel
    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"}}'
    Rückgabewert
    {
      "result": {
      "status": "success"
      }
    }

    Anwendungsservice löschen

    Löscht einen Anwendungsservice.

    Befehlsgruppe:
    • Übergeordnete Gruppe: service-graph
    • Untergeordnete Gruppe: app-service
    Erforderliche Rollen
    app_service_admin
    Wenn Sie einen mit Service-Mapping verbundenen Service verwenden, muss der Benutzer über die erforderlichen Rollen für diesen mit Service-Mapping verbundenen Service verfügen.
    Befehlsstruktur
    snc service-graph app-service delete --data '{JSON}'
    Argumente

    Dieser Befehl übergibt ein JSON-Objekt mit dem Parameter data.

    Die folgenden Eigenschaften zum Identifizieren eines CI haben wie folgt Vorrang:
    1. sys_id: Wenn sys_id, verwendet das System nur die sys_id und ignoriert alle zusätzlichen Werte.
    2. Zahl: Bei Angabe ohne sys_id verwendet das System nur die Zahl und ignoriert alle zusätzlichen Werte.
    3. <IRE field name>– Das System verwendet diese Werte nur, wenn die sys_id oder Nummer nicht angegeben ist.
    Tabelle : 3. JSON-Objekteigenschaften
    Name Beschreibung
    <IRE field name> Ein oder mehrere IRE-Felder, die den Anwendungsservice identifizieren. Zum Beispiel Name oder Version.

    Datentyp: Zeichenfolge

    Nummer Eindeutige Nummer, die den Anwendungsservice identifiziert.

    Datentyp: Zeichenfolge

    sys_id Sys_id des in der Tabelle „Anwendungsservice“ [cmdb_ci_service_auto] aufgeführten Anwendungsservices.

    Datentyp: Zeichenfolge

    Beispiel
    snc service-graph app-service delete --data '{"name":"Test Register","environment":"Test","version":"1.0"}'
    Rückgabewert
    {
      "result": {
      "status": "success"
      }
    }

    Löschen Sie die Anwendungsservice-Beziehung

    Löscht eine vorgelagerte Beziehung eines Anwendungsservice.

    Befehlsgruppe:
    • Übergeordnete Gruppe: service-graph
    • Untergeordnete Gruppe: app-service
    Erforderliche Rollen
    app_service_admin
    Wenn Sie einen mit Service-Mapping verbundenen Service verwenden, muss der Benutzer über die erforderlichen Rollen für diesen mit Service-Mapping verbundenen Service verfügen.
    Befehlsstruktur
    snc service-graph app-service delete-relationship --data '{JSON}'
    Argumente

    Dieser Befehl übergibt ein JSON-Objekt mit dem Parameter data.

    Die folgenden Eigenschaften zum Identifizieren eines CI haben wie folgt Vorrang:
    1. sys_id: Wenn sys_id, verwendet das System nur die sys_id und ignoriert alle zusätzlichen Werte.
    2. Zahl: Bei Angabe ohne sys_id verwendet das System nur die Zahl und ignoriert alle zusätzlichen Werte.
    3. <IRE field name>– Das System verwendet diese Werte nur, wenn die sys_id oder Nummer nicht angegeben ist.
    Tabelle : 4. JSON-Objekteigenschaften
    Name Beschreibung
    child Informationen, die die untergeordnete Beziehung beschreiben, die aus der Serviceanwendung gelöscht werden soll.

    Datentyp: Objekt

    "child": {
      "<IRE field name>": "String",
      "number": "String",
      "sys_id": "String"
    }
    untergeordnetes Element.<IRE field name> Mindestens ein IRE-Feld, das den untergeordneten Anwendungsservice identifiziert Zum Beispiel Name oder Version.

    Datentyp: Zeichenfolge

    untergeordnet.nummer Eindeutige Nummer, die den untergeordneten Anwendungsservice identifiziert.

    Datentyp: Zeichenfolge

    child.sys_id Sys_id des untergeordneten Anwendungsservice, der im Anwendungsservice [cmdb_ci_service_auto] aufgeführt ist.

    Datentyp: Zeichenfolge

    übergeordnet Details, die den übergeordneten Anwendungsservice identifizieren, aus dem eine Beziehung entfernt werden soll.

    Datentyp: Objekt

    "parent": {
      "<IRE field name>": "String",
      "number": "String",
      "sys_id": "String",
      "class_name": "String"
    }
    Übergeordnet.<IRE field name> Ein oder mehrere IRE-Felder, die den Anwendungsservice identifizieren. Zum Beispiel Name oder Version.

    Datentyp: Zeichenfolge

    parent.number Eindeutige Nummer, die den Anwendungsservice identifiziert.

    Datentyp: Zeichenfolge

    parent.sys_id Sys_id des in der Tabelle „Anwendungsservice“ [cmdb_ci_service_auto] aufgeführten Anwendungsservices.

    Datentyp: Zeichenfolge

    parent.class_name Name der Klasse, die den Anwendungsservice enthält.
    Der Name der übergeordneten Klasse muss aus einer der folgenden Tabellen stammen:
    • cmdb_ci_service_auto
    • cmdb_ci_service_discovered
    • cmdb_ci_service_by_tags
    • cmdb_ci_service_calculated
    • Service.Offering
    • cmdb_ci_business_app

    Standard: cmdb_ci_service_auto

    Datentyp: Zeichenfolge

    Beispiel
    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"}}'
    Rückgabewert
    {
      "result": {
      "status": "success"
      }
    }

    Suchen Sie nach Anwendungsservice

    Sucht die Details eines bestimmten Anwendungsservice und seiner vorgelagerten Beziehungen.

    Befehlsgruppe:
    • Übergeordnete Gruppe: service-graph
    • Untergeordnete Gruppe: app-service
    Erforderliche Rollen
    app_service_admin: Diese Rolle ermöglicht die unbegrenzte Anzeige von Anwendungsservices.
    app_service_user: Diese Rolle ermöglicht nur das Anzeigen von Anwendungsservices im Status „Operativ“.
    Wenn Sie einen mit Service-Mapping verbundenen Service verwenden, muss der Benutzer über die erforderlichen Rollen für diesen mit Service-Mapping verbundenen Service verfügen.
    Befehlsstruktur
    snc service-graph app-service find --data '{JSON}'
    Argumente

    Dieser Befehl übergibt ein JSON-Objekt mit dem Parameter data.

    Die folgenden Eigenschaften zum Identifizieren eines CI haben wie folgt Vorrang:
    1. sys_id: Wenn sys_id, verwendet das System nur die sys_id und ignoriert alle zusätzlichen Werte.
    2. Zahl: Bei Angabe ohne sys_id verwendet das System nur die Zahl und ignoriert alle zusätzlichen Werte.
    3. <IRE field name>– Das System verwendet diese Werte nur, wenn die sys_id oder Nummer nicht angegeben ist.
    Tabelle : 5. JSON-Objekteigenschaften
    Name Beschreibung
    <IRE field name> Ein oder mehrere IRE-Felder, die den Anwendungsservice identifizieren. Zum Beispiel Name oder Version.

    Datentyp: Zeichenfolge

    Nummer Eindeutige Nummer, die den Anwendungsservice identifiziert.

    Datentyp: Zeichenfolge

    sys_id Sys_id des in der Tabelle „Anwendungsservice“ [cmdb_ci_service_auto] aufgeführten Anwendungsservices.

    Datentyp: Zeichenfolge

    Beispiel
    snc service-graph app-service find --data '{"name" : "Test App Service1"}'
    Rückgabewert
    {
      "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"
          }
        ]
      }
    }

    Füllen Sie den Anwendungsservice aus

    Füllt einen Anwendungsservice mit einer Serviceauffüllungsmethode auf.

    Befehlsgruppe:
    • Übergeordnete Gruppe: service-graph
    • Untergeordnete Gruppe: app-service
    Erforderliche Rollen
    app_service_admin
    Wenn Sie einen mit Service-Mapping verbundenen Service verwenden, muss der Benutzer über die erforderlichen Rollen für diesen mit Service-Mapping verbundenen Service verfügen.
    Befehlsstruktur
    snc service-graph app-service populate --data '{JSON}'
    Argumente

    Dieser Befehl übergibt ein JSON-Objekt mit dem Parameter data.

    Die folgenden Eigenschaften zum Identifizieren eines CI haben wie folgt Vorrang:
    1. sys_id: Wenn sys_id, verwendet das System nur die sys_id und ignoriert alle zusätzlichen Werte.
    2. Zahl: Bei Angabe ohne sys_id verwendet das System nur die Zahl und ignoriert alle zusätzlichen Werte.
    3. <IRE field name>– Das System verwendet diese Werte nur, wenn die sys_id oder Nummer nicht angegeben ist.
    Tabelle : 6. JSON-Objekteigenschaften
    Name Beschreibung
    <IRE field name> Ein oder mehrere IRE-Felder, die den Anwendungsservice identifizieren. Zum Beispiel Name oder Version.

    Datentyp: Zeichenfolge

    Nummer Eindeutige Nummer, die den Anwendungsservice identifiziert.

    Datentyp: Zeichenfolge

    „population_method“ Erforderlich. Identifiziert die Ausfüllmethode und die zugehörige Eigenschaft, um den Inhalt für die Ausfüllung zu identifizieren.

    Pro Typ ist nur ein zugehöriges Objekt gültig.

    Datentyp: Objekt

    „population_method.group_id“ Gruppen-ID der CMDB-Gruppe, die mit dem Ausfüllungstyp „cmdb_group“ konfiguriert ist.

    Datentyp: „Zeichenfolge“

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

    Zugehöriger Auffüllungstyp: cmdb_group

    „population_method.levels“ Anzahl der Ebenen, die beim Erstellen des Service verwendet werden sollen. Wenn der Ebenenwert nicht angegeben wird, sucht das System nach dem Wert in sys_property. Wenn svc.manual.convert.levels.default_value nicht ausgefüllt ist, wird der Standardwert 3 verwendet.

    Datentyp: Zahl

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

    Zugehöriger Auffüllungstyp: dynamic_service

    Standard: 3, wenn für sys_property kein Ebenenwert festgelegt ist

    „population_method.service_candidate“

    Eindeutiger Bezeichner des Service-Candidate.

    Datentyp: Zeichenfolge

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

    Zugeordneter Auffüllungstyp: tag_based_service_family

    „population_method.service_relations“ Liste von Objekten, die Hierarchiedaten für die CIs innerhalb des Anwendungsservice enthalten. Alle CIs bilden Paare mit einem übergeordneten und einem untergeordneten CI. Das oberste CI, als Einstiegspunkt eines Anwendungsservice bezeichnet, verfügt nicht über ein übergeordnetes CI.

    Datentyp: Array

    "population_method": {
    
      "service_relations":[
         {
          "child": "String",
          "parent": "String"
         }
      ],
    
      "type": "service_hierarchy"   
    }

    Zugehöriger Auffüllungstyp: service_hierarchy

    „population_method.service_relations.child“ Name eines dem CI zugehörigen untergeordneten CI.

    Datentyp: Zeichenfolge

    „population_method.service_relations.parent“ Name des übergeordneten CI, das sich auf das CI bezieht.

    Datentyp: Zeichenfolge

    „population_method.tags“ Liste von Objekten mit Tags, die dem CI zugeordnet werden sollen. Diese Informationen befinden sich in der Tabelle „Schlüsselwerte“ [cmdb_key_value].

    Datentyp: Array

    "population_method": {
    
      "tags": [
         {
          "tag": "String",
          "value": "String"
         }
      ],
    
      "type": "tag_list"  
    }

    Zugeordneter Auffüllungstyp: tag_list

    „population_method.tags.tag“ Tag-Name

    Datentyp: Zeichenfolge

    „population_method.tags.value“ Tag-Wert.

    Datentyp: Zeichenfolge

    „population_method.type“ Erforderlich. Auffüllungstyp, der dem Anwendungsservice hinzugefügt werden soll.

    Datentyp: Objekt

    Gültige Werte:
    • cmdb_group
    • service_hierarchy
    • dynamic_service
    • tag_list
    • tag_based_service_family
    sys_id Sys_id des in der Tabelle „Anwendungsservice“ [cmdb_ci_service_auto] aufgeführten Anwendungsservices.

    Datentyp: Zeichenfolge

    Beispiel
    snc service-graph app-service populate --data '{"name":"Test Register","environment":"Test","version":"1.0","population_method":{"group_id":"String","type":"cmdb_group"}}'
    Rückgabewert
    {
      "result": {
      "status": "success"
      }
    }

    Registrieren Sie den Anwendungsservice

    Erstellt einen Anwendungsservice, Tags und erstellt vorgelagerte Beziehungen wie Geschäftsanwendungen, Business-Service-Angebote und andere Anwendungsservices.

    Befehlsgruppe:
    • Übergeordnete Gruppe: service-graph
    • Untergeordnete Gruppe: app-service
    Erforderliche Rollen
    app_service_admin
    Wenn Sie einen mit Service-Mapping verbundenen Service verwenden, muss der Benutzer über die erforderlichen Rollen für diesen mit Service-Mapping verbundenen Service verfügen.
    Befehlsstruktur
    snc service-graph app-service register --data '{JSON}'
    Argumente

    Dieser Befehl übergibt ein JSON-Objekt mit dem Parameter data.

    Die folgenden Eigenschaften zum Identifizieren eines CI haben wie folgt Vorrang:
    1. sys_id: Wenn sys_id, verwendet das System nur die sys_id und ignoriert alle zusätzlichen Werte.
    2. Zahl: Bei Angabe ohne sys_id verwendet das System nur die Zahl und ignoriert alle zusätzlichen Werte.
    3. <IRE field name>– Das System verwendet diese Werte nur, wenn die sys_id oder Nummer nicht angegeben ist.
    Tabelle : 7. JSON-Objekteigenschaften
    Name Beschreibung
    <IRE field name> Ein oder mehrere IRE-Felder, die den Anwendungsservice identifizieren. Zum Beispiel Name oder Version.

    Datentyp: Zeichenfolge

    Nummer Eindeutige Nummer, die den Anwendungsservice identifiziert.

    Datentyp: Zeichenfolge

    Beziehungen Vorgelagerte Beziehungen nach Typ kategorisiert.

    Datentyp: Objekt

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

    Die maximale Anzahl der Beziehungen beträgt 25.

    beziehungen.business_app
    Liste von Objekten, die Beziehungstypen für Geschäftsanwendungen darstellen. Diese Werte können mit einem der folgenden Elemente als Schlüssel-Wert-Paare definiert werden.
    • <IRE field name>
    • Nummer
    • sys_id

    Datentyp: Array

    beziehungen.business_service_offering
    Liste von Objekten, die Beziehungstypen für Business-Service-Angebote darstellen. Diese Werte können mit den folgenden Elementen als Schlüssel-Wert-Paare definiert werden.
    • <IRE field name>
    • Nummer
    • sys_id

    Datentyp: Array

    beziehungen.parent_app_service
    Liste von Objekten, die Anwendungsservice-Beziehungstypen darstellen. Diese Werte können mit den folgenden Elementen als Schlüssel-Wert-Paare definiert werden.
    • <IRE field name>
    • Nummer
    • sys_id

    Datentyp: Array

    beziehungen.technical_service_offering
    Liste von Objekten, die Beziehungstypen für technische Serviceangebote darstellen. Diese Werte können mit den folgenden Elementen als Schlüssel-Wert-Paare definiert werden.
    • <IRE field name>
    • Nummer
    • sys_id

    Datentyp: Array

    sys_id Sys_id des in der Tabelle „Anwendungsservice“ [cmdb_ci_service_auto] aufgeführten Anwendungsservices.

    Datentyp: Zeichenfolge

    tags Liste von Objekten, die Tag-Definitionen als Schlüssel-Wert-Paare enthalten.
    "tags": [
     {
      "key": "String",
      "value": "String"
     }]

    Datentyp: Array

    Tags.Schlüssel Name der Tag-Kategorie.

    Datentyp: Zeichenfolge

    Tags.Wert Tag-Wert.

    Datentyp: Zeichenfolge

    Beispiel
    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"}]}'
    Rückgabewert
    {
      "result": {
        "app_service": {
          "sys_id": "99b2a54040697410f87713b6564742ad",
          "name": "Test Register",
          "number": "SNSVC0001014"
        },
        "message": "Service registered successfully",
        "status": "INSERT"
      }
    }

    Anwendungsservice aktualisieren

    Aktualisiert einen vorhandenen bereitgestellten Anwendungsservice und erstellt Tags für den angegebenen Anwendungsservice.

    Befehlsgruppe:
    • Übergeordnete Gruppe: service-graph
    • Untergeordnete Gruppe: app-service
    Erforderliche Rollen
    app_service_admin
    Wenn Sie einen mit Service-Mapping verbundenen Service verwenden, muss der Benutzer über die erforderlichen Rollen für diesen mit Service-Mapping verbundenen Service verfügen.
    Befehlsstruktur
    snc service-graph app-service update --data '{JSON}'
    Argumente

    Dieser Befehl übergibt ein JSON-Objekt mit dem Parameter data.

    Die folgenden Eigenschaften zum Identifizieren eines CI haben wie folgt Vorrang:
    1. sys_id: Wenn sys_id, verwendet das System nur die sys_id und ignoriert alle zusätzlichen Werte.
    2. Zahl: Bei Angabe ohne sys_id verwendet das System nur die Zahl und ignoriert alle zusätzlichen Werte.
    3. <IRE field name>– Das System verwendet diese Werte nur, wenn die sys_id oder Nummer nicht angegeben ist.
    Tabelle : 8. JSON-Objekteigenschaften
    Name Beschreibung
    <fields or tags to update> Verwenden Sie Schlüssel-Wert-Paare, um jedes Feld oder Tag zu identifizieren, das aktualisiert werden soll.

    Nur grundlegende Informationen können aktualisiert werden. Es können keine vorgelagerten Beziehungen aktualisiert werden.

    Datentyp: Zeichenfolge

    <IRE field name> Ein oder mehrere IRE-Felder, die den Anwendungsservice identifizieren. Zum Beispiel Name oder Version.

    Datentyp: Zeichenfolge

    Nummer Eindeutige Nummer, die den Anwendungsservice identifiziert.

    Datentyp: Zeichenfolge

    sys_id Sys_id des im Anwendungsservice [cmdb_ci_service_auto] aufgeführten Anwendungsservices

    Datentyp: Zeichenfolge

    Beispiel
    snc service-graph app-service update --data '{"name": "Test Register", "version": "2.0"}'
    Rückgabewert
    {
      "result": {
        "sys_id": "99b2a54040697410f87713b6564742ad",
        "name": "Test Register",
        "number": "SNSVC0001014",
        "version": "2.0"
      }
    }

    Aktualisiert den Status des Anwendungsservice

    Ändert den Lebenszyklusstatus des Anwendungsservice in „Aktivieren“, „Deaktivieren“ oder „Stillgelegt“.

    Befehlsgruppe:
    • Übergeordnete Gruppe: service-graph
    • Untergeordnete Gruppe: app-service
    Erforderliche Rollen
    app_service_admin
    Wenn Sie einen mit Service-Mapping verbundenen Service verwenden, muss der Benutzer über die erforderlichen Rollen für diesen mit Service-Mapping verbundenen Service verfügen.
    Befehlsstruktur
    snc service-graph app-service update-state --data '{JSON}'
    Argumente

    Dieser Befehl übergibt ein JSON-Objekt mit dem Parameter data.

    Die folgenden Eigenschaften zum Identifizieren eines CI haben wie folgt Vorrang:
    1. sys_id: Wenn sys_id, verwendet das System nur die sys_id und ignoriert alle zusätzlichen Werte.
    2. Zahl: Bei Angabe ohne sys_id verwendet das System nur die Zahl und ignoriert alle zusätzlichen Werte.
    3. <IRE field name>– Das System verwendet diese Werte nur, wenn die sys_id oder Nummer nicht angegeben ist.
    Tabelle : 9. JSON-Objekteigenschaften
    Name Beschreibung
    <IRE field name> Ein oder mehrere IRE-Felder, die den Anwendungsservice identifizieren. Zum Beispiel Name oder Version.

    Datentyp: Zeichenfolge

    Nummer Eindeutige Nummer, die den Anwendungsservice identifiziert.

    Datentyp: Zeichenfolge

    Staat Erforderlich. Lebenszyklusstatus des Anwendungsservice. Diese Werte werden in der Tabelle „Anwendungsservices“ [cmdb_ci_service_auto] aktualisiert.
    Gültige Werte:
    • AKTIVIEREN – Der Lebenszyklus ist betriebsbereit und wird verwendet.
      • operational_status=Funktionsfähig
      • life_cycle_stage=Funktionsfähig
      • life_cycle_stage_status=In Gebrauch
    • DEAKTIVIEREN: Der Lebenszyklus ist nicht funktionsfähig und befindet sich in der Designphase.
      • operational_status=Nicht funktionsfähig
      • Life_cycle_stage = Design
      • Life_cycle_stage_status=Build
    • RETIRE: Ende der Lebensdauer.
      • operational_status=Stillgelegt
      • Life_cycle_stage = Ende der Lebensdauer
      • Life_cycle_stage_status=Stillgelegt

    Datentyp: Zeichenfolge

    sys_id Sys_id des im Anwendungsservice [cmdb_ci_service_auto] aufgeführten Anwendungsservices

    Datentyp: Zeichenfolge

    Beispiel
    snc service-graph app-service update-state --data '{"name":"Test Register","environment":"Test","version":"1.0"}'
    Rückgabewert
    {
      "result": {
      "status": "success"
      }
    }