Démarrer avec ssoadm

ssoadm s’utilise sous la forme ssoadm <commande> [options]. Chaque commande d’administration demande un compte administrateur, passé par deux options : --adminid (-u) et --password-file (-f).

Où trouver ssoadm#

Distribution QuickStart. Le script bin/ssoadm.sh (Linux) ou bin\ssoadm.bat (Windows) appelle l’outil installé dans tools/admin/tosiam/bin/, en ajoutant le compte amadmin et son fichier de mot de passe :

bash

# Ce que fait bin/ssoadm.sh
$TOSIAM_HOME/tools/admin/tosiam/bin/ssoadm "$@" -u amadmin -f $TOSIAM_HOME/tools/admin/.pwd.txt

Il suffit donc d’écrire la commande et ses options, par exemple ./ssoadm.sh list-realms --realm /. Voir Quickstart.

Projet Maven. Le goal ssoadm de tosiam-project-generator-maven-plugin transmet ses arguments à l’outil (-Dssoadm.args="…"). Voir Générer un projet avec Maven.

S’authentifier#

Faites défiler le tableau

Option	Court	Rôle
`--adminid`	`-u`	Identifiant de l’administrateur, en général `amadmin`
`--password-file`	`-f`	Fichier contenant son mot de passe

Seule la première ligne du fichier de mot de passe est lue. Sous Linux et macOS, ssoadm refuse un fichier lisible par d’autres que son propriétaire : il doit avoir les droits 400 (-r--------).

bash

echo 'mot-de-passe' > ~/.tosiam-pwd
chmod 400 ~/.tosiam-pwd
ssoadm list-realms --realm / -u amadmin -f ~/.tosiam-pwd

Lire l’aide#

ssoadm --help liste les commandes, ssoadm <commande> --help détaille les options d’une commande. La référence des commandes reprend ces informations, rangées par famille.

L’aide est affichée dans la langue du système, ou celle passée par --locale fr. La traduction française de l’outil emploie « domaine » pour désigner un royaume (realm).

Options globales#

Faites défiler le tableau

Option	Court	Rôle
`--help`	`-?`	Aide générale ou d’une commande
`--version`	`-V`	Version de l’outil
`--information`	`-O`	Informations sur l’outil
`--verbose`	`-v`	Sortie détaillée
`--debug`	`-d`	Messages de débogage
`--locale`	`-l`	Langue des messages, par exemple `fr`
`--nolog`	`-O`	Désactive la journalisation de la commande

-O est déclaré pour deux options : préférez les formes longues --information et --nolog.

Types d’options#

Dans la référence, la colonne « Valeur » indique comment renseigner une option :

valeur : une seule valeur, --realm /clients ;
valeurs multiples : plusieurs valeurs séparées par des espaces, --attributevalues "mail=a@example.com" "sn=Martin" ;
drapeau : option sans valeur, --continue.

Beaucoup de commandes acceptent aussi --datafile (-D), un fichier qui contient les valeurs à la place de la ligne de commande : une valeur attribut=valeur par ligne.

Codes de retour#

ssoadm renvoie 0 en cas de succès. Les erreurs les plus fréquentes dans un script :

Faites défiler le tableau

Code	Signification
`10`	Syntaxe de la commande incorrecte
`11`	Option incorrecte
`12`	Commande inconnue
`18`	Fichier illisible (fichier de mot de passe, `--datafile`)
`20`	Échec de l’authentification de l’administrateur
`23`	Valeur d’option invalide
`127`	La requête n’a pas pu être traitée (erreur côté serveur, objet déjà existant…)