Befehl „viocli federation“

Mit dem Befehl viocli federation können verschiedene Aktionen mit den Identitätsanbieter-Metadaten (IdP), Keystone-Dienstanbietern und Keystone-Identitätsanbietern durchgeführt werden. Die folgenden Parameter gelten für alle Aktionen bei allen Komponenten.

Parameter	Obligatorisch oder Optional	Beschreibung
-d `NAME` oder --deployment `NAME`	Optional	Name der zu verwendenden Bereitstellung. Wenn Sie keinen Wert eingeben, wird die Standardbereitstellung verwendet.
-p oder --progress	Optional	Zeigt den Fortschritt des aktuellen Vorgangs an.
--verbose	Optional	Zeigt die Ausgabe im ausführlichen Modus an.

Parameter

Obligatorisch oder Optional

Beschreibung

-d NAME oder --deployment NAME

Optional

Name der zu verwendenden Bereitstellung.

Wenn Sie keinen Wert eingeben, wird die Standardbereitstellung verwendet.

-p oder --progress

Optional

Zeigt den Fortschritt des aktuellen Vorgangs an.

--verbose

Optional

Zeigt die Ausgabe im ausführlichen Modus an.

Sie können viocli federation -h oder viocli federation --help zur Anzeige der Parameter für den Befehl ausführen. Sie können auch die Option -h oder --help auf eine beliebige Komponente oder Aktion anwenden, um die relevanten Parameter anzuzeigen. Beispielsweise werden mit viocli federation idp-metadata -h Parameter für die Komponente idp-metadata und mit viocli federation idp-metadata set -h Parameter für die Aktion set bei der Komponente angezeigt.

Identitätsanbieter-Metadaten

Die Aktionen, die viocli federation für die Identitätsanbieter-Metadaten unterstützt, sind im Folgenden aufgeführt.

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

Entfernt die Identitätsanbieter-Metadaten.

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

Legt aktualisierte Identitätsanbieter-Metadaten fest. Sie werden aufgefordert, Informationen für die Organisation und Kontaktperson einzugeben.

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

Zeigt die Identitätsanbieter-Metadaten an. Die folgenden zusätzlichen Parameter gelten für die Aktion show.

Parameter	Obligatorisch oder Optional	Beschreibung
--json JSON --pretty PRETTY	Optional	Zeigt die Ausgabe im JSON-Format oder als formatierten Text an. Wenn Sie keinen Wert eingeben, wird `PRETTY` verwendet, wenn der Befehl interaktiv ausgeführt wird, und `JSON`, wenn der Befehl nicht interaktiv ausgeführt wird.

Parameter

Obligatorisch oder Optional

Beschreibung

--json JSON

--pretty PRETTY

Optional

Zeigt die Ausgabe im JSON-Format oder als formatierten Text an.

Wenn Sie keinen Wert eingeben, wird PRETTY verwendet, wenn der Befehl interaktiv ausgeführt wird, und JSON, wenn der Befehl nicht interaktiv ausgeführt wird.

Hinweis:

Nach dem Aktualisieren bzw. Entfernen von Metadaten müssen Sie den Befehl viocli identity configure ausführen, um Ihre Änderungen anzuwenden.

Keystone-Dienstanbieter

Die Aktionen, die viocli federation für die Keystone-Dienstanbieter unterstützt, sind im Folgenden aufgeführt.

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

Fügt einen Dienstanbieter hinzu. Sie werden aufgefordert, Keystone-Informationen einzugeben. Die folgenden zusätzlichen Parameter gelten für die Aktion add.

Parameter	Obligatorisch oder Optional	Beschreibung
--type `SP-TYPE`	Optional	Gibt den Typ des hinzuzufügenden Dienstanbieters an.

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

Entfernt einen Dienstanbieter. Die folgenden zusätzlichen Parameter gelten für die Aktion remove.

Parameter	Obligatorisch oder Optional	Beschreibung
--id `SP-ID`	Obligatorisch	Bezeichner des zu entfernenden Dienstanbieters. Sie können den Befehl viocli federation service-provider list zum Anzeigen der Bezeichner jedes Dienstanbieters ausführen.

Parameter

Obligatorisch oder Optional

Beschreibung

--id SP-ID

Obligatorisch

Bezeichner des zu entfernenden Dienstanbieters.

Sie können den Befehl viocli federation service-provider list zum Anzeigen der Bezeichner jedes Dienstanbieters ausführen.

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

Ändert die Konfiguration eines Dienstanbieters. Die folgenden zusätzlichen Parameter gelten für die Aktion edit.

Parameter	Obligatorisch oder Optional	Beschreibung
--id `SP-ID`	Obligatorisch	Bezeichner des zu ändernden Dienstanbieters. Sie können den Befehl viocli federation service-provider list zum Anzeigen der Bezeichner jedes Dienstanbieters ausführen.

Parameter

Obligatorisch oder Optional

Beschreibung

--id SP-ID

Obligatorisch

Bezeichner des zu ändernden Dienstanbieters.

Sie können den Befehl viocli federation service-provider list zum Anzeigen der Bezeichner jedes Dienstanbieters ausführen.

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

Zeigt Informationen zu allen Dienstanbietern an. Die folgenden zusätzlichen Parameter gelten für die Aktion list.

Parameter	Obligatorisch oder Optional	Beschreibung
--json JSON --pretty PRETTY	Optional	Zeigt die Ausgabe im JSON-Format oder als formatierten Text an. Wenn Sie keinen Wert eingeben, wird `PRETTY` verwendet, wenn der Befehl interaktiv ausgeführt wird, und `JSON`, wenn der Befehl nicht interaktiv ausgeführt wird.

Parameter

Obligatorisch oder Optional

Beschreibung

--json JSON

--pretty PRETTY

Optional

Zeigt die Ausgabe im JSON-Format oder als formatierten Text an.

Wenn Sie keinen Wert eingeben, wird PRETTY verwendet, wenn der Befehl interaktiv ausgeführt wird, und JSON, wenn der Befehl nicht interaktiv ausgeführt wird.

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

Zeigt detaillierte Informationen zu einem Dienstanbieter an. Die folgenden zusätzlichen Parameter gelten für die Aktion show.

Parameter	Obligatorisch oder Optional	Beschreibung
--id `SP-ID`	Obligatorisch	Bezeichner des Dienstanbieters.
--json JSON --pretty PRETTY	Optional	Zeigt die Ausgabe im JSON-Format oder als formatierten Text an. Wenn Sie keinen Wert eingeben, wird `PRETTY` verwendet, wenn der Befehl interaktiv ausgeführt wird, und `JSON`, wenn der Befehl nicht interaktiv ausgeführt wird.

Parameter

Obligatorisch oder Optional

Beschreibung

--id SP-ID

Obligatorisch

Bezeichner des Dienstanbieters.

--json JSON

--pretty PRETTY

Optional

Zeigt die Ausgabe im JSON-Format oder als formatierten Text an.

Wenn Sie keinen Wert eingeben, wird PRETTY verwendet, wenn der Befehl interaktiv ausgeführt wird, und JSON, wenn der Befehl nicht interaktiv ausgeführt wird.

Keystone-Identitätsanbieter

Die Aktionen, die viocli federation für die Keystone-Identitätsanbieter unterstützt, sind im Folgenden aufgeführt.

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

Fügt einen Dienstanbieter hinzu. Sie werden aufgefordert, Keystone-Informationen einzugeben. Die folgenden zusätzlichen Parameter gelten für die Aktion add.

Parameter	Obligatorisch oder Optional	Beschreibung
--type {keystone \| saml2 \| vidm}	Optional	Gibt den Typ des hinzuzufügenden Identitätsanbieters an. Wenn Sie diese Option im Befehl nicht angeben, werden Sie aufgefordert, einen Wert einzugeben.

Parameter

Obligatorisch oder Optional

Beschreibung

--type {keystone | saml2 | vidm}

Optional

Gibt den Typ des hinzuzufügenden Identitätsanbieters an.

Wenn Sie diese Option im Befehl nicht angeben, werden Sie aufgefordert, einen Wert einzugeben.

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

Entfernt einen Identitätsanbieter. Die folgenden zusätzlichen Parameter gelten für die Aktion remove.

Parameter	Obligatorisch oder Optional	Beschreibung
--id `IDP-ID`	Obligatorisch	Bezeichner des zu entfernenden Identitätsanbieters. Sie können den Befehl viocli federation identity-provider list zum Anzeigen der Bezeichner jedes Identitätsanbieters ausführen.

Parameter

Obligatorisch oder Optional

Beschreibung

--id IDP-ID

Obligatorisch

Bezeichner des zu entfernenden Identitätsanbieters.

Sie können den Befehl viocli federation identity-provider list zum Anzeigen der Bezeichner jedes Identitätsanbieters ausführen.

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

Ändert die Konfiguration eines Identitätsanbieters. Die folgenden zusätzlichen Parameter gelten für die Aktion edit.

Parameter	Obligatorisch oder Optional	Beschreibung
--id `IDP-ID`	Obligatorisch	Bezeichner des zu ändernden Identitätsanbieters. Sie können den Befehl viocli federation identity-provider list zum Anzeigen der Bezeichner jedes Identitätsanbieters ausführen.

Parameter

Obligatorisch oder Optional

Beschreibung

--id IDP-ID

Obligatorisch

Bezeichner des zu ändernden Identitätsanbieters.

Sie können den Befehl viocli federation identity-provider list zum Anzeigen der Bezeichner jedes Identitätsanbieters ausführen.

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

Zeigt Informationen zu allen Identitätsanbietern an. Die folgenden zusätzlichen Parameter gelten für die Aktion list.

Parameter	Obligatorisch oder Optional	Beschreibung
--json JSON --pretty PRETTY	Optional	Zeigt die Ausgabe im JSON-Format oder als formatierten Text an. Wenn Sie keinen Wert eingeben, wird `PRETTY` verwendet, wenn der Befehl interaktiv ausgeführt wird, und `JSON`, wenn der Befehl nicht interaktiv ausgeführt wird.

Parameter

Obligatorisch oder Optional

Beschreibung

--json JSON

--pretty PRETTY

Optional

Zeigt die Ausgabe im JSON-Format oder als formatierten Text an.

Wenn Sie keinen Wert eingeben, wird PRETTY verwendet, wenn der Befehl interaktiv ausgeführt wird, und JSON, wenn der Befehl nicht interaktiv ausgeführt wird.

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

Zeigt detaillierte Informationen zu einem Identitätsanbieter an. Die folgenden zusätzlichen Parameter gelten für die Aktion show.

Parameter	Obligatorisch oder Optional	Beschreibung
--id `IDP-ID`	Obligatorisch	Bezeichner des Identitätsanbieters.
--json JSON --pretty PRETTY	Optional	Zeigt die Ausgabe im JSON-Format oder als formatierten Text an. Wenn Sie keinen Wert eingeben, wird `PRETTY` verwendet, wenn der Befehl interaktiv ausgeführt wird, und `JSON`, wenn der Befehl nicht interaktiv ausgeführt wird.

Parameter

Obligatorisch oder Optional

Beschreibung

--id IDP-ID

Obligatorisch

Bezeichner des Identitätsanbieters.

--json JSON

--pretty PRETTY

Optional

Zeigt die Ausgabe im JSON-Format oder als formatierten Text an.

Wenn Sie keinen Wert eingeben, wird PRETTY verwendet, wenn der Befehl interaktiv ausgeführt wird, und JSON, wenn der Befehl nicht interaktiv ausgeführt wird.