Accéder au contenu principal Passer au contenu complémentaire

Paramètres et actions dans la metaServlet

Les sections qui suivent décrivent les fonctions des paramètres JSON utilisés dans la metaServlet ainsi que l'utilisation de la commande help pour afficher toutes les commandes metaServlet avec leurs exemples d'utilisation et leurs codes d'erreurs.

Pour la liste de toutes les commandes pouvant être utilisées dans la MetaServlet, consultez Commandes d'API de la MetaServlet.

Paramètres

Le tableau suivant fournit des informations détaillées concernant les paramètres JSON utilisés dans la metaServlet :

Paramètre

Fonction

Valeur d'exemple

actionName

Nom de l'action

"taskLog"

active

Statut d'une tâche

true ou false

addStatisticsCodeEnabled

Active ou désactive l'utilisation du code des statistiques

true ou false

authUser

nom d'utilisateur ou d'utilisatrice de l'administrateur

"admin@company.com"

authPass

Mot de passe de l'administrateur

"admin"

branch

Nom de la branche

"trunk"

contextName

Nom des paramètres de contexte

"var1"

description

Description de la tâche, du projet ou du serveur créé·e

"ma première tâche"

execStatisticsEnabled

Active ou désactive l'exécution des statistiques

true ou false

executionServerName

Nom du serveur sur lequel la tâche est déployée

"job_server_1"

onUnknownStateJob

Réponse au Job dont le statut est inconnu

"KILL_TASK", "WAIT"

projectName

Nom du projet

"project1"

taskName

Nom de la tâche

"task1"

taskId

ID de la tâche

1

mode

Mode d'exécution de la tâche

"synchronous" ou "asynchronous"

lable

Libellé de la tâche

"for_demo_only"

source

Source de la branche

"source_name"

target

Cible de la branche

"target_name"

username

Nom de l'utilisateur ou de l'utilisatrice

"usernameA"

password

Mot de passe de l'utilisateur ou de l'utilisatrice

"passwordA"

id

ID du JobServer

1

La commande help

La commande help décrit en détails chaque action que vous pouvez effectuer dans la MetaServlet. Elle fournit :

  • les descriptions de chaque commande,

  • des exemples d'utilisation,

  • les codes d'erreur spécifiques à chaque commande.

Procedure

  • Pour afficher l'aide exhaustive de toutes les commandes, suivez cette syntaxe :

    MetaservletCaller.bat --tac-url=http://<IP_address>:<port>/<WebApplicationName>

    --help all

  • Pour afficher uniquement une courte description de toutes les commandes, suivez cette syntaxe :

    MetaservletCaller.bat --tac-url=http://<IP_address>:<port>/<WebApplicationName -h>

  • Pour afficher l'aide d'une commande en particulier, suivez cette syntaxe :

    MetaservletCaller.bat --tac-url=http://<IP_address>:<port>/<WebApplicationName>

    --help <NomDeLaCommande>

What to do next

Pour la liste de toutes les commandes pouvant être utilisées dans la MetaServlet, consultez Commandes d'API de la MetaServlet.

Accéder à la description des commandes metaServlet sans connexion Internet

About this task

Pour afficher les descriptions des commandes en étant hors ligne, vous devez démarrer l'application MetaServlet une fois et copier la description des commandes dans un fichier pour y accéder sans connexion Internet.

Procedure

  1. Affichez l'aide exhaustive de toutes les commandes en suivant cette syntaxe :
    MetaservletCaller.bat --tac-url=http://<IP_address>:<port>/<WebApplicationName>
    --help all
  2. Copiez le contenu de la commande Help dans un fichier externe (un fichier MetaServletHelp.txt par exemple).
    La prochaine fois que vous n'avez pas d'accès Internet et que vous souhaitez en savoir plus sur une commande MetaServlet spécifique (description, exemples d'utilisation, codes d'erreur), vous pourrez rechercher cette commande dans ce fichier.

Cette page vous a-t-elle aidé ?

Si vous rencontrez des problèmes sur cette page ou dans son contenu – une faute de frappe, une étape manquante ou une erreur technique – faites-le-nous savoir.