The designate client is the command-line interface (CLI) for the DNS service API and its extensions. This chapter documents designate version 1.5.0. For help on a specific designate command, enter: $ designate help COMMAND

usage: designate [--version] [-v] [--log-file LOG_FILE] [-q] [-h] [--debug] [--os-username OS_USERNAME] [--os-user-id OS_USER_ID] [--os-user-domain-id OS_USER_DOMAIN_ID] [--os-user-domain-name OS_USER_DOMAIN_NAME] [--os-password OS_PASSWORD] [--os-tenant-name OS_TENANT_NAME] [--os-tenant-id OS_TENANT_ID] [--os-project-name OS_PROJECT_NAME] [--os-domain-name OS_DOMAIN_NAME] [--os-domain-id OS_DOMAIN_ID] [--os-project-id OS_PROJECT_ID] [--os-project-domain-id OS_PROJECT_DOMAIN_ID] [--os-project-domain-name OS_PROJECT_DOMAIN_NAME] [--os-auth-url OS_AUTH_URL] [--os-region-name OS_REGION_NAME] [--os-token OS_TOKEN] [--os-endpoint OS_ENDPOINT] [--os-endpoint-type OS_ENDPOINT_TYPE] [--os-service-type OS_SERVICE_TYPE] [--os-cacert OS_CACERT] [--insecure] [--all-tenants] [--edit-managed]

--version show program's version number and exit -v, --verbose Increase verbosity of output. Can be repeated. --log-file LOG_FILE Specify a file to log output. Disabled by default. -q, --quiet Suppress output except warnings and errors. -h, --help Show this help message and exit. --debug Show tracebacks on errors. --os-username OS_USERNAME Name used for authentication with the OpenStack Identity service. Defaults to env[OS_USERNAME]. --os-user-id OS_USER_ID User ID used for authentication with the OpenStack Identity service. Defaults to env[OS_USER_ID]. --os-user-domain-id OS_USER_DOMAIN_ID Defaults to env[OS_USER_DOMAIN_ID]. --os-user-domain-name OS_USER_DOMAIN_NAME Defaults to env[OS_USER_DOMAIN_NAME]. --os-password OS_PASSWORD Password used for authentication with the OpenStack Identity service. Defaults to env[OS_PASSWORD]. --os-tenant-name OS_TENANT_NAME Tenant to request authorization on. Defaults to env[OS_TENANT_NAME]. --os-tenant-id OS_TENANT_ID Tenant to request authorization on. Defaults to env[OS_TENANT_ID]. --os-project-name OS_PROJECT_NAME Project to request authorization on. Defaults to env[OS_PROJECT_NAME]. --os-domain-name OS_DOMAIN_NAME Project to request authorization on. Defaults to env[OS_DOMAIN_NAME]. --os-domain-id OS_DOMAIN_ID Defaults to env[OS_DOMAIN_ID]. --os-project-id OS_PROJECT_ID Project to request authorization on. Defaults to env[OS_PROJECT_ID]. --os-project-domain-id OS_PROJECT_DOMAIN_ID Defaults to env[OS_PROJECT_DOMAIN_ID]. --os-project-domain-name OS_PROJECT_DOMAIN_NAME Defaults to env[OS_PROJECT_DOMAIN_NAME]. --os-auth-url OS_AUTH_URL Specify the Identity endpoint to use for authentication. Defaults to env[OS_AUTH_URL]. --os-region-name OS_REGION_NAME Specify the region to use. Defaults to env[OS_REGION_NAME]. --os-token OS_TOKEN Specify an existing token to use instead of retrieving one via authentication (e.g. with username & password). Defaults to env[OS_SERVICE_TOKEN]. --os-endpoint OS_ENDPOINT Specify an endpoint to use instead of retrieving one from the service catalog (via authentication). Defaults to env[OS_DNS_ENDPOINT]. --os-endpoint-type OS_ENDPOINT_TYPE Defaults to env[OS_ENDPOINT_TYPE]. --os-service-type OS_SERVICE_TYPE Defaults to env[OS_DNS_SERVICE_TYPE], or 'dns'. --os-cacert OS_CACERT CA certificate bundle file. Defaults to env[OS_CACERT]. --insecure Explicitly allow 'insecure' SSL requests. --all-tenants Allows to list all domains from all tenants. --edit-managed Allows to edit records that are marked as managed.

usage: designate diagnostics-ping [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] --service SERVICE --host HOST Ping a service on a given host -h, --help show this help message and exit --service SERVICE Service name (e.g. central) --host HOST Hostname

usage: designate domain-create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] --name NAME --email EMAIL [--ttl TTL] [--description DESCRIPTION] Create Domain -h, --help show this help message and exit --name NAME Domain name --email EMAIL Domain email --ttl TTL Time to live (seconds) --description DESCRIPTION Description

usage: designate domain-delete [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] id Delete Domain id Domain ID or name -h, --help show this help message and exit

usage: designate domain-get [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] id Get Domain id Domain ID or name -h, --help show this help message and exit

usage: designate domain-list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] List Domains -h, --help show this help message and exit

usage: designate domain-servers-list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] id List Domain Servers id Domain ID or name -h, --help show this help message and exit

usage: designate domain-update [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--name NAME] [--email EMAIL] [--ttl TTL] [--description DESCRIPTION | --no-description] id Update Domain id Domain ID or name -h, --help show this help message and exit --name NAME Domain name --email EMAIL Domain email --ttl TTL Time to live (seconds) --description DESCRIPTION Description --no-description

usage: designate quota-get [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] tenant_id Get Quota tenant_id Tenant ID -h, --help show this help message and exit

usage: designate quota-reset [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] tenant_id Reset Quota tenant_id Tenant ID -h, --help show this help message and exit

usage: designate quota-update [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--domains DOMAINS] [--domain-recordsets DOMAIN_RECORDSETS] [--recordset-records RECORDSET_RECORDS] [--domain-records DOMAIN_RECORDS] tenant_id Update Quota tenant_id Tenant ID -h, --help show this help message and exit --domains DOMAINS Allowed domains --domain-recordsets DOMAIN_RECORDSETS Allowed domain records --recordset-records RECORDSET_RECORDS Allowed recordset records --domain-records DOMAIN_RECORDS Allowed domain records

usage: designate record-create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] --name NAME --type TYPE --data DATA [--ttl TTL] [--priority PRIORITY] [--description DESCRIPTION] domain_id Create Record domain_id Domain ID or name -h, --help show this help message and exit --name NAME Record (relative|absolute) name --type TYPE Record type --data DATA Record data --ttl TTL Record TTL --priority PRIORITY Record priority --description DESCRIPTION Description

usage: designate record-delete [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] domain_id id Delete Record domain_id Domain ID or name id Record ID -h, --help show this help message and exit

usage: designate record-get [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] domain_id id Get Record domain_id Domain ID or name id Record ID -h, --help show this help message and exit

usage: designate record-list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] domain_id List Records domain_id Domain ID or name -h, --help show this help message and exit

usage: designate record-update [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--name NAME] [--type TYPE] [--data DATA] [--description DESCRIPTION | --no-description] [--ttl TTL | --no-ttl] [--priority PRIORITY | --no-priority] domain_id id Update Record domain_id Domain ID or name id Record ID -h, --help show this help message and exit --name NAME Record name --type TYPE Record type --data DATA Record data --description DESCRIPTION Description --no-description --ttl TTL Record time to live (seconds) --no-ttl --priority PRIORITY Record priority --no-priority

usage: designate report-count-all [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] Get count totals for all tenants, domains and records -h, --help show this help message and exit

usage: designate report-count-domains [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] Get counts for total domains -h, --help show this help message and exit

usage: designate report-count-records [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] Get counts for total records -h, --help show this help message and exit

usage: designate report-count-tenants [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] Get counts for total tenants -h, --help show this help message and exit

usage: designate report-tenant-domains [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] --report-tenant-id REPORT_TENANT_ID Get a list of domains for given tenant -h, --help show this help message and exit --report-tenant-id REPORT_TENANT_ID The tenant_id being reported on.

usage: designate report-tenants-all [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] Get list of tenants and domain count for each -h, --help show this help message and exit

usage: designate server-create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] --name NAME Create Server -h, --help show this help message and exit --name NAME Server name

usage: designate server-delete [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] id Delete Server id Server ID -h, --help show this help message and exit

usage: designate server-get [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] id Get Server id Server ID -h, --help show this help message and exit

usage: designate server-list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] List Servers -h, --help show this help message and exit

usage: designate server-update [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--name NAME] id Update Server id Server ID -h, --help show this help message and exit --name NAME Server name

usage: designate sync-all [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] Sync Everything -h, --help show this help message and exit

usage: designate sync-domain [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] domain_id Sync a single Domain domain_id Domain ID -h, --help show this help message and exit

usage: designate sync-record [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] domain_id record_id Sync a single Record domain_id Domain ID record_id Record ID -h, --help show this help message and exit

usage: designate touch-domain [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] domain_id Touch a single Domain domain_id Domain ID -h, --help show this help message and exit