Créer une commande personnalisée dans ServiceNow CLI
Gérez votre application personnalisée à partir de la ligne de commande en créant des commandes personnalisées dans le ServiceNow CLI.
Avant de commencer
Rôle requis : admin
Pourquoi et quand exécuter cette tâche
Procédure
-
Mettez un point de terminaison REST à la disposition d’une ServiceNow CLI commande.
- Accédez à la Interface de ligne de commande (CLI) > Points de terminaison.
-
Sélectionnez Nouveau et remplissez le formulaire.
Champ Description Chemin d'accès à la ressource Requis. Chemin d’accès au point de terminaison sur l’instance vers laquelle mapper une commande. Peut être le chemin d’accès à une API REST entrante ou à une API REST scriptée. Par exemple, api/now/table/{table}/{sysid}. Pour plus d’informations, consultez API REST disponibles et API REST basées sur un script.Méthode HTTP Requis. Méthode HTTP à utiliser lorsque l’utilisateur exécute la commande associée. Demande Périmètre de l’application en lecture seule pour le point de terminaison.
- Facultatif :
Créez un groupe de commandes.
Vous pouvez également ajouter votre nouvelle commande à un groupe de commandes existant.
- Accédez à la Interface de ligne de commande (CLI) > Groupes de commande.
-
Sélectionnez Nouveau et remplissez le formulaire.
Champ Description Nom Requis. Nom du groupe de commandes. Groupe parent Groupe de commandes parent. Groupe de référence Groupe de commandes à référencer. Par exemple, vous pouvez créer un nouveau groupe de commandes comme alias pour un groupe de commandes existant. Lorsque l’utilisateur appelle une commande référencée à l’aide du nouveau groupe de commandes, la commande d’origine s’exécute. Cela vous permet de créer un groupe de commandes spécifique à votre application personnalisée qui inclut à la fois des commandes nouvelles et existantes. Description brève Requis. Brève description du groupe de commandes. Description Description du groupe de commandes utilisé comme texte d’aide lorsque l’utilisateur exécute la commande --helpsur le groupe de commandes.Demande Périmètre de l’application en lecture seule pour le groupe de commandes. Actif Lorsque cette option est sélectionnée, le groupe de commandes est actif.
-
Créez une commande.
- Accédez à la Interface de ligne de commande (CLI) > Commandes.
-
Sélectionnez Nouveau et remplissez le formulaire.
Champ Description Nom Requis. Nom de la commande. Groupe de commandes Requis. Groupe de commande dont la commande fait partie. Commande de référence Commande à référencer. Par exemple, vous pouvez créer une nouvelle commande en tant qu’alias pour une commande existante. Lorsque l’utilisateur appelle la nouvelle commande, la commande d’origine s’exécute. Cela vous permet de créer une commande spécifique à votre application personnalisée qui exécute des fonctionnalités existantes. Remarque :Une commande ne peut pas faire référence à une commande qui fait référence à une autre commande, ou faire référence à une commande descendante, une commande ancêtre ou une commande de rappel.Point de terminaison d'API Requis. Appel d’API à exécuter lorsque l’utilisateur exécute la commande. Description brève Requis. Brève description de la commande. Demande Périmètre de l’application en lecture seule pour la commande. Actif Lorsque cette option est sélectionnée, la commande est active. Est une commande de rappel Si la valeur est vrai, la commande est désignée comme une commande de rappel. Sélectionnez cette option pour masquer la commande du client CLI et empêcher les utilisateurs de l’appeler à partir de la ligne de commande. Utilisez ce champ avec la section Rappel d’une commande primaire. La commande de rappel s’exécute lorsque la commande principale est terminée.
Texte d’aide Description Description de la commande utilisée comme texte d’aide lorsque l’utilisateur exécute la commande --aide.Exemples Exemples de la commande utilisée comme texte d’aide lorsque l’utilisateur exécute la commande --aide.Expressions Expression de réussite Expression utilisée pour évaluer la réponse du serveur et déterminer si la commande a réussi. Par exemple, result.code = 1.Expression d'échec Expression utilisée pour évaluer la réponse du serveur et déterminer si la commande a échoué. Messages Message de réussite Message affiché sur le client CLI lorsque la commande aboutit. Message de progression Message affiché sur le client CLI lorsque la commande est en cours. Message d'échec Message affiché sur le client CLI en cas d’échec de la commande. Rappel Expression de rappel Expression utilisée pour déterminer s’il faut exécuter la commande de rappel. Par exemple, vous pouvez écrire une expression qui vérifie un processus de longue durée. Si l’expression produit un certain résultat, le rappel s’exécute. Commande de rappel Commande à exécuter lorsque l’expression de rappel est satisfaite. Il doit s’agir d’une commande avec le champ Is Callback Command sélectionné. Intervalle de rappel Intervalle entre les exécutions de commandes de rappel. Unité : millisecondes
Par défaut : 1 000
Nombre maximal d’essais Nombre maximal d’exécutions de la commande de rappel. Valeur par défaut : 10
-
Dans les listes connexes Arguments de commande, créez tous les arguments de commande nécessaires pour la commande.
Créez un argument de commande pour permettre aux utilisateurs de définir des options lors de l’exécution d’une commande.
Champ Description Nom Requis. Nom de l’argument de commande, par exemple data.Nom court Brève dame de l’argument de commandement, par exemple d.Type de données Requis. Type de données attendues pour l’argument de commande. Les options incluent : - Chaîne : permet aux utilisateurs de saisir une chaîne comme entrée.
- Nombre entier : permet aux utilisateurs de saisir un nombre comme entrée.
- Booléen : permet aux utilisateurs d’entrer
vraioufauxcomme entrée. - Entrée de fichier : permet aux utilisateurs de charger un fichier en tant qu’entrée. Mappez cet argument à un type de paramètre du corps dans la liste connexe Arguments de point de terminaison d’API lors de l’étape suivante. Les utilisateurs peuvent transmettre du texte brut, YAML, JSON ou un autre type de fichier accepté par l’API REST. Lorsque l’utilisateur soumet un fichier YAML, le client CLI convertit le fichier au format JSON par défaut. Utilisez le champ Ignorer le prétraitement pour désactiver ce comportement.
- Mot de passe : permet aux utilisateurs de saisir un mot de passe en toute sécurité comme entrée.
Remarque :Pour les types de données Entrée de fichier, la limite de taille de fichier est de 10 Mo par défaut. Toutefois, vous modifiez cette limite à l’aide de la glide.rest.scripted.max_inbound_content_length_mb propriété système.Ignorer le prétraitement Définissez ce marqueur pour empêcher le client CLI de convertir les fichiers YAML au format JSON avant de les envoyer dans la demande. Lorsque le type de données est défini sur Entrée de fichier et que l’utilisateur soumet un fichier YAML, le client CLI convertit le fichier en JSON avant d’exécuter la commande par défaut. Remarque :S’applique uniquement lorsque le type de données est défini sur Entrée de fichier.Valeur par défaut Valeur par défaut à utiliser lorsque l’utilisateur ne transmet pas de valeur. Description brève Requis. Brève description de l’argument de commande. Utilisé comme texte d’aide lorsque l’utilisateur exécute la commande --aide.Demande Périmètre de l’application en lecture seule pour l’argument. Commande Requis. Commande à laquelle l’argument s’applique. Obligatoire Lorsque cette option est sélectionnée, l’utilisateur doit fournir une valeur pour l’argument lors de l’exécution de la commande associée. Invite Invite pour demander des informations à l’utilisateur. L’interface de ligne de commande demande des informations lorsque l’utilisateur n’inclut pas d’argument requis dans une commande. Expression de visibilité Expression utilisée pour déterminer si l’interface de ligne de commande doit demander l’argument. Généralement utilisé pour afficher un argument basé sur la valeur fournie à un argument précédent. Commande Ordre dans lequel demander l’argument. -
Dans les listes connexes Arguments de point de terminaison d’API, créez tous les arguments de point de terminaison d’API nécessaires pour la commande.
Mappez les arguments de commande de la liste connexe Arguments de commande aux paramètres de votre point de terminaison REST.
Champ Description Nom Requis. Nom de l'argument. Valeur Requis. Valeur de la commande que vous souhaitez transmettre au point de terminaison REST. Vous pouvez transmettre une valeur statique ou une expression telle que {flags.table}. Utilisez la variable globaleflagspour accéder aux arguments de la commande.Type de paramètre Requis. Type de paramètre dans le point de terminaison REST auquel vous souhaitez transmettre la valeur . Par exemple, si vous sélectionnez Corps, l’interface de ligne de commande transmet la valeur du champ Valeur au corps du point de terminaison REST. Les options incluent : - Détails
- En-tête
- Chemin
- Requête
Demande Périmètre de l’application en lecture seule pour l’argument. Commande Requis. Commande à laquelle l’argument s’applique. -
Dans les listes connexes Valeurs de retour, créez toutes les valeurs de retour nécessaires pour la commande.
Créez des valeurs de retour pour renvoyer uniquement certaines clés de la réponse.
Champ Description Expression du chemin d'accès Requis. Expression représentant le chemin d’accès à la clé que vous souhaitez renvoyer. Alias Nom de variables à qui affecter la valeur de retour. Demande Périmètre de l’application en lecture seule pour la commande. Commande Requis. Commande à laquelle la valeur de retour s’applique.