Command Reference--keystonne command

keystone commands

keystone指令（身份识别相关）

Describes commands for keystone, which is the command-line interface for the OpenStack Identity API.

For help on a specific keystone command, enter:

keystone命令的描述，它是OpenStack 身份识别API的命令行接口。查看keystone命令的帮助，输入下面的指令：

keystone help COMMAND

 

Example 1. Usage

例1：使用说明

keystone [--version] [--timeout <seconds>]
         [--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-cacert <ca-certificate>] [--insecure]
         [--os-cert <certificate>] [--os-key <key>] [--os-cache]
         [--force-new-token] [--stale-duration <seconds>]
         <subcommand> ...

 

Example 2. Positional arguments

例2：可以指定的参数

<subcommand>
    catalog             List service catalog, possibly filtered by service.(列出服务的栏目，通常用于过滤查询)
    ec2-credentials-create
                        Create EC2-compatible credentials for user per tenant （为每个租户用户创建与EC2兼容的凭证）
    ec2-credentials-delete
                        Delete EC2-compatible credentials（删除EC2兼容的证书凭证）
    ec2-credentials-get
                        Display EC2-compatible credentials（显示EC2兼容的证书凭证）
    ec2-credentials-list
                        List EC2-compatible credentials for a user（列出某个用户的EC2兼容证书凭证）
    endpoint-create     Create a new endpoint associated with a service（创建服务关联的endpoint）
    endpoint-delete     Delete a service endpoint （删除服务的endpoint）
    endpoint-get        Find endpoint filtered by a specific attribute or
                        service type（通过指定的属性或服务类型来过滤查找endpoint）
    endpoint-list       List configured service endpoints（列出已配制的服务endpoint）
    password-update     Update own password（更新自己的密码）
    role-create         Create new role（创建一个新的角色）
    role-delete         Delete role （删除角色）
    role-get            Display role details （显示角色的详细信息）
    role-list           List all roles （列出所有的角色）
    service-create      Add service to Service Catalog （添加服务到服务栏目）
    service-delete      Delete service from Service Catalog （从服务栏目中删除服务）
    service-get         Display service from Service Catalog （显示服务栏目中的服务）
    service-list        List all services in Service Catalog （列出所有服务栏目中的服务）

    tenant-create       Create new tenant （创建一个新的租户）
    tenant-delete       Delete tenant （删除租户）
    tenant-get          Display tenant details （显示租户的详细信息）
    tenant-list         List all tenants （列出所有的租户）
    tenant-update       Update tenant name, description, enabled status （更新租户名称，描述和状态）
    token-get           Display the current user token （显示当前登录用户的token）
    user-create         Create new user （创建一个新的用户 ）
    user-delete         Delete user （删除用户）
    user-get            Display user details. （显示用户的详细信息）
    user-list           List users （列出用户）
    user-password-update
                        Update user password （更新用户密码）
    user-role-add       Add role to user （为用户添加一个角色）
    user-role-list      List roles granted to a user （列出已授予某个用户的角色）
    user-role-remove    Remove role from user （从指定用户删除角色）
    user-update         Update user's name, email, and enabled status (更新用户的名称，邮箱地址，状态)
    discover            Discover Keystone servers, supported API versions and
                        extensions. （查找keystone服务器，支持的API版本和扩展）
    bootstrap           Grants a new role to a new user on a new tenant, after
                        creating each. （创建了租户、用户、角色后，在一个新的租户上，为一个新的用户授权一个角色）
    bash-completion     Prints all of the commands and options to stdout. （打印所有的指令和选择到标准输出控制台）
    help                Display help about this program or one of its 
                        subcommands. （显示keystone指令，或其子指令的帮助说明）

 

Example 3. Optional arguments

例3：可选参数

  --version             Shows the client version and exits

                        （显示keystone组件的版本）
  --timeout <seconds>   Set request timeout (in seconds)

                       （设置请求起时时间，单位：秒）
  --os-username <auth-user-name>
                        Name used for authentication with the OpenStack
                        Identity service. Defaults to env[OS_USERNAME] 

                      （OpenStack的授权用户名，默认是env[OS_USERNAME]）
  --os-password <auth-password>
                        Password used for authentication with the OpenStack
                        Identity service. Defaults to env[OS_PASSWORD]

                      （OpenStack的授权用户名的密码，默认是env[OS_PASSWORD]）
  --os-tenant-name <auth-tenant-name>
                        Tenant to request authorization on. Defaults to
                        env[OS_TENANT_NAME] 

                      （请求授权的租户名，默认是env[OS_TENANT_NAME]）
  --os-tenant-id <tenant-id>
                        Tenant to request authorization on. Defaults to
                        env[OS_TENANT_ID] 

                    （请求授权的租户ID，默认是env[OS_TENANT_ID]）
  --os-auth-url <auth-url>
                        Specify the Identity endpoint to use for
                        authentication. Defaults to env[OS_AUTH_URL]

                     （授权的身份识别接口endpoint，默认是env[OS_AUTH_URL]）
  --os-region-name <region-name>
                        Defaults to env[OS_REGION_NAME] 

                        （操作系统的区域名，默认是env[OS_REGION_NAME]）
  --os-identity-api-version <identity-api-version>
                        Defaults to env[OS_IDENTITY_API_VERSION] or 2.0 

                        （身份识别API版本，默认是env[OS_EDENTITY_API_VERSION]或者2.0）

  --os-token <service-token>
                        Specify an existing token to use instead of retrieving
                        one via authentication (e.g. with username &
                        password). Defaults to env[OS_SERVICE_TOKEN] 

                  （直接指定一个已存在的token来使用，而不是通过授权的方式取得token，比如用户名和密码。默认是env[OS_SERVICE_TOKEN]）
  --os-endpoint <service-endpoint>
                        Specify an endpoint to use instead of retrieving one
                        from the service catalog (via authentication).
                        Defaults to env[OS_SERVICE_ENDPOINT] 

                   （直接指定一个endpoint来使用，而不是通过授权的方式从服务列表中取得，默认是env[OS_SERVICE_ENDPOINT]）
  --os-cacert <ca-certificate>
                        Specify a CA bundle file to use in verifying a TLS
                        (https) server certificate. Defaults to env[OS_CACERT]

                    （直接指定一个CA文件来使用，而不是通过验证一个基于HTTPS的TLS服务器证书，默认是env[OS_CACERT]）
  --insecure            Explicitly allow keystoneclient to perform "insecure"
                        TLS (https) requests. The server's certificate will
                        not be verified against any certificate authorities.
                        This option should be used with caution. 

                    （明确允许keystoneclient执行insecure TLS请求。服务器的数据证书将不再验证任何授权证书）
  --os-cert <certificate>
                        Defaults to env[OS_CERT]

                        （默认值是env[OS_CERT]）
  --os-key <key>        Defaults to env[OS_KEY]  

                        （默认值是env[OS_KEY]）
  --os-cache            Use the auth token cache. Defaults to env[OS_CACHE] 

                    （使用授权token缓存。默认是env[OS_KEY]）
  --force-new-token     If the keyring is available and in use, token will
                        always be stored and fetched from the keyring until
                        the token has expired. Use this option to request a
                        new token and replace the existing one in the keyring. 

                    （如果密钥环是可用的而且正在被使用，token将被存储起来，至到此token失效为止.

                     使用这个选项，去请求一个新的token和替换已存在于密钥环上的token。）
  --stale-duration <seconds>
                        Stale duration (in seconds) used to determine whether
                        a token has expired when retrieving it from keyring.
                        This is useful in mitigating process or network
                        delays. Default is 30 seconds. 

                    （检查从token环上取得的token是否失效的时间间隔，单位：秒。这将有效缓解计算或网络延时。默认是30秒检查一次。）