viocli federation コマンド

viocli federation コマンドを使用すると、ID プロバイダ (IdP) メタデータ、Keystone サービスプロバイダ、および Keystone ID プロバイダに対してさまざまなアクションを実行できます。以下のパラメータは、すべてのコンポーネントのすべてのアクションに適用されます。

パラメータ	必須か任意か	説明
-d `NAME` または --deployment `NAME`	任意	使用するデプロイの名前。値を入力しない場合、デフォルトのデプロイが使用されます。
-p または --progress	任意	実行中の処理の進行状況を表示します。
--verbose	任意	詳細モードで出力を表示します。

パラメータ

必須か任意か

説明

-d NAME または --deployment NAME

任意

使用するデプロイの名前。

値を入力しない場合、デフォルトのデプロイが使用されます。

-p または --progress

任意

実行中の処理の進行状況を表示します。

--verbose

任意

詳細モードで出力を表示します。

viocli federation -h または viocli federation --help を実行して、コマンドのパラメータを表示できます。-h または --help オプションを任意のコンポーネントまたはアクションに対して使用して、関連するパラメータを表示することもできます。たとえば、viocli federation idp-metadata -h を実行すると idp-metadata コンポーネントのパラメータが表示され、viocli federation idp-metadata set -h を実行するとこのコンポーネントに対する set アクションのパラメータが表示されます。

ID プロバイダメタデータ

ID プロバイダメタデータに対して viocli federation がサポートするアクションは以下のとおりです。

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

ID プロバイダメタデータを削除します。

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

更新された ID プロバイダメタデータを設定します。組織および連絡先担当者の情報を入力するように求められます。

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

ID プロバイダメタデータを表示します。show アクションには、以下の追加のパラメータが適用されます。

パラメータ	必須か任意か	説明
--json JSON --pretty PRETTY	任意	出力を JSON 形式またはフォーマット済みテキストで表示します。値を入力しない場合、コマンドを対話形式で実行したときは `PRETTY` が、コマンドを非対話形式で実行したときは `JSON` が使用されます。

パラメータ

必須か任意か

説明

--json JSON

--pretty PRETTY

任意

出力を JSON 形式またはフォーマット済みテキストで表示します。

値を入力しない場合、コマンドを対話形式で実行したときは PRETTY が、コマンドを非対話形式で実行したときは JSON が使用されます。

注：

メタデータを更新または削除した後、viocli identity configure コマンドを実行して、変更内容が反映されていることを確認してください。

Keystone サービスプロバイダ

Keystone サービスプロバイダに対して viocli federation がサポートするアクションは以下のとおりです。

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

サービスプロバイダを追加します。Keystone 情報を入力するように求められます。add アクションには、以下の追加のパラメータが適用されます。

パラメータ	必須か任意か	説明
--type `SP-TYPE`	任意	追加するサービスプロバイダのタイプを指定します。

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

サービスプロバイダを削除します。remove アクションには、以下の追加のパラメータが適用されます。

パラメータ	必須か任意か	説明
--id `SP-ID`	必須	削除するサービスプロバイダの ID。 viocli federation service-provider list コマンドを実行して、各サービスプロバイダの ID を表示できます。

パラメータ

必須か任意か

説明

--id SP-ID

必須

削除するサービスプロバイダの ID。

viocli federation service-provider list コマンドを実行して、各サービスプロバイダの ID を表示できます。

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

サービスプロバイダの構成を変更します。edit アクションには、以下の追加のパラメータが適用されます。

パラメータ	必須か任意か	説明
--id `SP-ID`	必須	変更するサービスプロバイダの ID。 viocli federation service-provider list コマンドを実行して、各サービスプロバイダの ID を表示できます。

パラメータ

必須か任意か

説明

--id SP-ID

必須

変更するサービスプロバイダの ID。

viocli federation service-provider list コマンドを実行して、各サービスプロバイダの ID を表示できます。

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

すべてのサービスプロバイダについての情報を表示します。list アクションには、以下の追加のパラメータが適用されます。

パラメータ	必須か任意か	説明
--json JSON --pretty PRETTY	任意	出力を JSON 形式またはフォーマット済みテキストで表示します。値を入力しない場合、コマンドを対話形式で実行したときは `PRETTY` が、コマンドを非対話形式で実行したときは `JSON` が使用されます。

パラメータ

必須か任意か

説明

--json JSON

--pretty PRETTY

任意

出力を JSON 形式またはフォーマット済みテキストで表示します。

値を入力しない場合、コマンドを対話形式で実行したときは PRETTY が、コマンドを非対話形式で実行したときは JSON が使用されます。

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

サービスプロバイダについての詳細情報を表示します。show アクションには、以下の追加のパラメータが適用されます。

パラメータ	必須か任意か	説明
--id `SP-ID`	必須	サービスプロバイダの ID。
--json JSON --pretty PRETTY	任意	出力を JSON 形式またはフォーマット済みテキストで表示します。値を入力しない場合、コマンドを対話形式で実行したときは `PRETTY` が、コマンドを非対話形式で実行したときは `JSON` が使用されます。

パラメータ

必須か任意か

説明

--id SP-ID

必須

サービスプロバイダの ID。

--json JSON

--pretty PRETTY

任意

出力を JSON 形式またはフォーマット済みテキストで表示します。

値を入力しない場合、コマンドを対話形式で実行したときは PRETTY が、コマンドを非対話形式で実行したときは JSON が使用されます。

Keystone ID プロバイダ

Keystone ID プロバイダに対して viocli federation がサポートするアクションは以下のとおりです。

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

サービスプロバイダを追加します。Keystone 情報を入力するように求められます。add アクションには、以下の追加のパラメータが適用されます。

パラメータ	必須か任意か	説明
--type {keystone \| saml2 \| vidm \| openid}	任意	追加する ID プロバイダのタイプを指定します。コマンドにこのオプションを指定しない場合、値を入力するように求められます。

パラメータ

必須か任意か

説明

--type {keystone | saml2 | vidm | openid}

任意

追加する ID プロバイダのタイプを指定します。

コマンドにこのオプションを指定しない場合、値を入力するように求められます。

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

ID プロバイダを削除します。remove アクションには、以下の追加のパラメータが適用されます。

パラメータ	必須か任意か	説明
--id `IDP-ID`	必須	削除する ID プロバイダの ID。 viocli federation identity-provider list コマンドを実行して、各 ID プロバイダの ID を表示できます。

パラメータ

必須か任意か

説明

--id IDP-ID

必須

削除する ID プロバイダの ID。

viocli federation identity-provider list コマンドを実行して、各 ID プロバイダの ID を表示できます。

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

ID プロバイダの構成を変更します。edit アクションには、以下の追加のパラメータが適用されます。

パラメータ	必須か任意か	説明
--id `IDP-ID`	必須	変更する ID プロバイダの ID。 viocli federation identity-provider list コマンドを実行して、各 ID プロバイダの ID を表示できます。

パラメータ

必須か任意か

説明

--id IDP-ID

必須

変更する ID プロバイダの ID。

viocli federation identity-provider list コマンドを実行して、各 ID プロバイダの ID を表示できます。

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

すべての ID プロバイダについての情報を表示します。list アクションには、以下の追加のパラメータが適用されます。

パラメータ	必須か任意か	説明
--json JSON --pretty PRETTY	任意	出力を JSON 形式またはフォーマット済みテキストで表示します。値を入力しない場合、コマンドを対話形式で実行したときは `PRETTY` が、コマンドを非対話形式で実行したときは `JSON` が使用されます。

パラメータ

必須か任意か

説明

--json JSON

--pretty PRETTY

任意

出力を JSON 形式またはフォーマット済みテキストで表示します。

値を入力しない場合、コマンドを対話形式で実行したときは PRETTY が、コマンドを非対話形式で実行したときは JSON が使用されます。

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

ID プロバイダについての詳細情報を表示します。show アクションには、以下の追加のパラメータが適用されます。

パラメータ	必須か任意か	説明
--id `IDP-ID`	必須	ID プロバイダの ID。
--json JSON --pretty PRETTY	任意	出力を JSON 形式またはフォーマット済みテキストで表示します。値を入力しない場合、コマンドを対話形式で実行したときは `PRETTY` が、コマンドを非対話形式で実行したときは `JSON` が使用されます。

パラメータ

必須か任意か

説明

--id IDP-ID

必須

ID プロバイダの ID。

--json JSON

--pretty PRETTY

任意

出力を JSON 形式またはフォーマット済みテキストで表示します。

値を入力しない場合、コマンドを対話形式で実行したときは PRETTY が、コマンドを非対話形式で実行したときは JSON が使用されます。

ID プロバイダ メタデータ

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

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

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

Keystone サービス プロバイダ

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

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

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

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

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

Keystone ID プロバイダ

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

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

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

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

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

ID プロバイダメタデータ

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

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

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

Keystone サービスプロバイダ

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

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

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

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

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

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

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

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

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

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