Commandes installées avec CMDB l’interface de ligne de commande et l’API de l’application

  • Rversion finale: Yokohama
  • Mis à jour 30 janv. 2025
  • 17 minutes de lecture
  • Commandes et groupes de commandes disponibles lorsque le module d’extension ServiceNow CLI app-cmdb-api-cli est installé.

    Demander des applications dans l'App Store

    Visitez le site Web ServiceNow Store pour découvrir toutes les applications disponibles et pour obtenir des informations sur la procédure à suivre pour soumettre des demandes à la boutique. Pour obtenir des informations sur les notes de publication cumulatives pour toutes les applications publiées, consultez les ServiceNow Storenotes de publication relatives à l'historique des versions.

    Pour scripter des opérations critiques qui prennent en charge l’automatisation dans l’ensemble de l’entreprise, vous pouvez utiliser les API ou exécuter les opérations de ligne de commande fournies par l’interface de ligne de commande de l’application CMDB et l’application de magasin d’API au lieu d’utiliser l’interface utilisateur. L’application CMDB Application CLI et API store fournit un cadre de travail robuste qui consolide toutes les API associées aux services d’application et les lignes de commande qui vous permettent d’accéder à l’interface de ces API.

    Les commandes de l’application CMDB, de l’interface de ligne de commande et de l’API permettent les tâches suivantes :

    • Enregistrer et créer un service d’application et établir des relations en amont
    • Obtention de détails sur un service d’application donné et ses relations en amont
    • Connecter des constructions de niveau supérieur telles que des applications d’entreprise et des offres de services d’entreprise
    • Remplissage d’un service d’application avec un type de population donné
    • Modification de l’état d’un service d’application

    Pour la solution de l’API REST, consultez API des services SG.

    Convertir un service d’application

    Convertit un service d’application de type manuel ou vide en service d’application calculé. Lors de la conversion, l’enregistrement du service d’application est déplacé dans la table [cmdb_ci_service_calculated] avec la classe nouvellement affectée.

    Groupe de commandes :
    • Groupe parent : graphe de services
    • Groupe enfant : app-service
    Rôles requis
    app_service_admin
    Si vous utilisez un service lié au mappage des services, l’utilisateur doit disposer des rôles requis pour ce service lié au mappage des services.
    Structure de commande
    snc service-graph app-service convert --data '{JSON}'
    Arguments

    Cette commande transmet un objet JSON à l’aide du data paramètre.

    Les propriétés suivantes pour l’identification d’un CI sont prioritaires :
    1. sys_id : si sys_id, le système utilise uniquement la sys_id et ignore les valeurs supplémentaires.
    2. nombre : s’il est fourni sans le sys_id, le système utilise uniquement le numéro et ignore toute valeur supplémentaire.
    3. <Nom du champ IRE> : le système n’utilise ces valeurs que si le sys_id ou le numéro n’est pas fourni.
    Tableau 1. Propriétés de l’objet JSON
    Nom Description
    <nom du champ IRE> Un ou plusieurs champs IRE identifiant le service d’application. Par exemple, nom ou version.

    Type de données : chaîne

    niveaux Nombre de niveaux à inclure dans la conversion.

    Type de données : chaîne

    Numéro Numéro unique qui identifie le service d’application.

    Type de données : chaîne

    sys_id Sys_id du service d’application.

    Type de données : chaîne

    Exemple
    snc service-graph app-service convert --data '{"name":"Test Register","environment":"Test","version":"1.0","levels":8}'
    Valeur de retour
    {
      "result": {
      "status": "success"
      }
    }

    Créer une relation de service d’application

    Construit des relations en amont telles que des applications d’entreprise, des offres de services d’entreprise et d’autres services d’application. L’exécution de cette commande crée une relation, prenant l’entrée avec un seul parent et un objet enfant correspondant.

    Groupe de commandes :
    • Groupe parent : graphe de services
    • Groupe enfant : app-service
    Rôles requis
    app_service_admin
    Si vous utilisez un service lié au mappage des services, l’utilisateur doit disposer des rôles requis pour ce service lié au mappage des services.
    Structure de commande
    snc service-graph app-service create-relationship --data '{JSON}'
    Arguments

    Cette commande transmet un objet JSON à l’aide du data paramètre.

    Les propriétés suivantes pour l’identification d’un CI sont prioritaires :
    1. sys_id : si sys_id, le système utilise uniquement la sys_id et ignore les valeurs supplémentaires.
    2. nombre : s’il est fourni sans le sys_id, le système utilise uniquement le numéro et ignore toute valeur supplémentaire.
    3. <Nom du champ IRE> : le système n’utilise ces valeurs que si le sys_id ou le numéro n’est pas fourni.
    Tableau 2. Propriétés de l’objet JSON
    Nom Description
    enfant Informations identifiant le service d’application enfant avec lequel créer une relation. L’enfant se trouve dans la table Instance de service [cmdb_ci_service_auto].

    Un groupe de CI dynamique peut être ajouté en tant qu’enfant, mais ne peut pas être parent.

    Type de données : objet

    "child": {
      "<IRE field name>": "String",
      "number": "String",
      "sys_id": "String"
    }
    nom du champ child.<IRE> Un ou plusieurs champs IRE identifiant le service d’application enfant. Par exemple, nom ou version.

    Type de données : chaîne

    numéro.enfant Numéro unique qui identifie le service d’application enfant.

    Type de données : chaîne

    child.sys_id Sys_id du service d’application enfant répertorié dans l’instance de service [cmdb_ci_service_auto].

    Type de données : chaîne

    parent Détails identifiant le service d’application parent avec lequel créer une relation.

    Type de données : objet

    "parent": {
      "<IRE field name>": "String",
      "number": "String",
      "sys_id": "String",
      "class_name": "String"
    }
    Nom du champ parent.<IRE> Un ou plusieurs champs IRE identifiant le service d’application. Par exemple, nom ou version.

    Type de données : chaîne

    numéro.parent Numéro unique qui identifie le service d’application.

    Type de données : chaîne

    parent.sys_id Sys_id du service d’application répertorié dans l’instance de service [cmdb_ci_service_auto].

    Type de données : chaîne

    parent.class_name Nom de la classe qui contient le service d’application.
    Le nom de classe parent doit provenir de l’une des tables suivantes :
    • cmdb_ci_service_auto
    • cmdb_ci_service_discovered
    • cmdb_ci_service_by_tags
    • cmdb_ci_service_calculated
    • service_offering
    • cmdb_ci_business_app

    Par défaut : cmdb_ci_service_auto

    Type de données : chaîne

    Exemple
    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"}}'
    Valeur de retour
    {
      "result": {
      "status": "success"
      }
    }

    Supprimer un service d'application

    Supprime un service d’application.

    Groupe de commandes :
    • Groupe parent : graphe de services
    • Groupe enfant : app-service
    Rôles requis
    app_service_admin
    Si vous utilisez un service lié au mappage des services, l’utilisateur doit disposer des rôles requis pour ce service lié au mappage des services.
    Structure de commande
    snc service-graph app-service delete --data '{JSON}'
    Arguments

    Cette commande transmet un objet JSON à l’aide du data paramètre.

    Les propriétés suivantes pour l’identification d’un CI sont prioritaires :
    1. sys_id : si sys_id, le système utilise uniquement la sys_id et ignore les valeurs supplémentaires.
    2. nombre : s’il est fourni sans le sys_id, le système utilise uniquement le numéro et ignore toute valeur supplémentaire.
    3. <Nom du champ IRE> : le système n’utilise ces valeurs que si le sys_id ou le numéro n’est pas fourni.
    Tableau 3. Propriétés de l’objet JSON
    Nom Description
    <nom du champ IRE> Un ou plusieurs champs IRE identifiant le service d’application. Par exemple, nom ou version.

    Type de données : chaîne

    Numéro Numéro unique qui identifie le service d’application.

    Type de données : chaîne

    sys_id Sys_id du service d’application répertorié dans la table Instance de service [cmdb_ci_service_auto].

    Type de données : chaîne

    Exemple
    snc service-graph app-service delete --data '{"name":"Test Register","environment":"Test","version":"1.0"}'
    Valeur de retour
    {
      "result": {
      "status": "success"
      }
    }

    Supprimer la relation de service d’application

    Supprime une relation en amont de service d’application.

    Groupe de commandes :
    • Groupe parent : graphe de services
    • Groupe enfant : app-service
    Rôles requis
    app_service_admin
    Si vous utilisez un service lié au mappage des services, l’utilisateur doit disposer des rôles requis pour ce service lié au mappage des services.
    Structure de commande
    snc service-graph app-service delete-relationship --data '{JSON}'
    Arguments

    Cette commande transmet un objet JSON à l’aide du data paramètre.

    Les propriétés suivantes pour l’identification d’un CI sont prioritaires :
    1. sys_id : si sys_id, le système utilise uniquement la sys_id et ignore les valeurs supplémentaires.
    2. nombre : s’il est fourni sans le sys_id, le système utilise uniquement le numéro et ignore toute valeur supplémentaire.
    3. <Nom du champ IRE> : le système n’utilise ces valeurs que si le sys_id ou le numéro n’est pas fourni.
    Tableau 4. Propriétés de l’objet JSON
    Nom Description
    enfant Informations décrivant la relation enfant à supprimer de l’application de service.

    Type de données : objet

    "child": {
      "<IRE field name>": "String",
      "number": "String",
      "sys_id": "String"
    }
    nom du champ child.<IRE> Un ou plusieurs champs IRE identifiant le service d’application enfant. Par exemple, nom ou version.

    Type de données : chaîne

    numéro.enfant Numéro unique qui identifie le service d’application enfant.

    Type de données : chaîne

    child.sys_id Sys_id du service d’application enfant répertorié dans l’instance de service [cmdb_ci_service_auto].

    Type de données : chaîne

    parent Détails identifiant le service d’application parent à partir duquel supprimer une relation.

    Type de données : objet

    "parent": {
      "<IRE field name>": "String",
      "number": "String",
      "sys_id": "String",
      "class_name": "String"
    }
    Nom du champ parent.<IRE> Un ou plusieurs champs IRE identifiant le service d’application. Par exemple, nom ou version.

    Type de données : chaîne

    numéro.parent Numéro unique qui identifie le service d’application.

    Type de données : chaîne

    parent.sys_id Sys_id du service d’application répertorié dans la table Instance de service [cmdb_ci_service_auto].

    Type de données : chaîne

    parent.class_name Nom de la classe qui contient le service d’application.
    Le nom de classe parent doit provenir de l’une des tables suivantes :
    • cmdb_ci_service_auto
    • cmdb_ci_service_discovered
    • cmdb_ci_service_by_tags
    • cmdb_ci_service_calculated
    • service_offering
    • cmdb_ci_business_app

    Par défaut : cmdb_ci_service_auto

    Type de données : chaîne

    Exemple
    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"}}'
    Valeur de retour
    {
      "result": {
      "status": "success"
      }
    }

    Rechercher un service d’application

    Recherche les détails d’un service d’application donné et ses relations en amont.

    Groupe de commandes :
    • Groupe parent : graphe de services
    • Groupe enfant : app-service
    Rôles requis
    app_service_admin – Ce rôle permet d’afficher de manière illimitée les services d’application.
    app_service_user : ce rôle permet uniquement de visualiser les services d’application à l’état Opérationnel.
    Si vous utilisez un service lié au mappage des services, l’utilisateur doit disposer des rôles requis pour ce service lié au mappage des services.
    Structure de commande
    snc service-graph app-service find --data '{JSON}'
    Arguments

    Cette commande transmet un objet JSON à l’aide du data paramètre.

    Les propriétés suivantes pour l’identification d’un CI sont prioritaires :
    1. sys_id : si sys_id, le système utilise uniquement la sys_id et ignore les valeurs supplémentaires.
    2. nombre : s’il est fourni sans le sys_id, le système utilise uniquement le numéro et ignore toute valeur supplémentaire.
    3. <Nom du champ IRE> : le système n’utilise ces valeurs que si le sys_id ou le numéro n’est pas fourni.
    Tableau 5. Propriétés de l’objet JSON
    Nom Description
    <nom du champ IRE> Un ou plusieurs champs IRE identifiant le service d’application. Par exemple, nom ou version.

    Type de données : chaîne

    Numéro Numéro unique qui identifie le service d’application.

    Type de données : chaîne

    sys_id Sys_id du service d’application répertorié dans la table Instance de service [cmdb_ci_service_auto].

    Type de données : chaîne

    Exemple
    snc service-graph app-service find --data '{"name" : "Test App Service1"}'
    Valeur de retour
    {
      "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"
          }
        ]
      }
    }

    Remplir le service d’application

    Remplit un service d’application avec une méthode de remplissage de service.

    Groupe de commandes :
    • Groupe parent : graphe de services
    • Groupe enfant : app-service
    Rôles requis
    app_service_admin
    Si vous utilisez un service lié au mappage des services, l’utilisateur doit disposer des rôles requis pour ce service lié au mappage des services.
    Structure de commande
    snc service-graph app-service populate --data '{JSON}'
    Arguments

    Cette commande transmet un objet JSON à l’aide du data paramètre.

    Les propriétés suivantes pour l’identification d’un CI sont prioritaires :
    1. sys_id : si sys_id, le système utilise uniquement la sys_id et ignore les valeurs supplémentaires.
    2. nombre : s’il est fourni sans le sys_id, le système utilise uniquement le numéro et ignore toute valeur supplémentaire.
    3. <Nom du champ IRE> : le système n’utilise ces valeurs que si le sys_id ou le numéro n’est pas fourni.
    Tableau 6. Propriétés de l’objet JSON
    Nom Description
    <nom du champ IRE> Un ou plusieurs champs IRE identifiant le service d’application. Par exemple, nom ou version.

    Type de données : chaîne

    Numéro Numéro unique qui identifie le service d’application.

    Type de données : chaîne

    population_method Requis. Identifie la méthode de remplissage et la propriété qui l’accompagne pour identifier le contenu du remplissage.

    Un seul objet d’accompagnement est valide par type.

    Type de données : objet

    population_method.group_id ID du groupe CMDB configuré avec le type de population cmdb_group.

    Type de données : « chaîne »

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

    Type de population associé : cmdb_group

    population_method.niveaux Nombre de niveaux à utiliser dans la création du service. Si la valeur du niveau n’est pas fournie, le système vérifie le sys_property de la valeur. Si svc.manual.convert.levels.default_value n’est pas renseigné, une valeur par défaut de 3 est utilisée.

    Type de données : nombre

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

    Type de population associée : dynamic_service

    Par défaut : 3 si aucune valeur de niveau n’est définie pour le sys_property

    population_method.candidat_service

    Identificateur unique du candidat de service.

    Type de données : chaîne

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

    Type de population associé : tag_based_service_family

    population_method.service_relations Liste des objets contenant des données de hiérarchie pour les CI au sein du service d’application. Tous les CI forment des paires avec un CI parent et un CI enfant. Le CI de niveau supérieur, appelé point d’entrée d’un service d’application, n’a pas de CI parent.

    Type de données : tableau

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

    Type de population associée : service_hierarchy

    population_method.service_relations.child Nom d’un CI enfant lié au CI.

    Type de données : chaîne

    population_method.service_relations.parent Nom d’un CI parent lié au CI.

    Type de données : chaîne

    population_method.balises Liste des objets contenant des balises à associer au CI. Ces informations figurent dans la table Valeurs clés [cmdb_key_value].

    Type de données : tableau

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

    Type de population associé : tag_list

    population_method.balises.balises Nom de balise.

    Type de données : chaîne

    population_method.balises.valeur Valeur de la balise.

    Type de données : chaîne

    population_method.type Requis. Type de remplissage à ajouter au service d’application.

    Type de données : objet

    Valeurs valides :
    • cmdb_group
    • service_hierarchy
    • dynamic_service
    • tag_list
    • tag_based_service_family
    sys_id Sys_id du service d’application répertorié dans la table Instance de service [cmdb_ci_service_auto].

    Type de données : chaîne

    Exemple
    snc service-graph app-service populate --data '{"name":"Test Register","environment":"Test","version":"1.0","population_method":{"group_id":"String","type":"cmdb_group"}}'
    Valeur de retour
    {
      "result": {
      "status": "success"
      }
    }

    Enregistrer le service d’application

    Crée un service d’application, balise et construit des relations en amont telles que des applications d’entreprise, des offres de services d’entreprise et d’autres services d’application.

    Groupe de commandes :
    • Groupe parent : graphe de services
    • Groupe enfant : app-service
    Rôles requis
    app_service_admin
    Si vous utilisez un service lié au mappage des services, l’utilisateur doit disposer des rôles requis pour ce service lié au mappage des services.
    Structure de commande
    snc service-graph app-service register --data '{JSON}'
    Arguments

    Cette commande transmet un objet JSON à l’aide du data paramètre.

    Les propriétés suivantes pour l’identification d’un CI sont prioritaires :
    1. sys_id : si sys_id, le système utilise uniquement la sys_id et ignore les valeurs supplémentaires.
    2. nombre : s’il est fourni sans le sys_id, le système utilise uniquement le numéro et ignore toute valeur supplémentaire.
    3. <Nom du champ IRE> : le système n’utilise ces valeurs que si le sys_id ou le numéro n’est pas fourni.
    Tableau 7. Propriétés de l’objet JSON
    Nom Description
    <nom du champ IRE> Un ou plusieurs champs IRE identifiant le service d’application. Par exemple, nom ou version.

    Type de données : chaîne

    Numéro Numéro unique qui identifie le service d’application.

    Type de données : chaîne

    Relations Relations en amont classées par type.

    Type de données : objet

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

    Le nombre maximal de relations est de 25.

    relationships.business_app
    Liste d’objets représentant les types de relations d’application d’entreprise. Ces valeurs peuvent être définies à l’aide de l’un des éléments suivants en tant que paires clé-valeur.
    • <nom du champ IRE>
    • Numéro
    • sys_id

    Type de données : tableau

    relationships.business_service_offering
    Liste d’objets représentant les types de relations d’offre de service d’entreprise. Ces valeurs peuvent être définies à l’aide des éléments suivants sous forme de paires clé-valeur.
    • <nom du champ IRE>
    • Numéro
    • sys_id

    Type de données : tableau

    relationships.parent_app_service
    Liste d’objets représentant les types de relations de service d’application. Ces valeurs peuvent être définies à l’aide des éléments suivants sous forme de paires clé-valeur.
    • <nom du champ IRE>
    • Numéro
    • sys_id

    Type de données : tableau

    relationships.technical_service_offering
    Liste d’objets représentant les types de relations d’offre de gestion des technologies (anciennement offre de service technique). Ces valeurs peuvent être définies à l’aide des éléments suivants sous forme de paires clé-valeur.
    • <nom du champ IRE>
    • Numéro
    • sys_id

    Type de données : tableau

    sys_id Sys_id du service d’application répertorié dans la table Instance de service [cmdb_ci_service_auto].

    Type de données : chaîne

    balises Liste des objets contenant des définitions de balises sous forme de paires clé-valeur.
    "tags": [
     {
      "key": "String",
      "value": "String"
     }]

    Type de données : tableau

    tags.key Nom de la catégorie de balise.

    Type de données : chaîne

    Balises.valeur Valeur de la balise.

    Type de données : chaîne

    Exemple
    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"}]}'
    Valeur de retour
    {
      "result": {
        "app_service": {
          "sys_id": "99b2a54040697410f87713b6564742ad",
          "name": "Test Register",
          "number": "SNSVC0001014"
        },
        "message": "Service registered successfully",
        "status": "INSERT"
      }
    }

    Mettre à jour un service d'application

    Met à jour un service d’application existant fourni et crée des balises pour le service d’application donné.

    Groupe de commandes :
    • Groupe parent : graphe de services
    • Groupe enfant : app-service
    Rôles requis
    app_service_admin
    Si vous utilisez un service lié au mappage des services, l’utilisateur doit disposer des rôles requis pour ce service lié au mappage des services.
    Structure de commande
    snc service-graph app-service update --data '{JSON}'
    Arguments

    Cette commande transmet un objet JSON à l’aide du data paramètre.

    Les propriétés suivantes pour l’identification d’un CI sont prioritaires :
    1. sys_id : si sys_id, le système utilise uniquement la sys_id et ignore les valeurs supplémentaires.
    2. nombre : s’il est fourni sans le sys_id, le système utilise uniquement le numéro et ignore toute valeur supplémentaire.
    3. <Nom du champ IRE> : le système n’utilise ces valeurs que si le sys_id ou le numéro n’est pas fourni.
    Tableau 8. Propriétés de l’objet JSON
    Nom Description
    <champs ou balises à mettre à jour> Utilisez des paires clé-valeur pour identifier chaque champ ou balise à mettre à jour.

    Seules les informations de base peuvent être mises à jour, aucune relation en amont ne peut être mise à jour.

    Type de données : chaîne

    <nom du champ IRE> Un ou plusieurs champs IRE identifiant le service d’application. Par exemple, nom ou version.

    Type de données : chaîne

    Numéro Numéro unique qui identifie le service d’application.

    Type de données : chaîne

    sys_id Sys_id du service d’application répertorié dans l’instance de service [cmdb_ci_service_auto].

    Type de données : chaîne

    Exemple
    snc service-graph app-service update --data '{"name": "Test Register", "version": "2.0"}'
    Valeur de retour
    {
      "result": {
        "sys_id": "99b2a54040697410f87713b6564742ad",
        "name": "Test Register",
        "number": "SNSVC0001014",
        "version": "2.0"
      }
    }

    Mettre à jour l’état du service d’application

    Change l’état du cycle de vie du service d’application pour activer, désactiver ou mettre hors service.

    Groupe de commandes :
    • Groupe parent : graphe de services
    • Groupe enfant : app-service
    Rôles requis
    app_service_admin
    Si vous utilisez un service lié au mappage des services, l’utilisateur doit disposer des rôles requis pour ce service lié au mappage des services.
    Structure de commande
    snc service-graph app-service update-state --data '{JSON}'
    Arguments

    Cette commande transmet un objet JSON à l’aide du data paramètre.

    Les propriétés suivantes pour l’identification d’un CI sont prioritaires :
    1. sys_id : si sys_id, le système utilise uniquement la sys_id et ignore les valeurs supplémentaires.
    2. nombre : s’il est fourni sans le sys_id, le système utilise uniquement le numéro et ignore toute valeur supplémentaire.
    3. <Nom du champ IRE> : le système n’utilise ces valeurs que si le sys_id ou le numéro n’est pas fourni.
    Tableau 9. Propriétés de l’objet JSON
    Nom Description
    <nom du champ IRE> Un ou plusieurs champs IRE identifiant le service d’application. Par exemple, nom ou version.

    Type de données : chaîne

    Numéro Numéro unique qui identifie le service d’application.

    Type de données : chaîne

    État Requis. État du cycle de vie du service d’application. Ces valeurs sont mises à jour dans la table Instance de service [cmdb_ci_service_auto].
    Valeurs valides :
    • ACTIVER – Le cycle de vie est opérationnel et en cours d’utilisation.
      • operational_status=Opérationnel
      • life_cycle_stage=Opérationnel
      • life_cycle_stage_status=En cours d’utilisation
    • DÉSACTIVER – Le cycle de vie n’est pas opérationnel et est à l’étape de la conception.
      • operational_status=Non opérationnel
      • life_cycle_stage=Conception
      • life_cycle_stage_status=Construire
    • RETRAITE – Fin de vie.
      • operational_status=Mis hors service
      • life_cycle_stage=Fin de vie
      • life_cycle_stage_status=Mis hors service

    Type de données : chaîne

    sys_id Sys_id du service d’application répertorié dans l’instance de service [cmdb_ci_service_auto].

    Type de données : chaîne

    Exemple
    snc service-graph app-service update-state --data '{"name":"Test Register","environment":"Test","version":"1.0"}'
    Valeur de retour
    {
      "result": {
      "status": "success"
      }
    }