Commande viocli federation

La commande viocli federation permet d'exécuter diverses actions sur les métadonnées du fournisseur d'identité, les fournisseurs de services Keystone et les fournisseurs d'identité Keystone. Les paramètres suivants s'appliquent à toutes les actions sur l'ensemble des composants.

Paramètre	Obligatoire ou facultatif	Description
-d `NAME` ou --deployment `NAME`	Facultatif	Nom du déploiement à utiliser. Si vous n'entrez pas de valeur, le déploiement par défaut est utilisé.
-p ou --progress	Facultatif	Affiche la progression de l'opération en cours.
--verbose	Facultatif	Affiche le résultat en mode détaillé.

Paramètre

Obligatoire ou facultatif

Description

-d NAME ou --deployment NAME

Facultatif

Nom du déploiement à utiliser.

Si vous n'entrez pas de valeur, le déploiement par défaut est utilisé.

-p ou --progress

Facultatif

Affiche la progression de l'opération en cours.

--verbose

Facultatif

Affiche le résultat en mode détaillé.

Vous pouvez exécuter viocli federation -h ou viocli federation --help pour afficher les paramètres de la commande. Vous pouvez également utiliser l'option -h ou --help sur les composants ou les actions pour afficher les paramètres correspondants. Par exemple, viocli federation idp-metadata -h affichera les paramètres pour le composant idp-metadata et viocli federation idp-metadata set -h affichera les paramètres pour l'action set sur ce composant.

Métadonnées du fournisseur d'identité

Les actions prises en charge par viocli federation pour les métadonnées du fournisseur d'identité sont répertoriées comme suit.

`viocli federation idp-metadata clear [-d NAME] [-p] [--verbose]`

Supprime les métadonnées du fournisseur d'identité.

`viocli federation idp-metadata set [-d NAME] [-p] [--verbose]`

Définit les métadonnées du fournisseur d'identité mises à jour. Vous êtes invité à entrer des informations pour l'organisation et la personne à contacter.

`viocli federation idp-metadata show [-d NAME] [--json JSON | --pretty PRETTY] [-p] [--verbose]`

Affiche les métadonnées du fournisseur d'identité. Les paramètres supplémentaires suivants s'appliquent à l'action show.

Paramètre	Obligatoire ou facultatif	Description
--json JSON --pretty PRETTY	Facultatif	Affiche une sortie au format JSON ou en tant que texte formaté. Si vous n'entrez pas une valeur, `PRETTY` est utilisé lorsque la commande est exécutée de manière interactive et `JSON` est utilisée lorsque la commande est exécutée de manière non interactive.

Paramètre

Obligatoire ou facultatif

Description

--json JSON

--pretty PRETTY

Facultatif

Affiche une sortie au format JSON ou en tant que texte formaté.

Si vous n'entrez pas une valeur, PRETTY est utilisé lorsque la commande est exécutée de manière interactive et JSON est utilisée lorsque la commande est exécutée de manière non interactive.

Note:

Après la mise à jour ou la suppression des métadonnées, vous devez exécuter la commande viocli identity configure pour que vos modifications prennent effet.

Fournisseurs de services Keystone

Les actions prises en charge par viocli federation pour les fournisseurs de services Keystone sont répertoriées comme suit.

`viocli federation service-provider add [-d NAME] [--type SP-TYPE] [-p] [--verbose]`

Ajoute un fournisseur de services. Vous êtes invité à entrer des informations Keystone. Les paramètres supplémentaires suivants s'appliquent à l'action add.

Paramètre	Obligatoire ou facultatif	Description
--type `SP-TYPE`	Facultatif	Spécifie le type de fournisseur de services à ajouter.

`viocli federation service-provider remove [-d NAME] --id SP-ID [-p] [--verbose]`

Supprime un fournisseur de services. Les paramètres supplémentaires suivants s'appliquent à l'action remove.

Paramètre	Obligatoire ou facultatif	Description
--id `SP-ID`	Obligatoire	Identifiant du fournisseur de services à supprimer. Vous pouvez exécuter la commande viocli federation service-provider list pour afficher l'identifiant de chaque fournisseur de services.

Paramètre

Obligatoire ou facultatif

Description

--id SP-ID

Obligatoire

Identifiant du fournisseur de services à supprimer.

Vous pouvez exécuter la commande viocli federation service-provider list pour afficher l'identifiant de chaque fournisseur de services.

`viocli federation service-provider edit [-d NAME] --id SP-ID [-p] [--verbose]`

Modifie la configuration d'un fournisseur de services. Les paramètres supplémentaires suivants s'appliquent à l'action edit.

Paramètre	Obligatoire ou facultatif	Description
--id `SP-ID`	Obligatoire	Identifiant du fournisseur de services à modifier. Vous pouvez exécuter la commande viocli federation service-provider list pour afficher l'identifiant de chaque fournisseur de services.

Paramètre

Obligatoire ou facultatif

Description

--id SP-ID

Obligatoire

Identifiant du fournisseur de services à modifier.

Vous pouvez exécuter la commande viocli federation service-provider list pour afficher l'identifiant de chaque fournisseur de services.

`viocli federation service-provider list [-d NAME] [--json JSON | --pretty PRETTY] [-p] [--verbose]`

Affiche des informations sur tous les fournisseurs de services. Les paramètres supplémentaires suivants s'appliquent à l'action list.

Paramètre	Obligatoire ou facultatif	Description
--json JSON --pretty PRETTY	Facultatif	Affiche une sortie au format JSON ou en tant que texte formaté. Si vous n'entrez pas une valeur, `PRETTY` est utilisé lorsque la commande est exécutée de manière interactive et `JSON` est utilisée lorsque la commande est exécutée de manière non interactive.

Paramètre

Obligatoire ou facultatif

Description

--json JSON

--pretty PRETTY

Facultatif

Affiche une sortie au format JSON ou en tant que texte formaté.

Si vous n'entrez pas une valeur, PRETTY est utilisé lorsque la commande est exécutée de manière interactive et JSON est utilisée lorsque la commande est exécutée de manière non interactive.

`viocli federation service-provider show [-d NAME] --id SP-ID [--json JSON | --pretty PRETTY] [-p] [--verbose]`

Affiche des informations détaillées sur un fournisseur de services. Les paramètres supplémentaires suivants s'appliquent à l'action show.

Paramètre	Obligatoire ou facultatif	Description
--id `SP-ID`	Obligatoire	Identifiant du fournisseur de services.
--json JSON --pretty PRETTY	Facultatif	Affiche une sortie au format JSON ou en tant que texte formaté. Si vous n'entrez pas une valeur, `PRETTY` est utilisé lorsque la commande est exécutée de manière interactive et `JSON` est utilisée lorsque la commande est exécutée de manière non interactive.

Paramètre

Obligatoire ou facultatif

Description

--id SP-ID

Obligatoire

Identifiant du fournisseur de services.

--json JSON

--pretty PRETTY

Facultatif

Affiche une sortie au format JSON ou en tant que texte formaté.

Si vous n'entrez pas une valeur, PRETTY est utilisé lorsque la commande est exécutée de manière interactive et JSON est utilisée lorsque la commande est exécutée de manière non interactive.

Fournisseurs d'identité Keystone

Les actions prises en charge par viocli federation pour les fournisseurs d'identité Keystone sont répertoriées comme suit.

`viocli federation identity-provider add [-d NAME] [--type {keystone | saml2 | vidm}] [-p] [--verbose]`

Ajoute un fournisseur de services. Vous êtes invité à entrer des informations Keystone. Les paramètres supplémentaires suivants s'appliquent à l'action add.

Paramètre	Obligatoire ou facultatif	Description
--type {keystone \| saml2 \| vidm}	Facultatif	Spécifie le type de fournisseur d'identité à ajouter. Si vous n'ajoutez pas cette option dans la commande, vous serez invité à entrer une valeur.

Paramètre

Obligatoire ou facultatif

Description

--type {keystone | saml2 | vidm}

Facultatif

Spécifie le type de fournisseur d'identité à ajouter.

Si vous n'ajoutez pas cette option dans la commande, vous serez invité à entrer une valeur.

`viocli federation identity-provider remove [-d NAME] --id IDP-ID [-p] [--verbose]`

Supprime un fournisseur d'identité. Les paramètres supplémentaires suivants s'appliquent à l'action remove.

Paramètre	Obligatoire ou facultatif	Description
--id `IDP-ID`	Obligatoire	Identifiant du fournisseur d'identité à supprimer. Vous pouvez exécuter la commande viocli federation identity-provider list pour afficher l'identifiant de chaque fournisseur d'identité.

Paramètre

Obligatoire ou facultatif

Description

--id IDP-ID

Obligatoire

Identifiant du fournisseur d'identité à supprimer.

Vous pouvez exécuter la commande viocli federation identity-provider list pour afficher l'identifiant de chaque fournisseur d'identité.

`viocli federation identity-provider edit [-d NAME] --id IDP-ID [-p] [--verbose]`

Modifie la configuration d'un fournisseur d'identité. Les paramètres supplémentaires suivants s'appliquent à l'action edit.

Paramètre	Obligatoire ou facultatif	Description
--id `IDP-ID`	Obligatoire	Identifiant du fournisseur d'identité à modifier. Vous pouvez exécuter la commande viocli federation identity-provider list pour afficher l'identifiant de chaque fournisseur d'identité.

Paramètre

Obligatoire ou facultatif

Description

--id IDP-ID

Obligatoire

Identifiant du fournisseur d'identité à modifier.

Vous pouvez exécuter la commande viocli federation identity-provider list pour afficher l'identifiant de chaque fournisseur d'identité.

`viocli federation identity-provider list [-d NAME] [--json JSON | --pretty PRETTY] [-p] [--verbose]`

Affiche des informations sur tous les fournisseurs d'identité. Les paramètres supplémentaires suivants s'appliquent à l'action list.

Paramètre	Obligatoire ou facultatif	Description
--json JSON --pretty PRETTY	Facultatif	Affiche une sortie au format JSON ou en tant que texte formaté. Si vous n'entrez pas une valeur, `PRETTY` est utilisé lorsque la commande est exécutée de manière interactive et `JSON` est utilisée lorsque la commande est exécutée de manière non interactive.

Paramètre

Obligatoire ou facultatif

Description

--json JSON

--pretty PRETTY

Facultatif

Affiche une sortie au format JSON ou en tant que texte formaté.

Si vous n'entrez pas une valeur, PRETTY est utilisé lorsque la commande est exécutée de manière interactive et JSON est utilisée lorsque la commande est exécutée de manière non interactive.

`viocli federation identity-provider show [-d NAME] --id IDP-ID [--json JSON | --pretty PRETTY] [-p] [--verbose]`

Affiche des informations détaillées sur un fournisseur d'identité. Les paramètres supplémentaires suivants s'appliquent à l'action show.

Paramètre	Obligatoire ou facultatif	Description
--id `IDP-ID`	Obligatoire	Identifiant du fournisseur d'identité.
--json JSON --pretty PRETTY	Facultatif	Affiche une sortie au format JSON ou en tant que texte formaté. Si vous n'entrez pas une valeur, `PRETTY` est utilisé lorsque la commande est exécutée de manière interactive et `JSON` est utilisée lorsque la commande est exécutée de manière non interactive.

Paramètre

Obligatoire ou facultatif

Description

--id IDP-ID

Obligatoire

Identifiant du fournisseur d'identité.

--json JSON

--pretty PRETTY

Facultatif

Affiche une sortie au format JSON ou en tant que texte formaté.

Si vous n'entrez pas une valeur, PRETTY est utilisé lorsque la commande est exécutée de manière interactive et JSON est utilisée lorsque la commande est exécutée de manière non interactive.