第 7 章 Identity 服务命令行客户端
警告
keystone CLI 已被弃用,而是使用 python-openstackclient。有关 python-openstackclient 的更多信息,请参阅 第 3.3 节 “子命令”。对于 Python 库,继续使用 python-keystoneclient。
keystone 客户端是 Identity 服务 API 及其扩展的命令行界面(CLI)。本章记录了 keystone 版本
1.7.2。
有关特定 keystone 命令的帮助信息,请输入:
keystone help COMMAND
$ 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> ...
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-delete
- 从 Service Catalog 删除服务。
- service-get
- 显示服务目录中的服务。
- service-list
- 列出 Service Catalog 中的所有服务。
- 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。
- 帮助
- 显示有关该程序或其其中一个子命令的帮助。
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>
- 指定要用于身份验证的身份端点。默认为
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>]
usage: keystone bootstrap [--user-name <user-name>] --pass <password> [--role-name <role-name>] [--tenant-name <tenant-name>]
在创建了每个租户后,为新租户上的新用户授予新角色。
参数
- --user-name <user-name>
- 要创建的用户的名称(default="admin")。
- --pass <password>
- 新用户的密码。
- --role-name <role-name>
- 要创建并授予用户的角色的名称(default="admin")。
- --tenant-name <tenant-name>
- 要创建的租户的名称(default="admin")。
7.4. Keystone 目录 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: keystone catalog [--service <service-type>]
usage: keystone catalog [--service <service-type>]
列出服务目录,可以按服务过滤。
参数
- --service <service-type>
- 要返回的服务类型。
7.5. Keystone discover 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: 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>]
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>
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>
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>]
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>]
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>
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>]
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>
- 要选择的服务属性。
- --value <value>
- 要匹配的属性值。
7.13. Keystone endpoint-list 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: keystone endpoint-list
usage: keystone endpoint-list
列出配置的服务端点。
7.14. Keystone password-update 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: keystone password-update [--current-password <current-password>] [--new-password <new-password>]
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>
usage: keystone role-create --name <role-name>
创建新角色。
参数
- --name <role-name>
- 新角色的名称。
7.16. Keystone role-delete 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: keystone role-delete <role>
usage: keystone role-delete <role>
删除角色.
参数
- <role>
- 要删除的角色的名称或 ID。
7.17. Keystone role-get 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: keystone role-get <role>
usage: keystone role-get <role>
显示角色详细信息.
参数
- <role>
- 要显示的角色名称或 ID。
7.18. Keystone role-list 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: keystone role-list
usage: keystone role-list
列出所有角色。
7.19. Keystone service-create 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: keystone service-create --type <type> [--name <name>] [--description <service-description>]
usage: keystone service-create --type <type> [--name <name>] [--description <service-description>]
将服务添加到服务目录。
参数
- --type <type>
- 服务类型(一种: identity、compute、network、image、object-store 或其他服务标识符字符串)。
- --name <name>
- 新服务的名称(必须唯一)。
- --description <service-description>
- 服务描述。
7.20. Keystone service-delete 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: keystone service-delete <service>
usage: keystone service-delete <service>
从 Service Catalog 删除服务。
参数
- <service>
- 要删除的服务名称或 ID。
7.21. Keystone service-get 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: keystone service-get <service>
usage: keystone service-get <service>
显示服务目录中的服务。
参数
- <service>
- 要显示的服务的名称或 ID。
7.22. Keystone service-list 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: keystone service-list
usage: keystone service-list
列出 Service Catalog 中的所有服务。
7.23. Keystone tenant-create 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: keystone tenant-create --name <tenant-name> [--description <tenant-description>] [--enabled <true|false>]
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>
usage: keystone tenant-delete <tenant>
删除租户。
参数
- <tenant>
- 要删除的租户的名称或 ID。
7.25. Keystone tenant-get 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: keystone tenant-get <tenant>
usage: keystone tenant-get <tenant>
显示租户详细信息。
参数
- <tenant>
- 要显示的租户的名称或 ID。
7.26. Keystone tenant-list 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: 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>
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>]
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>]
usage: keystone user-create --name <user-name> [--tenant <tenant>] [--pass [<pass>]] [--email <email>] [--enabled <true|false>]
创建新用户。
参数
- --name <user-name>
- 新用户名(必须唯一)。
- --tenant <tenant>, --tenant-id <tenant>
- 新用户默认租户。
- --pass [<pass>]
- 新用户密码;某些身份验证后端是必需的。
- --email <email>
- 新用户电子邮件地址。
- --enabled <true|false>
- 初始用户启用状态。默认为 true。
7.30. Keystone user-delete 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: keystone user-delete <user>
usage: keystone user-delete <user>
删除用户。
参数
- <user>
- 要删除的用户的名称或 ID。
7.31. Keystone user-get 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: keystone user-get <user>
usage: keystone user-get <user>
显示用户详情。
参数
- <user>
- 要显示的用户的名称或 ID。
7.32. Keystone user-list 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: keystone user-list [--tenant <tenant>]
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>
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>]
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>]
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>]
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>
usage: keystone user-update [--name <user-name>] [--email <email>] [--enabled <true|false>] <user>
更新用户的名称、电子邮件和启用的状态。
参数
- --name <user-name>
- 所需的新用户名。
- --email <email>
- 需要的新电子邮件地址。
- --enabled <true|false>
- 启用或禁用用户。
- <user>
- 要更新的用户的名称或 ID。