第7章 Identity サービスのコマンドラインクライアント
警告
keystone CLI は非推奨となり、python-openstackclient が採用されました。python-openstackclient の詳細は、「サブコマンド」 を参照してください。Python ライブラリーの場合は、python-keystoneclient を引き続き使用します。
keystone クライアントは、Identity サービス API とその拡張機能のコマンドラインインターフェイス(CLI)です。本章では、keystone バージョン
1.7.2 について説明します。
特定の keystone コマンドのヘルプは、以下を入力します。
$ keystone help COMMAND
7.1. Keystone の使用方法 リンクのコピーリンクがクリップボードにコピーされました!
リンクのコピーリンクがクリップボードにコピーされました!
usage: keystone [--version] [--debug] [--os-username <auth-user-name>] [--os-password <auth-password>] [--os-tenant-name <auth-tenant-name>] [--os-tenant-id <tenant-id>] [--os-auth-url <auth-url>] [--os-region-name <region-name>] [--os-identity-api-version <identity-api-version>] [--os-token <service-token>] [--os-endpoint <service-endpoint>] [--os-cache] [--force-new-token] [--stale-duration <seconds>] [--insecure] [--os-cacert <ca-certificate>] [--os-cert <certificate>] [--os-key <key>] [--timeout <seconds>] <subcommand> ...
サブコマンド
- catalog
- サービスカタログをリスト表示します(おそらくサービスでフィルターされる可能性があります)。
- ec2-credentials-create
- テナントごとにユーザーの EC2 互換認証情報を作成します。
- ec2-credentials-delete
- EC2 互換の認証情報を削除します。
- ec2-credentials-get
- EC2 互換認証情報を表示します。
- ec2-credentials-list
- ユーザーの EC2 互換認証情報を一覧表示します。
- endpoint-create
- サービスに関連付けられた新規エンドポイントを作成します。
- endpoint-delete
- サービスエンドポイントを削除します。
- endpoint-get
- 特定の属性またはサービスタイプでフィルタリングされたエンドポイントを検索します。
- endpoint-list
- 設定済みのサービスエンドポイントを一覧表示します。
- password-update
- 独自のパスワードを更新します。
- role-create
- 新規ロールを作成します。
- role-delete
- ロールを削除します。
- role-get
- ロールの詳細を表示します。
- role-list
- すべてのロールを一覧表示します。
- service-create
- サービスを Service Catalog に追加します。
- service-delete
- サービスカタログからサービスを削除します。
- service-get
- サービスカタログからサービスを表示します。
- service-list
- サービスカタログのすべてのサービスを一覧表示します。
- tenant-create
- 新規テナントを作成します。
- tenant-delete
- テナントを削除します。
- tenant-get
- テナントの詳細を表示します。
- tenant-list
- すべてのテナントを一覧表示します。
- tenant-update
- テナント名、説明、有効なステータスを更新します。
- token-get
- 現在のユーザートークンを表示します。
- user-create
- 新規ユーザーを作成します。
- user-delete
- ユーザーを削除します。
- user-get
- ユーザーの詳細を表示します。
- user-list
- ユーザーを一覧表示します。
- user-password-update
- ユーザーパスワードを更新します。
- user-role-add
- ユーザーにロールを追加します。
- user-role-list
- ユーザーに付与されているロールを一覧表示します。
- user-role-remove
- ユーザーからロールを削除します。
- user-update
- ユーザーの名前、電子メール、および有効なステータスを更新します。
- discover
- Keystone サーバーを検出し、サポートされる API バージョンと拡張機能を検出します。
- bootstrap
- 各テナントの作成後に、新しいテナントの新規ユーザーに新規ロールを付与します。
- bash-completion
- すべてのコマンドとオプションを stdout に出力します。
- help
- このプログラムまたはそのサブコマンドのヘルプを表示します。
7.2. Keystone の任意の引数 リンクのコピーリンクがクリップボードにコピーされました!
リンクのコピーリンクがクリップボードにコピーされました!
- --version
- クライアントのバージョンを表示し、終了します。
- --debug
- デバッグ出力をコンソールに出力します。これには、curl 要求および応答呼び出しが含まれます。API 呼び出しのデバッグおよび理解に役立ちます。
- --os-username <auth-user-name>
- OpenStack Identity サービスでの認証に使用される名前。デフォルトは
env[OS_USERNAME]です。 - --os-password <auth-password>
- OpenStack Identity サービスとの認証に使用されるパスワード。デフォルトは
env[OS_PASSWORD]です。 - --os-tenant-name <auth-tenant-name>
- 承認を要求するテナント。デフォルトは
env[OS_TENANT_NAME]です。 - --os-tenant-id <tenant-id>
- 承認を要求するテナント。デフォルトは
env[OS_TENANT_ID]です。 - --os-auth-url <auth-url>
- 認証に使用する Identity エンドポイントを指定します。デフォルトは
env[OS_AUTH_URL]です。 - --os-region-name <region-name>
- 使用するリージョンを指定します。デフォルトは
env[OS_REGION_NAME]です。 - --os-identity-api-version <identity-api-version>
- 使用する Identity API バージョンを指定します。デフォルトは
env[OS_IDENTITY_API_VERSION]または 2.0 です。 - --os-token <service-token>
- 認証に使用する既存のトークンを指定します(例:ユーザー名とパスワード)。デフォルトは
env[OS_SERVICE_TOKEN]です。 - --os-endpoint <service-endpoint>
- (認証経由で)サービスカタログから取得する代わりに、使用するエンドポイントを指定します。デフォルトは
env[OS_SERVICE_ENDPOINT]です。 - --os-cache
- 認証トークンキャッシュを使用します。デフォルトは
env[OS_CACHE]です。 - --force-new-token
- キーリングが利用可能で使用中の場合、トークンは常に保存され、トークンの有効期限が切れるまでキーリングから取得されます。新しいトークンを要求し、キーリング内の既存のトークンを置き換えるには、このオプションを使用します。
- --stale-duration <seconds>
- キーリングからトークンを取得するときに、トークンが期限切れかどうかを判断するために使用される古い期間(秒単位)。これは、プロセスやネットワークの遅延を軽減するのに役立ちます。デフォルトは 30 秒です。
- --insecure
- クライアントがセキュアでない TLS (https)要求を実行することを明示的に許可します。サーバーの証明書は認証局に対して検証されません。このオプションは注意して使用する必要があります。
- --os-cacert <ca-certificate>
- TLS (https)サーバー証明書の検証に使用する CA バンドルファイルを指定します。デフォルトは
env[OS_CACERT]です。 - --os-cert <certificate>
- デフォルトは
env[OS_CERT]です。 - --os-key <key>
- デフォルトは
env[OS_KEY]です。 - --timeout <seconds>
- リクエストのタイムアウトを秒単位で設定します(秒単位)。
7.3. Keystone bootstrap リンクのコピーリンクがクリップボードにコピーされました!
リンクのコピーリンクがクリップボードにコピーされました!
usage: keystone bootstrap [--user-name <user-name>] --pass <password> [--role-name <role-name>] [--tenant-name <tenant-name>]
各テナントの作成後に、新しいテナントの新規ユーザーに新規ロールを付与します。
引数
- --user-name <user-name>
- 作成するユーザーの名前(デフォルトは admin)です。
- --pass <password>
- 新しいユーザーのパスワード。
- --role-name <role-name>
- ユーザーに作成して付与されるロールの名前(デフォルトは admin)。
- --tenant-name <tenant-name>
- 作成するテナントの名前(デフォルト="admin")。
7.4. Keystone カタログ リンクのコピーリンクがクリップボードにコピーされました!
リンクのコピーリンクがクリップボードにコピーされました!
usage: keystone catalog [--service <service-type>]
サービスカタログをリスト表示します(おそらくサービスでフィルターされる可能性があります)。
引数
- --service <service-type>
- 返すサービスタイプ。
7.5. keystone discover リンクのコピーリンクがクリップボードにコピーされました!
リンクのコピーリンクがクリップボードにコピーされました!
usage: keystone discover
Keystone サーバーを検出し、サポートされる API バージョンと拡張機能を検出します。
7.6. Keystone ec2-credentials-create リンクのコピーリンクがクリップボードにコピーされました!
リンクのコピーリンクがクリップボードにコピーされました!
usage: keystone ec2-credentials-create [--user-id <user-id>] [--tenant-id <tenant-id>]
テナントごとにユーザーの EC2 互換認証情報を作成します。
引数
- --user-id <user-id>
- 認証情報を作成するユーザー ID。指定しない場合、認証されたユーザーが使用されます。
- --tenant-id <tenant-id>
- 認証情報を作成するテナント ID。指定しない場合、認証されたテナント ID が使用されます。
7.7. Keystone ec2-credentials-delete リンクのコピーリンクがクリップボードにコピーされました!
リンクのコピーリンクがクリップボードにコピーされました!
usage: keystone ec2-credentials-delete [--user-id <user-id>] --access <access-key>
EC2 互換の認証情報を削除します。
引数
- --user-id <user-id>
- ユーザー ID。
- --access <access-key>
- アクセスキー。
7.8. keystone ec2-credentials-get リンクのコピーリンクがクリップボードにコピーされました!
リンクのコピーリンクがクリップボードにコピーされました!
usage: keystone ec2-credentials-get [--user-id <user-id>] --access <access-key>
EC2 互換認証情報を表示します。
引数
- --user-id <user-id>
- ユーザー ID。
- --access <access-key>
- アクセスキー。
7.9. keystone ec2-credentials-list リンクのコピーリンクがクリップボードにコピーされました!
リンクのコピーリンクがクリップボードにコピーされました!
usage: keystone ec2-credentials-list [--user-id <user-id>]
ユーザーの EC2 互換認証情報を一覧表示します。
引数
- --user-id <user-id>
- ユーザー ID。
7.10. Keystone endpoint-create リンクのコピーリンクがクリップボードにコピーされました!
リンクのコピーリンクがクリップボードにコピーされました!
usage: keystone endpoint-create [--region <endpoint-region>] --service <service> --publicurl <public-url> [--adminurl <admin-url>] [--internalurl <internal-url>]
サービスに関連付けられた新規エンドポイントを作成します。
引数
- --region <endpoint-region>
- エンドポイントリージョン。
- --service <service>, --service-id <service>, --service_id <service>
- エンドポイントに関連付けられたサービスの名前または ID。
- --publicurl <public-url>
- 公開 URL エンドポイント。
- --Adminurl <admin-url>
- 管理 URL エンドポイント。
- --InternalUrl <internal-url>
- 内部 URL エンドポイント。
7.11. Keystone endpoint-delete リンクのコピーリンクがクリップボードにコピーされました!
リンクのコピーリンクがクリップボードにコピーされました!
usage: keystone endpoint-delete <endpoint-id>
サービスエンドポイントを削除します。
引数
- <endpoint-id>
- 削除するエンドポイントの ID。
7.12. Keystone endpoint-get リンクのコピーリンクがクリップボードにコピーされました!
リンクのコピーリンクがクリップボードにコピーされました!
usage: keystone endpoint-get --service <service-type> [--endpoint-type <endpoint-type>] [--attr <service-attribute>] [--value <value>]
特定の属性またはサービスタイプでフィルタリングされたエンドポイントを検索します。
引数
- --service <service-type>
- 選択するサービスタイプ。
- --endpoint-type <endpoint-type>
- 選択するエンドポイントタイプ。
- --attr <service-attribute>
- 選択について照合する service 属性。
- --value <value>
- 照合する属性の値。
7.13. Keystone endpoint-list リンクのコピーリンクがクリップボードにコピーされました!
リンクのコピーリンクがクリップボードにコピーされました!
usage: keystone endpoint-list
設定済みのサービスエンドポイントを一覧表示します。
7.14. Keystone の password-update リンクのコピーリンクがクリップボードにコピーされました!
リンクのコピーリンクがクリップボードにコピーされました!
usage: keystone password-update [--current-password <current-password>] [--new-password <new-password>]
独自のパスワードを更新します。
引数
- --current-password <current-password>
- 現在のパスワード。デフォルトは --os-password または
env[OS_PASSWORD]により設定されたパスワードになります。 - --new-password <new-password>
- 新しいパスワードが必要です。
7.15. keystone role-create リンクのコピーリンクがクリップボードにコピーされました!
リンクのコピーリンクがクリップボードにコピーされました!
usage: keystone role-create --name <role-name>
新規ロールを作成します。
引数
- --name <role-name>
- 新規ロールの名前。
7.16. keystone の role-delete リンクのコピーリンクがクリップボードにコピーされました!
リンクのコピーリンクがクリップボードにコピーされました!
usage: keystone role-delete <role>
ロールを削除します。
引数
- <role>
- 削除するロールの名前または ID。
7.17. keystone の role-get リンクのコピーリンクがクリップボードにコピーされました!
リンクのコピーリンクがクリップボードにコピーされました!
usage: keystone role-get <role>
ロールの詳細を表示します。
引数
- <role>
- 表示するロールの名前または ID。
7.18. keystone role-list リンクのコピーリンクがクリップボードにコピーされました!
リンクのコピーリンクがクリップボードにコピーされました!
usage: keystone role-list
すべてのロールを一覧表示します。
7.19. Keystone service-create リンクのコピーリンクがクリップボードにコピーされました!
リンクのコピーリンクがクリップボードにコピーされました!
usage: keystone service-create --type <type> [--name <name>] [--description <service-description>]
サービスを Service Catalog に追加します。
引数
- --type <type>
- サービスタイプ(ID、compute、network、image、object-store、またはその他のサービス識別子文字列のいずれか)。
- --name <name>
- 新規サービスの名前(一意である必要があります)。
- --description <service-description>
- サービスの説明。
7.20. Keystone service-delete リンクのコピーリンクがクリップボードにコピーされました!
リンクのコピーリンクがクリップボードにコピーされました!
usage: keystone service-delete <service>
サービスカタログからサービスを削除します。
引数
- <service>
- 削除するサービスの名前または ID。
7.21. Keystone service-get リンクのコピーリンクがクリップボードにコピーされました!
リンクのコピーリンクがクリップボードにコピーされました!
usage: keystone service-get <service>
サービスカタログからサービスを表示します。
引数
- <service>
- 表示するサービスの名前または ID。
7.22. Keystone service-list リンクのコピーリンクがクリップボードにコピーされました!
リンクのコピーリンクがクリップボードにコピーされました!
usage: keystone service-list
サービスカタログのすべてのサービスを一覧表示します。
7.23. Keystone tenant-create リンクのコピーリンクがクリップボードにコピーされました!
リンクのコピーリンクがクリップボードにコピーされました!
usage: keystone tenant-create --name <tenant-name> [--description <tenant-description>] [--enabled <true|false>]
新規テナントを作成します。
引数
- --name <tenant-name>
- 新規テナント名(一意である必要があります)。
- --description <tenant-description>
- 新規テナントの説明。デフォルトは none です。
- --enabled <true|false>
- テナントの初期有効化ステータス。デフォルトは true です。
7.24. Keystone tenant-delete リンクのコピーリンクがクリップボードにコピーされました!
リンクのコピーリンクがクリップボードにコピーされました!
usage: keystone tenant-delete <tenant>
テナントを削除します。
引数
- <tenant>
- 削除するテナントの名前または ID。
7.25. Keystone tenant-get リンクのコピーリンクがクリップボードにコピーされました!
リンクのコピーリンクがクリップボードにコピーされました!
usage: keystone tenant-get <tenant>
テナントの詳細を表示します。
引数
- <tenant>
- 表示するテナントの名前または ID。
7.26. Keystone tenant-list リンクのコピーリンクがクリップボードにコピーされました!
リンクのコピーリンクがクリップボードにコピーされました!
usage: keystone tenant-list
すべてのテナントを一覧表示します。
7.27. Keystone tenant-update リンクのコピーリンクがクリップボードにコピーされました!
リンクのコピーリンクがクリップボードにコピーされました!
usage: keystone tenant-update [--name <tenant_name>] [--description <tenant-description>] [--enabled <true|false>] <tenant>
テナント名、説明、有効なステータスを更新します。
引数
- --name <tenant_name>
- テナントの新しい名前が必要です。
- --description <tenant-description>
- テナントの新しい説明が必要です。
- --enabled <true|false>
- テナントを有効または無効にします。
- <tenant>
- 更新するテナントの名前または ID。
7.28. Keystone token-get リンクのコピーリンクがクリップボードにコピーされました!
リンクのコピーリンクがクリップボードにコピーされました!
usage: keystone token-get [--wrap <integer>]
現在のユーザートークンを表示します。
引数
- --wrap <integer>
- PKI トークンを指定された長さにラップ、または 0 を無効にするには無効にします。
7.29. Keystone user-create リンクのコピーリンクがクリップボードにコピーされました!
リンクのコピーリンクがクリップボードにコピーされました!
usage: keystone user-create --name <user-name> [--tenant <tenant>] [--pass [<pass>]] [--email <email>] [--enabled <true|false>]
新規ユーザーを作成します。
引数
- --name <user-name>
- 新規ユーザー名(一意である必要があります)
- --tenant <tenant>, --tenant-id <tenant>
- 新規ユーザーのデフォルトテナント。
- --passApnspass>]
- 新たなユーザーパスワード。一部の認証バックエンドに必要。
- --email <email>
- 新規ユーザーのメールアドレス。
- --enabled <true|false>
- ユーザーの初期有効ステータス。デフォルトは true です。
7.30. Keystone user-delete リンクのコピーリンクがクリップボードにコピーされました!
リンクのコピーリンクがクリップボードにコピーされました!
usage: keystone user-delete <user>
ユーザーを削除します。
引数
- <user>
- 削除するユーザーの名前または ID。
7.31. Keystone user-get リンクのコピーリンクがクリップボードにコピーされました!
リンクのコピーリンクがクリップボードにコピーされました!
usage: keystone user-get <user>
ユーザーの詳細を表示します。
引数
- <user>
- 表示するユーザーの名前または ID。
7.32. Keystone user-list リンクのコピーリンクがクリップボードにコピーされました!
リンクのコピーリンクがクリップボードにコピーされました!
usage: keystone user-list [--tenant <tenant>]
ユーザーを一覧表示します。
引数
- --tenant <tenant>, --tenant-id <tenant>
- テナント:指定されていない場合はすべてのユーザーを一覧表示します。
7.33. Keystone user-password-update リンクのコピーリンクがクリップボードにコピーされました!
リンクのコピーリンクがクリップボードにコピーされました!
usage: keystone user-password-update [--pass <password>] <user>
ユーザーパスワードを更新します。
引数
- --pass <password>
- 新しいパスワードが必要です。
- <user>
- パスワードを更新するユーザーの名前または ID。
7.34. Keystone user-role-add リンクのコピーリンクがクリップボードにコピーされました!
リンクのコピーリンクがクリップボードにコピーされました!
usage: keystone user-role-add --user <user> --role <role> [--tenant <tenant>]
ユーザーにロールを追加します。
引数
- --user <user>, --user-id <user>, --user_id <user>
- ユーザーの名前または ID。
- --role <role>, --role-id <role>, --role_id <role>
- ロールの名前または ID。
- --tenant <tenant>, --tenant-id <tenant>
- テナントの名前または ID。
7.35. Keystone user-role-list リンクのコピーリンクがクリップボードにコピーされました!
リンクのコピーリンクがクリップボードにコピーされました!
usage: keystone user-role-list [--user <user>] [--tenant <tenant>]
ユーザーに付与されているロールを一覧表示します。
引数
- --user <user>, --user-id <user>
- 指定のユーザーに付与されているロールを一覧表示します。
- --tenant <tenant>, --tenant-id <tenant>
- 指定したテナントで付与されたロールのみを一覧表示します。
7.36. Keystone user-role-remove リンクのコピーリンクがクリップボードにコピーされました!
リンクのコピーリンクがクリップボードにコピーされました!
usage: keystone user-role-remove --user <user> --role <role> [--tenant <tenant>]
ユーザーからロールを削除します。
引数
- --user <user>, --user-id <user>, --user_id <user>
- ユーザーの名前または ID。
- --role <role>, --role-id <role>, --role_id <role>
- ロールの名前または ID。
- --tenant <tenant>, --tenant-id <tenant>
- テナントの名前または ID。
7.37. Keystone user-update リンクのコピーリンクがクリップボードにコピーされました!
リンクのコピーリンクがクリップボードにコピーされました!
usage: keystone user-update [--name <user-name>] [--email <email>] [--enabled <true|false>] <user>
ユーザーの名前、電子メール、および有効なステータスを更新します。
引数
- --name <user-name>
- 新しいユーザー名を指定します。
- --email <email>
- 新しいメールアドレス
- --enabled <true|false>
- ユーザーを有効または無効にします。
- <user>
- 更新するユーザーの名前または ID。