ServiceNow CLI Commandes disponibles

  • Rversion finale: Washingtondc
  • Mis à jour 1 févr. 2024
  • 9 minutes de lecture

    • Commandes et arguments de commande disponibles pour le système ServiceNow CLIde base.

    Arguments de commande globaux

    Utilisez des arguments de commande pour définir des options pour toutes les commandes CLI.

    --Aide

    Fournit des informations d’aide pour la commande spécifiée, qui incluent la description, les arguments pris en charge et des exemples. Pour plus d'informations, consultez Obtenir de l'aide avec ServiceNow CLI.

    $ snc --help
    --Debug

    fournit une sortie de journalisation de débogage lors de l’exécution d’une commande. Pour plus d'informations, consultez Obtenir de l'aide avec ServiceNow CLI.

    $ snc record delete --table incident --sysid 552c48888c033300964f4932b03eb092 --debug
    --Profil

    Spécifie le profil nommé à utiliser pour une commande. Pour plus d'informations, consultez Configurer et gérer vos ServiceNow CLI profils de connexion.

    $ snc configure profile set --profile <profilename>
    --Sortie

    Spécifie le format de sortie à utiliser pour une commande. prend ServiceNow CLI en charge les formats de sortie suivants.

    • json : la sortie est au format JSON. Il s’agit de l’option par défaut.
      
{
   "default": {
      "appversion": "1.0.8",
      "host": "https://myinstance.service-now.com",
      "hostversion": "Paris",
      "loginmethod": "basic",
      "output": "json",
      "username": "admin"
   },
   "user1": {
      "appversion": "1.0.8",
      "host": "https://otherinstance.service-now.com",
      "hostversion": "Paris",
      "loginmethod": "basic",
      "output": "yaml",
      "username": "admin"
   }
}
    • yaml : la sortie est formatée au format YAML. Utilisez YAML pour gérer la sortie avec des services et des outils qui émettent ou consomment des chaînes au format YAML. 
      default:
   appversion: 1.0.8
   host: https://myinstance.service-now.com
   hostversion: Paris
   loginmethod: basic
   output: json
   username: admin
user1:
   appversion: 1.0.8
   host: https://otherinstance.service-now.com
   hostversion: Paris
   loginmethod: basic
   output: yaml
   username: admin
    • text : la sortie est formatée sous forme de plusieurs lignes de valeurs de chaîne séparées par des tabulations. Utilisez cette sortie avec les outils de texte UNIX traditionnels tels que grep, sed et awk, ainsi qu’avec le traitement de texte effectué par PowerShell.
      default   https://myinstance.service-now.com   Paris   1.0.8   basic   admin   json 
user1   https://otherinstance.service-now.com   Paris   1.0.8   basic   admin   yaml
    • table : la sortie est formatée sous la forme d’un tableau qui présente les informations dans un format lisible par l’homme.
      NAME   HOST   HOST   VERSION   APP   VERSION   LOGIN   METHOD   USERNAME   OUTPUT 
-------------------------------------------------------------------------------
default   myinstance   Paris   1.0.8   basic   admin   json 
user1   otherinstance   Paris   1.0.8   basic   admin   yaml
    • none : l’interface de ligne de commande n’imprime pas la sortie sur la console. Les messages de réussite, d’erreur et de progression s’affichent toujours.
    $ snc record query --table incident --query ‘active=true’ --output json
    --no-interactive
    Empêche l’interface de ligne de commande d’inviter l’utilisateur à fournir des valeurs d’argument. Si l’utilisateur ne transmet pas de valeur pour un argument requis, le système utilise la valeur par défaut. Si aucune valeur par défaut n’est définie, le système génère une erreur.
    --no-verbose
    La commande s’exécute silencieusement sans messages. Utilisez cet argument dans des scénarios de tests automatisés.

    Configurer le profil

    Créez un profil de connexion pour vous connecter à votre instance, afficher des profils de connexion, actualiser votre connexion et les commandes disponibles, ou supprimer les profils dont vous n’avez plus besoin. Pour en savoir plus sur la configuration de votre profil, reportez-vous à Configurer et gérer vos ServiceNow CLI profils de connexion.

    Configurer un profil par défaut

    Créez un profil de connexion qu’utilise ServiceNow CLI par défaut. Vous devez créer un profil par défaut pour configurer la connexion initiale de l’interface de ligne de commande avec une instance. 

    $ snc configure profile set

    Le système vous demande les informations suivantes :

    Informations demandées Description
    Hôte Le nom d’hôte de l’instance à laquelle se connecter. Prend en charge à la fois l’URL complète (https://my-instance.service-now.com) ou uniquement le nom d’hôte (my-instance).
    Méthode de connexion La méthode de connexion à utiliser pour se connecter à l’instance. Prend en charge Basic, OAuth et OAuth + MFA.
    Nom d\’utilisateur Le nom d’utilisateur à utiliser pour se connecter à l’instance.
    Mot de passe Le mot de passe à utiliser pour se connecter à l’instance.
    ID client ID client à utiliser pour se connecter à l’instance lorsque la méthode de connexion est OAuth ou OAuth + MFA.
    Secret client Le secret client à utiliser pour se connecter à l’instance lorsque la méthode de connexion est OAuth ou OAuth + MFA.
    Code d’authentification Code d’authentification à utiliser pour se connecter à l’instance lorsque la méthode de connexion est OAuth + MFA.
    Format de sortie par défaut Spécifie le mode de mise en forme des résultats de la commande. Les options sont json, yaml, texte et table.
    Configurer un profil nommé

    Créez un profil de connexion nommé à utiliser avec des commandes spécifiques. Cela vous permet de spécifier une instance ou un protocole de connexion différent pour une commande spécifique. 

    $ snc configure profile set [--profile profile-name]

    Le système vous demande les informations suivantes :

    Informations demandées Description
    Hôte Le nom d’hôte de l’instance à laquelle se connecter. Prend en charge à la fois l’URL complète (https://my-instance.service-now.com) ou uniquement le nom d’hôte (my-instance).
    Méthode de connexion La méthode de connexion à utiliser pour se connecter à l’instance. Prend en charge Basic, OAuth et OAuth + MFA.
    Nom d\’utilisateur Le nom d’utilisateur à utiliser pour se connecter à l’instance.
    Mot de passe Le mot de passe à utiliser pour se connecter à l’instance.
    ID client ID client à utiliser pour se connecter à l’instance lorsque la méthode de connexion est OAuth ou OAuth + MFA.
    Secret client Le secret client à utiliser pour se connecter à l’instance lorsque la méthode de connexion est OAuth ou OAuth + MFA.
    Code d’authentification Code d’authentification à utiliser pour se connecter à l’instance lorsque la méthode de connexion est OAuth + MFA.
    Format de sortie par défaut Spécifie le mode de mise en forme des résultats de la commande. Les options sont json, yaml, texte et table.
    Afficher les profils

    Affichez tous les profils de connexion définis dans le fichier de configuration ou affichez les informations sur un profil spécifique. 

    $ snc configure profile list [--profile profile-name]
    Supprimer un profil

    Supprimez un profil de connexion nommé dont vous n’avez plus besoin dans le fichier de configuration. 

    $ snc configure profile remove [--profile profile-name]
    Actualiser un profil

    Mettez à jour les commandes disponibles à partir de l’instance pour le profil donné. Actualisez votre connexion après avoir modifié l’une des commandes sur l’instance correspondante afin de maintenir l’interface de ligne de commande à jour.

    $ snc configure profile refresh [--profile profile-name]

    Effectuer des opérations d’enregistrement

    Créez, lisez, mettez à jour, supprimez et interrogez des enregistrements dans votre instance à l’aide de l’outil ServiceNow CLI de ligne de commande. Pour plus d’informations sur l’exécution d’opérations d’enregistrement, reportez-vous à Effectuer des opérations d’enregistrement à l’aide de ServiceNow CLI.

    Créer un enregistrement

    Insère un seul enregistrement dans une table spécifiée.

    $ snc record create [--table table --data data]

    Transmettez des valeurs pour ces arguments.

    Paramètre Description
    table Requis. Nom de la table dans laquelle sauvegarder l’enregistrement.
    données Requis. Nom de champ et valeur associée pour chaque champ à définir dans l’enregistrement spécifié au format de chaîne JSON.
    Supprimer un enregistrement

    Supprime l’enregistrement spécifié à partir de la table spécifiée.

    $ snc record delete [--table table --sysid sys_id]

    Transmettez des valeurs pour ces arguments.

    Paramètre Description
    table Requis. Nom de la table dans laquelle supprimer l’enregistrement.
    sysid Requis. Sys_id de l’enregistrement à supprimer.
    Obtenir un enregistrement

    Récupère un enregistrement unique en fonction des sys_id spécifiées à partir de la table spécifiée.

    $ snc record get [--table table --sysid sys_id]

    Transmettez des valeurs pour ces arguments.

    Paramètre Description
    table Requis. Nom de la table à partir de laquelle récupérer l’enregistrement.
    sysid Requis. Sys_id de l’enregistrement à récupérer.
    Enregistrements de requêtes

    Récupère plusieurs enregistrements d’une table spécifiée.

    $ snc record query [--displayvalue displayValue --fields fields --limit limit --offset offset --query query --table table]

    Transmettez des valeurs pour ces arguments.

    Paramètre Description
    displayValue Incluez --displayvalue pour récupérer la valeur d’affichage à partir de la base de données pour les champs de référence et de choix. N’incluez pas ce paramètre pour récupérer les valeurs réelles.
    champs Liste de noms de champs séparés par des virgules à renvoyer à partir de la base de données.
    limite Nombre maximal d'enregistrements à renvoyer.
    décalage Index de début des enregistrements pour lequel commencer à récupérer des enregistrements. Utilisez cette valeur pour paginer la récupération des enregistrements.
    query Requis. Requête codée utilisée pour filtrer le jeu de résultats au format suivant : --query '&lt;column_name>&lt;operator>&lt;value>'.
    table Requis. Nom de la table dans laquelle interroger les enregistrements.
    Mettre à jour un enregistrement

    Met à jour l’enregistrement spécifié avec les attributs de données donnés.

    $ snc record update [--sysid sys_id --table table --data data]

    Transmettez des valeurs pour ces arguments.

    Paramètre Description
    table Requis. Nom de la table dans laquelle sauvegarder l’enregistrement.
    sysid Requis. Sys_id de l’enregistrement à mettre à jour.
    données Requis. Nom de champ et valeur associée pour chaque champ à définir dans l’enregistrement spécifié au format de chaîne JSON.

    Travailler avec des extensions

    Ajoutez des extensions à la ServiceNow CLI pour charger des fonctionnalités et des commandes supplémentaires, mettre à jour les extensions existantes ou supprimer les extensions dont vous n’avez plus besoin. Pour en savoir plus, consultez Gérer les ServiceNow CLI extensions.

    Rechercher les extensions disponibles
    $ snc extension list-available -o table
    Installer une extension
    $ snc extension add --name <extension-name>
    Mettre à jour une extension
    $ snc extension update --name <extension-name>
    Supprimer une extension
    $ snc extension remove --name <extension-name>

    Utiliser l’extension ui-component

    Ajouter l’extension ui-component

    Ajoutez le extension de composant ui au ServiceNow CLIfichier .

    $ snc extension add --name ui-component
    Configurer votre projet

    Créez le projet de composant et l’ensemble de fichiers nécessaires au développement d’un composant. Vous pouvez vous connecter à votre instance et créer un périmètre de l’application pour votre composant, ou réserver un périmètre à vérifier ultérieurement.

    $ snc ui-component project [--name name --description description --scope scope --offline]

    Transmettez des valeurs pour ces arguments.

    Nom Description
    nom Requis. Le nom du projet. Doit être un nom de package npm valide et unique.
    description La description du projet qui sera disponible dans le registre npm et la liste des modules d’extension dans votre instance.
    périmètre Périmètre de l’application suggéré à affecter à ce projet et à ses composants. S’il est fourni, l’instance valide le nom. Utilisez les directives relatives à l’identificateur d’espace de noms pour le développement d’applications sur l’instance. Pour plus d’informations, consultez Périmètre de l’application.

    Maximum : 18 caractères.

    Cas : étui serpent.

    Valeur par défaut : x_customerprefix_componentname, où :
    • customerPrefix est la valeur de la glide.appcreator.company.code propriété système sur votre instance.
    • componentName est la valeur fournie dans le paramètre nom du composant lors de la création du projet.

    Vous pouvez également ajouter une valeur au paramètre scopeName dans le fichier now-ui.json . Pour plus d'informations, consultez Modifier le périmètre de l’application d’un composant.
    offline Si la valeur est vraie, crée et échafaude un composant lorsqu’elle est déconnectée de votre instance. Ignore la validation du nom de champ d’application donné.

    Valeur par défaut : faux.
    Exécuter le serveur de développement

    Ajoutez le code de votre composant et testez-le à l’aide d’un serveur de développement local.

    $ snc ui-component develop [--entry entry --open --port port --host host]

    Transmettez des valeurs pour ces arguments.

    Nom Description
    entry Chemin d’accès au module de test dans votre projet de composant.

    Par défaut : exemple/index.js.
    ouvert Ouvre le navigateur par défaut et accède à la page de test.

    Valeur par défaut : false.
    port Port où le serveur de développement s’exécute.

    Par défaut : 8081.
    hôte Adresse de l’hôte à utiliser si vous souhaitez que votre serveur de développement local soit accessible en externe par d’autres utilisateurs. Généralement défini sur 0.0.0.0
    Déployer un composant sur une instance

    Déployez votre composant pour l’afficher dans votre instance en tant que module d’extension d’application.

    $ snc ui-component deploy [--open --force]

    Transmettez des valeurs pour ces arguments.

    Nom Description
    ouvert Si la valeur est vrai, ouvre le navigateur par défaut et l’affiche dans Générateur d'IU votre instance.

    Valeur par défaut : false
    Force Déploie les modifications du composant et remplace tous les enregistrements de composant existants.

    Valeur par défaut : false.