diff --git a/doc/cli-reference/source/neutron-debug.rst b/doc/cli-reference/source/neutron-debug.rst index 50d7638a2f..857682cef1 100644 --- a/doc/cli-reference/source/neutron-debug.rst +++ b/doc/cli-reference/source/neutron-debug.rst @@ -23,15 +23,25 @@ neutron-debug usage .. code-block:: console usage: neutron-debug [--version] [-v] [-q] [-h] [-r NUM] - [--os-password ] - [--os-tenant-name ] - [--os-tenant-id ] [--os-auth-url ] - [--os-region-name ] [--service-type ] - [--service-name ] - [--volume-service-name ] + [--os-service-type ] + [--os-endpoint-type ] + [--service-type ] [--endpoint-type ] - [--os-volume-api-version ] - [--os-cacert ] [--retries ] + [--os-auth-strategy ] [--os-cloud ] + [--os-auth-url ] + [--os-tenant-name | --os-project-name ] + [--os-tenant-id | --os-project-id ] + [--os-username ] + [--os-user-id ] + [--os-user-domain-id ] + [--os-user-domain-name ] + [--os-project-domain-id ] + [--os-project-domain-name ] + [--os-cert ] [--os-cacert ] + [--os-key ] [--os-password ] + [--os-region-name ] + [--os-token ] [--http-timeout ] + [--os-url ] [--insecure] [--config-file CONFIG_FILE] ... Subcommands @@ -62,59 +72,122 @@ neutron-debug optional arguments ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ``--version`` - Show version number and exit. + Show program's version number and exit ``-v, --verbose, --debug`` - Increase verbosity of output and show tracebacks on errors. Can be repeated. + Increase verbosity of output and show tracebacks on + errors. You can repeat this option. ``-q, --quiet`` - Suppress output except warnings and errors + Suppress output except warnings and errors. ``-h, --help`` Show this help message and exit -``--os-auth-strategy `` - Authentication strategy (Env: ``OS_AUTH_STRATEGY``, default ``keystone``). - For now, any other value will disable the authentication +``-r NUM, --retries NUM`` + How many times the request to the Neutron server + should be retried if it fails. -``--os-auth-url `` - Authentication URL (Env: ``OS_AUTH_URL``) +``--os-service-type `` + Defaults to env[OS_NETWORK_SERVICE_TYPE] or network. -``--os-tenant-name `` - Authentication tenant name (Env: ``OS_TENANT_NAME``) +``--os-endpoint-type `` + Defaults to ``env[OS_ENDPOINT_TYPE]`` or public. -``--os-tenant-id `` - Authentication tenant name (Env: ``OS_TENANT_ID``) - -``--os-username `` - Authentication username (Env: ``OS_USERNAME``) - -``--os-password `` - Authentication password (Env: ``OS_PASSWORD``) - -``--os-region-name `` - Authentication region name (Env: ``OS_REGION_NAME``) - -``--os-token `` - Defaults to ``env[OS_TOKEN]`` +``--service-type `` + DEPRECATED! Use --os-service-type. ``--endpoint-type `` - Defaults to ``env[OS_ENDPOINT_TYPE]`` or public URL. + DEPRECATED! Use --os-endpoint-type. -``--os-url `` - Defaults to ``env[OS_URL]`` +``--os-auth-strategy `` + DEPRECATED! Only keystone is supported. + +``os-cloud `` + Defaults to env[OS_CLOUD]. + +``--os-auth-url `` + Authentication URL, defaults to env[OS_AUTH_URL]. + +``--os-tenant-name `` + Authentication tenant name, defaults to + env[OS_TENANT_NAME]. + +``--os-project-name `` + Another way to specify tenant name. This option is + mutually exclusive with --os-tenant-name. Defaults to + env[OS_PROJECT_NAME]. + +``--os-tenant-id `` + Authentication tenant ID, defaults to + env[OS_TENANT_ID]. + +``--os-project-id `` + Another way to specify tenant ID. This option is + mutually exclusive with --os-tenant-id. Defaults to + env[OS_PROJECT_ID]. + +``--os-username `` + Authentication username, defaults to env[OS_USERNAME]. + +``--os-user-id `` + Authentication user ID (Env: OS_USER_ID) + +``--os-user-domain-id `` + OpenStack user domain ID. Defaults to + env[OS_USER_DOMAIN_ID]. + +``--os-user-domain-name `` + OpenStack user domain name. Defaults to + env[OS_USER_DOMAIN_NAME]. + +``--os-project-domain-id `` + Defaults to env[OS_PROJECT_DOMAIN_ID]. + +``--os-project-domain-name `` + Defaults to env[OS_PROJECT_DOMAIN_NAME]. + +``--os-cert `` + Path of certificate file to use in SSL connection. + This file can optionally be prepended with the private + key. Defaults to env[OS_CERT]. ``--os-cacert `` - Specify a CA bundle file to use in verifying a TLS (HTTPS) server - certificate. Defaults to ``env[OS_CACERT]`` + Specify a CA bundle file to use in verifying a TLS + (https) server certificate. Defaults to + env[OS_CACERT]. + +``--os-key `` + Path of client key to use in SSL connection. This + option is not necessary if your key is prepended to + your certificate file. Defaults to env[OS_KEY]. + +``--os-password `` + Authentication password, defaults to env[OS_PASSWORD]. + +``--os-region-name `` + Authentication region name, defaults to + env[OS_REGION_NAME]. + +``--os-token `` + Authentication token, defaults to env[OS_TOKEN]. + +``--http-timeout `` + Timeout in seconds to wait for an HTTP response. + Defaults to env[OS_NETWORK_TIMEOUT] or None if not + specified. + +``--os-url `` + Defaults to env[OS_URL] ``--insecure`` - Explicitly allow neutron-debug to perform "insecure" SSL (HTTPS) requests. - The server's certificate will not be verified against any certificate - authorities. This option should be used with caution. + Explicitly allow neutronclient to perform "insecure" + SSL (https) requests. The server's certificate will + not be verified against any certificate authorities. + This option should be used with caution. ``--config-file CONFIG_FILE`` - Config file for interface driver (You may also use ``l3_agent.ini``) + Config file for interface driver (You may also use l3_agent.ini) neutron-debug probe-create command ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~