Paramètres de la CLI

La plupart des paramètres de la CLI sont des couples nom-valeur : chaque paramètre a un nom et une valeur. Certains, appelés indicateurs, ont un nom mais pas de valeurs.

Portée des paramètres

Vous pouvez spécifier les valeurs des paramètres à plusieurs stades dans une session CLI :

• Démarrage de la CLI – Vous pouvez spécifier des paramètres sur la ligne de commande lorsque vous démarrez la CLI. Les paramètres qui sont spécifiés au démarrage sont dits globaux dans le cadre de la session. Les paramètres globaux conservent leurs valeurs à moins qu'elles ne soient remplacées par la commande set ou supprimées de la session courante au moyen de la commande unset.

• Commandes de la CLI – Vous pouvez spécifier des paramètres pour les commandes de CLI individuelles exécutées pendant une session. Une valeur spécifiée en tant que partie d'une commande remplace temporairement la valeur d'un paramètre global pendant la durée de cette commande.

• Fichier d'entrée – Les définitions de paramètres peuvent être stockées dans un fichier externe et être appelées à tout moment au cours d'une session de CLI. Les valeurs de paramètres qui sont définies dans un fichier externe sont remplacées par les paramètres globaux et par les paramètres de commandes individuelles.

Syntaxe des paramètres

Les paramètres sont spécifiés sous la forme de couples nom=valeur :

file=/home/examples/example1

Où le nom du paramètre est file et sa valeur /home/examples/example1. Il ne doit pas y avoir d'espaces blancs entre le signe égal (=) et le nom du paramètre ou sa valeur. Si la valeur contient des blancs, par exemple un caractère d'espacement ou de tabulation, elle doit être mise entre guillemets doubles anglo-saxons (caractère ASCII 0x22) :

moduleDesc="Balayage des fichiers"

Les valeurs des paramètres peuvent prendre la forme d'une liste de valeurs séparées par des virgules. Il ne doit pas y avoir de blancs entre les valeurs séparées par des virgules, comme indiqué dans l'exemple ci-après.

severity=DIS,DWN,ERR

Une liste des paramètres est une séquence de paramètres séparés par des blancs, comme indiqué dans l'exemple suivant :

m=kernel-reader moduleDesc="Mon Lecteur de noyau"

Exemples de syntaxe acceptables et inacceptables pour les paramètres

La syntaxe des paramètres suivants est acceptable :

ok1="Ceci est un simple test"
ok2=salut
ok3=salut,ciao,hola
ok4="salut,ciao,hola"

La syntaxe des paramètres suivants est inacceptable :

broken1="Comment ça va ?","Qui êtes-vous ?"
broken2="Test",1,2,3
broken3="Salut
broken4=Salut"

Format des fichiers d'entrée de paramètres

Les paramètres peuvent être stockés dans un fichier et lus au moment voulu. Vous pouvez créer autant de fichiers de paramètres que nécessaire. Utilisez le paramètre intégré i pour spécifier le nom du fichier d'entrée de paramètres désiré.

Paramètres et indicateurs prédéfinis

Cette section décrit les paramètres dont la signification est prédéfinie dans la CLI.

Plusieurs paramètres prédéfinis ont des noms composés d'une seule lettre. Par exemple, a, f et o.

-b

Lorsqu'il est inclus sur la ligne de commande au démarrage de la CLI, cette indicateur indique à la CLI de s'exécuter en mode différé. Il est ignoré en mode session.

-h

Si cet indicateur est utilisé en tant que paramètre d'une commande en mode session, il indique à la CLI d'afficher le texte d'aide de cette commande.

-l

Quand cet indicateur est utilisé en tant que paramètre d'une commande étendue en mode session, il indique à la CLI de conserver les paramètres de la dernière commande étendue pendant l'exécution de la commande courante. Si l'indicateur -l est spécifié, tous les paramètres supplémentaires spécifiés pour la commande courante sont ignorés. Cet indicateur n'a aucun effet sur les commandes de base. L'exemple suivant illustre l'utilisation de l'indicateur - l :

> getLoadModules a=monNomHôte ... ... > getAlarms -l

Quand la commande getAlarms s'exécute, elle utilise la valeur du paramètre a (monNomHôte) de la commande getLoadModules exécutée au préalable.

a

La valeur du paramètre a est un agent, qui est spécifié sous la forme de l'hôte de l'agent et du numéro de port (facultatif). Si vous spécifiez le numéro de port, séparez le numéro du nom de l'hôte par le signe deux-points (:). La syntaxe générale est a=hôteAgent[:portAgent]. Par exemple, pour spécifier un agent qui s'exécute sur l'hôte hôte_exemple et écoute le port 12345, vous devez utiliser la syntaxe suivante :

a=hôte_exemple:12345

La valeur du paramètre a peut également être une liste de spécifications d'agents séparées par des virgules : a=agent[,agent]*.

about

Le paramètre about est utilisé avec la commande help. Ce paramètre affiche les informations de version pour la CLI.

append

La valeur du paramètre append correspond au nom d'un fichier auquel la sortie de la commande doit être ajoutée. Si ce fichier n'existe pas, il est créé. Si vous définissez le paramètre append globalement, l'ensemble des sorties des commandes de cette session seront ajoutées au fichier spécifié. Vous pouvez aussi définir ce paramètre pour une commande spécifique, comme indiqué dans l'exemple suivant.

append=/home/examples/cli_output

Si les deux paramètres append et o sont définis, append l'emporte sur o. Seuls les résultats de la commande sont enregistrés dans le fichier spécifié. La commande proprement dite n'est pas enregistrée. Utilisez le paramètre log pour enregistrer des informations sur la commande.

columns

La valeur du paramètre columns correspond au nom d'une ou plusieurs colonnes de la sortie de la commande devant être affichées par la commande print. Les noms de colonnes font la différences entre les majuscules et les minuscules. S'il y a plusieurs noms de commande, ceux-ci sont séparés par des virgules. L'exemple suivant utilise plusieurs noms de colonnes.

columns="ID alarme,URL noeud,Hôte cible,Gravité"

f

La valeur du paramètre f détermine le format de la sortie de la commande. Les formats courants sont plain et html. Pour plus d'informations, reportez-vous à Format de la sortie des commandes. Pour mettre le format sur HTML, utilisez la syntaxe suivante :

f=html

height

La valeur du paramètre height correspond au nombre de lignes de la sortie de la commande qui s'affichent à l'écran. L'exemple suivant fixe la hauteur à approximativement la hauteur d'un écran de terminal standard :

height=24

history

La valeur du paramètre history correspond au nombre de commandes qui seront enregistrées dans l'historique des commandes. L'historique des commandes vous permet de visualiser toutes les commandes précédemment exécutées. Ce paramètre est utilisé par la commande set.

history=10

i

La valeur du paramètre i est le nom d'un fichier d'entrée qui contient les définitions de paramètres à inclure dans la session courante. Dans ce fichier d'entrée, chaque définition de paramètre doit figurer sur une ligne séparée. Par exemple, supposez que les lignes suivantes figurent dans un fichier /home/examples/myParams :

more=off serverHost=monserveur a=myagent:161

Vous pourriez inclure ces paramètres dans la session de CLI courante en utilisant la ligne suivante :

i=/home/examples/mesParams

log

La valeur du paramètre log correspond au nom d'un fichier qui enregistre toutes les commandes de la CLI et l'heure à laquelle elles sont exécutées. Vous remarquerez que le fichier journal n'enregistre que les noms des commandes et l'heure de leur exécution. La sortie des commandes est enregistrée dans les fichiers spécifiés par le paramètre a ou o. Une fois ce paramètre défini, toutes les commandes ultérieures sont ajoutées à ce fichier. Si ce fichier n'existe pas, il est créé. Ce fichier n'étant pas écrasé lors de l'activation de la fonction de consignation des commandes, veillez à spécifier un nouveau fichier si vous voulez un nouveau journal. Pour désactiver la consignation des commandes, utilisez la commande unset avec le paramètre log. L'exemple ci-après démarre un journal, puis l'arrête.

> log=/home/examples/sunmc-log ... ... > unset log

logmode

La valeur du paramètre logmode peut être detailed, command ou from n. La valeur detailed enregistre les informations détaillées relatives aux commandes dans le fichier journal des commandes. La valeur command enregistre uniquement les commandes et les paramètres associés dans le fichier journal des commandes. La valeur from n ajoute toutes les entrées (depuis l'entrée n) de l'historique des commandes au fichier journal des commandes. La valeur par défaut du paramètre logmode est detailed.

m

La valeur du paramètre m correspond au nom d'un module de Sun Management Center. Cette valeur peut aussi prendre la forme d'une liste de modules séparés par des virgules.

m=kernel-reader

more

La valeur du paramètre more contrôle la pagination de la sortie de la commande sur votre écran. Les valeurs possibles sont on et off. Si more est réglé sur on, toute sortie ultérieure sur le terminal s'affichera écran par écran. La taille d'un écran est définie par les paramètres de hauteur et de largeur. Les valeurs par défaut sont off pour le mode différé et on pour le mode session.

more=on

ncols

La valeur du paramètre ncols correspond au nombre maximum de colonnes de la sortie de la commande devant être affichées par la commande print.

o

La valeur du paramètre o est le nom du fichier dans lequel la sortie de la commande doit être écrite. Si ce fichier existe, il est remplacé. Vous pouvez utiliser le paramètre o pour capturer la sortie d'une commande particulière en spécifiant le paramètre o pour cette commande. Vous pouvez aussi définir ce paramètre globalement en utilisant la commande set pour écrire toutes les sorties ultérieures dans un fichier.

Si les deux paramètres append et o sont définis, append l'emporte sur o. La sortie est ajoutée au fichier spécifié. Seule la sortie de la commande est écrite dans le fichier. La commande proprement dite n'est pas enregistrée. Utilisez le paramètre log pour enregistrer les informations sur la commande. L'exemple suivant définit un fichier dans lequel la sortie de la commande est écrite.

o=/home/examples/sunmc-output

prompt

La valeur du paramètre prompt est utilisé pour définir une invite de CLI différente.

serverPort

La valeur du paramètre serverPort correspond au port du serveur utilisé pour la connexion. Il s'agit d'un paramètre global qui ne peut plus être défini après qu'une session a été connectée. Si ce paramètre n'est pas défini, le port par défaut, 2099, est utilisé.

style

La valeur du paramètre style détermine le style de la sortie de la commande. Les valeur autorisées pour ce paramètres sont table, list et <custom>. La valeur table affiche la sortie de la commande sous une forme tabulaire. La valeur list affiche la sortie de la commande sous forme de liste composée de colonnes, séparées par des virgules. La valeur <custom> permet de s'assurer que la sortie de la commande s'affiche suivant un format défini par l'utilisateur. Chaque colonne est représentée par %a. La valeur custom peut contenir des caractères spéciaux, tels que :, \t et \n.

t

La valeur du paramètre t correspond au nom d'un objet qui géré via l'agent de la topologie. Cet objet peut être un domaine, un groupe de vues ou une entité. Le nom de l'objet est son nom complet à partir du domaine, par exemple, /domaine/groupe/hôte.