ServiceManager - Programme de ligne de commandes (CLI)

Le programme de ligne de commandes (UCYBSMCL) vous permet de gérer vos services par lots ("batch").

Cette rubrique contient les sujets suivants :

Présentation

Vous pouvez faire démarrer et arrêter des services, ainsi qu'appeler les services d'une liste d'ordinateur dans un environnement ServiceManager. Il est disponible pour Windows et UNIX.

Remarque : Le programme CLI respecte la casse.

Vous pouvez établir une connexion sécurisée (TLS 1.2) avec ServiceManager, tout en ayant des connexions non sécurisées avec d'anciens programmes ServiceManager. Pour les connexions sécurisées, CAPKI doit être installé sur le même ordinateur que celui où a été installé ServiceManager CLI. Si vous passez par une connexion non sécurisée, le programme CLI exécute la commande vers ServiceManager tout en écrivant un message d'avertissement d'erreur Standard.

Syntaxe

Windows :

UCYBSMCL[.EXE] -c GET_PROCESS_LIST -h nom de l'ordinateur -n phrase

UCYBSMCL[.EXE] -c START_PROCESS -h nom de l'ordinateur -n phrase -s nom du service [-p mot de passe]

UCYBSMCL [.EXE] -c STOP_PROCESS -h nom de l'ordinateur -n phrase -s nom du service [-m stop mode] [-p mot de passe]

UCYBSMCL [.EXE] -c SET_DATA -h nom de l'ordinateur -n phrase -s nom du service -d valeur de propriété [-p ùot de passe]

Unix :

ucybsmcl -c GET_PROCESS_LIST -h nom de l'ordinateur:numéro de port -n phrase

ucybsmcl -c START_PROCESS -h nom de l'ordinateur:numéro de port -n phrase -s nom du service [-p mot de passe]

ucybsmcl -c STOP_PROCESS -h nom de l'ordinateur:numéro de port -n phrase -s nom du service [-m mode d'arrêt] [-p mot de passe]

ucybsmcl -c SET_DATA -h nom de l'ordinateur:numéro de port -n phrase -s nom du service -d valeur de propriété [-p mot de passe]

Description des paramètres

-c Commande à traiter

Ce paramètre doit toujours être indiqué.

Attribution :
- GET_PROCESS_LIST: Demande la liste de tous les services appartenant à l'environnement du ServiceManager sur un ordinateur avec les informations disponibles
- START_PROCESS: Démarre un service
- STOP_PROCESS: Arrête un service
- SET_DATA: Définit les propriétés d'un service
-h Ordinateur

Ce paramètre doit toujours être indiqué.

Affectation :
- Nom de l'ordinateur : Nom de l'ordinateur sur lequel le ServiceManager doit être utilisé.
  
  Un ordinateur distant peut aussi être indiqué. Cet ordinateur doit être accessible à partir de l'ordinateur qui l'appelle. L'utilisateur doit disposer de l'autorisation d'accès aux services de l'ordinateur distant.
- Numéro de port : Sous UNIX, le numéro de port du ServiceManager doit également être indiqué.
-n Environnement ServiceManager

Ce paramètre doit toujours être indiqué.

Affectation :
- Phrase : Nom de l'environnement ServiceManager qui regroupe/indique les différents services AE sur un ordinateur. Est également appelé phrase dans le programme de dialogue du ServiceManager.
-s Service

Ce paramètre doit toujours être indiqué à l'exception de GET_PROCESS_LIST.

Affectation :
- Nom du service : Spécification du nom d'un service, soit :
  - qui s'affiche dans la colonne Service du programme de dialogue
  - figure dans la liste du fichier de définition Phrase.SMD
  - disponible dans la sortie de la commande GET_PROCESS_LIST
  Dans la mesure où le nom du service peut aussi contenir des espaces, il doit toujours figurer entre guillemets.
-d Valeur de propriété

Ce paramètre n'est requis que pour SET_DATA.

Affectation :
- Chaîne de caractères de propriété : Cette chaîne de caractères dépend de la propriété spécifiée.
  
  Chaînes de caractères autorisées :
  - Commande
  - StartPath
  - UserName
  - Mot de passe
  - Domain
  - Autostart
  - Delay
  Exemples
  
  ucybsmcl -c SET_DATA -h PC000666 -n Automic -s “RAFTP Agent” -d Command “java -jar -Xrs -Xmx256M ucxjcitx.jar”
  
  ucybsmcl -c SET_DATA -h PC000666 -n Automic -s “RAFTP Agent” -d Autostart 1

-m Mode d'arrêt

Ce paramètre est optionnel pour STOP_PROCESS.

Affectation :
- Mode d'arrêt : Mode d'arrêt du service.
  
  Valeurs autorisées : "C" (valeur par défaut), "S", "A"
  "C" : Close. Le service s'arrête normalement.
  "S" : Shutdown. Le service s'arrête sans délai indépendamment des activités en cours.
  "A" : Abnormally. Le ServiceManager arrête immédiatement le service par un appel système (Kill). Cette commande ne doit être utilisée que si la tentative du service de s'arrêter lui-même a échoué.
-p Mot de Passe

Ce paramètre est optionnel pour START_PROCESS et STOP_PROCESS. Pour plus d'informations sur l'encryptage des mots de passe, voir Chiffrement des mots de passe.

Affectation :
- Mot de passe : Mot de passe autorisant le démarrage et l'arrêt d'un service.
-sm Mode de démarrage des processus de travail du serveur (WP)

Les valeurs qui sont autorisées pour le paramètre -sm dépendent de la définition du service dans le fichier de configuration SMD du ServiceManager.
Pour garantir qu'un mode de démarrage spécifique puisse être assigné au processus de travail lorsqu'il démarre, vous devez configurer "START1=, START2=, START3= ..." dans le fichier SMD pour chaque "DEFINE" d'un service WP. Le fichier SMD UC4.SMD fourni inclut plusieurs exemples de définitions.

Affectation :
- Mode de démarrage : par exemple, la définition d'un service WP dans un fichier SMD (incluant des variables) :
  
  VAR SRV_STARTPATH;*OWN\..\..\Server\bin
  
  VAR WP_STARTCMD;*SRV_STARTPATH\UCsrvwp.exe *SRV_STARTPATH\ucsrv.ini -svc%port%
  
  VAR WP_STARTCMD_COLD;*WP_STARTCMD -parm"StartMode=Cold"
  
  VAR WP_STARTCMD_STOP;*WP_STARTCMD -parm"SystemStop=Yes"
  
  VAR WP_STARTCMD_COLDSTOP;*WP_STARTCMD -parm"StartMode=Cold;SystemStop=Yes"
  
  DEFINE UC4 WP2;*WP_STARTCMD;*SRV_STARTPATH;START1=(Coldstart,*WP_STARTCMD_COLD);START2=(Systemstop,*WP_STARTCMD_STOP);START3=(Coldstart with Systemstop,*WP_STARTCMD_COLDSTOP)
  
  Valeurs autorisées :
  "Coldstart" : mode de démarrage à froid
  "Systemstop" : démarrage normal. Le système est interrompu à cet effet.
  "Coldstart with Systemstop" : démarrage à froid incluant un arrêt du système.

Quand vous appelez le programme de ligne de commande à l'aide de paramètres incorrects ou incomplets, un court texte d'aide affiche les paramètres corrects et les codes retour.

Output

Lorsque le programme de ligne de commande est appelé avec l'instruction GET_PROCESS_LIST, les informations demandées sont affichées ligne par ligne. Elle correspond à la vue dans le programme de dialogue du ServiceManager.

Format de sortie

"Service" "Statut" ["ID process" "Heure de début" "durée d'exécution" "Temps CPU"]

Service : Nom du service.
Statut : Statut du service.
- R = Running
- S = Stopped
ProcID Numéro de traitement du service.

N'affiche que les informations relatives aux services actifs (statut = R).
Heure de début : Date et heure de début du service.

Format : "AAAA-MM-JJ HH:MM"

N'affiche que les informations relatives aux services actifs (statut = R).
Durée d'exécution : Durée d'exécution du service.

Format : "DD/HH:MM"

N'affiche que les informations relatives aux services actifs (statut = R).
Temps CPU : Temps CPU requis par un service.

Format : "JJ/HH:MM:SS:CS" (CS=centièmes de secondes).

N'affiche que les informations relatives aux services actifs (statut = R).

Codes retour

0 Une commande a été exécutée sans erreur.
1 Une commande incorrecte a été saisie.
2 Aucun ServiceManager actif n'a été trouvé sur l'ordinateur spécifié.

Raison possible : Le nom de l'ordinateur n'a pas été saisi ou il n'y a pas de ServiceManager actif sur cet ordinateur.
3 ServiceManager a réagi de façon inattendue à une commande.

Raison possible : La version de ServiceManager n'est pas à jour.
4 Des erreurs sont survenues lors de la connexion au ServiceManager.
5 L'environnement spécifié de ServiceManager n'existe pas sur l'ordinateur correspondant.

Raison possible : Le ServiceManager pour l'environnement spécifié n'est pas installé ou n'est pas démarré.

Exemples

Le premier exemple récupère tous les services appartenant à l'ordinateur "WINW2K01" et à l'environnement du ServiceManager "UC4P".

UCYBSMCL.EXE -c GET_PROCESS_LIST -h WINW2K01 -n UC4P

Affichage :

"UC4 CP1" "R" "1588" "2004-04-05 21:39" "0/01:11" "0/00:00:22.69"
"UC4 WP1" "R" "3388" "2004-04-05 21:39" "0/01:11" "0/00:00:22.69"
"UC4 WP2" "R" "1576" "2004-04-05 21:39" "0/01:11" "0/00:00:22.69"
"Win32-Agent WIN01" "R" "2708" "2004-04-05 21:40" "0/01:11" "0/00:00:01.31"
"Win32-Agent WIN21" "R" "2392" "2004-04-05 21:40" "0/01:10" "0/00:00:01.30"
"Win32-Agent UC4MAIL" "R" "2932" "2004-04-05 21:40" "0/01:10" "0/00:00:01.31"
"SAP Agent C46" "S"
"PeopleSoft-Agent PS01" "S"

Le second exemple arrêt un agent UNIX normalement.

./ucybsmcl -c STOP_PROCESS -h unixw2k01:8871 -n uc4p -s unix01 -m Close

Voir aussi :