Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

Chapter 20. DNS service command-line client

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

20.1. designate usage
Copy link

usage: designate [--version] [-v | -q] [--log-file LOG_FILE] [-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]
Copy to Clipboard Toggle word wrap

20.2. designate optional arguments
Copy link

--version
show program's version number and exit
-v, --verbose
Increase verbosity of output. Can be repeated.
-q, --quiet
Suppress output except warnings and errors.
--log-file LOG_FILE
Specify a file to log output. Disabled by default.
-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.

20.3. designate diagnostics-ping
Copy link

usage: designate diagnostics-ping [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] --service SERVICE --host HOST
Copy to Clipboard Toggle word wrap
Ping a service on a given host

Optional arguments

-h, --help
show this help message and exit
--service SERVICE
Service name (e.g. central)
--host HOST
Hostname

20.4. designate domain-create
Copy link

usage: designate domain-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] --name NAME --email EMAIL [--ttl TTL] [--description DESCRIPTION]
Copy to Clipboard Toggle word wrap
Create Domain

Optional arguments

-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.

20.5. designate domain-delete
Copy link

usage: designate domain-delete [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] id
Copy to Clipboard Toggle word wrap
Delete Domain

Positional arguments

id
Domain ID or name.

Optional arguments

-h, --help
show this help message and exit

20.6. designate domain-get
Copy link

usage: designate domain-get [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] id
Copy to Clipboard Toggle word wrap
Get Domain

Positional arguments

id
Domain ID or name.

Optional arguments

-h, --help
show this help message and exit

20.7. designate domain-list
Copy link

usage: designate domain-list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}]
Copy to Clipboard Toggle word wrap
List Domains

Optional arguments

-h, --help
show this help message and exit

20.8. designate domain-servers-list
Copy link

usage: designate domain-servers-list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] id
Copy to Clipboard Toggle word wrap
List Domain Servers

Positional arguments

id
Domain ID or name.

Optional arguments

-h, --help
show this help message and exit

20.9. designate domain-update
Copy link

usage: designate domain-update [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--name NAME] [--email EMAIL] [--ttl TTL] [--description DESCRIPTION | --no-description] id
Copy to Clipboard Toggle word wrap
Update Domain

Positional arguments

id
Domain ID or name.

Optional arguments

-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

20.10. designate quota-get
Copy link

usage: designate quota-get [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] tenant_id
Copy to Clipboard Toggle word wrap
Get Quota

Positional arguments

tenant_id
Tenant ID

Optional arguments

-h, --help
show this help message and exit

20.11. designate quota-reset
Copy link

usage: designate quota-reset [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] tenant_id
Copy to Clipboard Toggle word wrap
Reset Quota

Positional arguments

tenant_id
Tenant ID.

Optional arguments

-h, --help
show this help message and exit

20.12. designate quota-update
Copy link

usage: designate quota-update [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--domains DOMAINS] [--domain-recordsets DOMAIN_RECORDSETS] [--recordset-records RECORDSET_RECORDS] [--domain-records DOMAIN_RECORDS] [--api-export-size API_EXPORT_SIZE] tenant_id
Copy to Clipboard Toggle word wrap
Update Quota

Positional arguments

tenant_id
Tenant ID.

Optional arguments

-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.
--api-export-size API_EXPORT_SIZE
Allowed zone export recordsets.

20.13. designate record-create
Copy link

usage: designate record-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] --name NAME --type TYPE --data DATA [--ttl TTL] [--priority PRIORITY] [--description DESCRIPTION] domain_id
Copy to Clipboard Toggle word wrap
Create Record

Positional arguments

domain_id
Domain ID or name.

Optional arguments

-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.

20.14. designate record-delete
Copy link

usage: designate record-delete [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] domain_id id
Copy to Clipboard Toggle word wrap
Delete Record

Positional arguments

domain_id
Domain ID or name.
id
Record ID.

Optional arguments

-h, --help
show this help message and exit

20.15. designate record-get
Copy link

usage: designate record-get [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] domain_id id
Copy to Clipboard Toggle word wrap
Get Record

Positional arguments

domain_id
Domain ID or name.
id
Record ID.

Optional arguments

-h, --help
show this help message and exit

20.16. designate record-list
Copy link

usage: designate record-list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] domain_id
Copy to Clipboard Toggle word wrap
List Records

Positional arguments

domain_id
Domain ID or name.

Optional arguments

-h, --help
show this help message and exit

20.17. designate record-update
Copy link

usage: designate record-update [-h] [-f {html,json,json,shell,table,value,yaml,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
Copy to Clipboard Toggle word wrap
Update Record

Positional arguments

domain_id
Domain ID or name.
id
Record ID.

Optional arguments

-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

20.18. designate report-count-all
Copy link

usage: designate report-count-all [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX]
Copy to Clipboard Toggle word wrap
Get count totals for all tenants, domains and records

Optional arguments

-h, --help
show this help message and exit

20.19. designate report-count-domains
Copy link

usage: designate report-count-domains [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX]
Copy to Clipboard Toggle word wrap
Get counts for total domains

Optional arguments

-h, --help
show this help message and exit

20.20. designate report-count-records
Copy link

usage: designate report-count-records [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX]
Copy to Clipboard Toggle word wrap
Get counts for total records

Optional arguments

-h, --help
show this help message and exit

20.21. designate report-count-tenants
Copy link

usage: designate report-count-tenants [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX]
Copy to Clipboard Toggle word wrap
Get counts for total tenants

Optional arguments

-h, --help
show this help message and exit

20.22. designate report-tenant-domains
Copy link

usage: designate report-tenant-domains [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] --report-tenant-id REPORT_TENANT_ID
Copy to Clipboard Toggle word wrap
Get a list of domains for given tenant

Optional arguments

-h, --help
show this help message and exit
--report-tenant-id REPORT_TENANT_ID
The tenant_id being reported on.

20.23. designate report-tenants-all
Copy link

usage: designate report-tenants-all [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}]
Copy to Clipboard Toggle word wrap
Get list of tenants and domain count for each

Optional arguments

-h, --help
show this help message and exit

20.24. designate server-create
Copy link

usage: designate server-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] --name NAME
Copy to Clipboard Toggle word wrap
Create Server

Optional arguments

-h, --help
show this help message and exit
--name NAME
Server name.

20.25. designate server-delete
Copy link

usage: designate server-delete [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] id
Copy to Clipboard Toggle word wrap
Delete Server

Positional arguments

id
Server ID.

Optional arguments

-h, --help
show this help message and exit

20.26. designate server-get
Copy link

usage: designate server-get [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] id
Copy to Clipboard Toggle word wrap
Get Server

Positional arguments

id
Server ID.

Optional arguments

-h, --help
show this help message and exit

20.27. designate server-list
Copy link

usage: designate server-list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}]
Copy to Clipboard Toggle word wrap
List Servers

Optional arguments

-h, --help
show this help message and exit

20.28. designate server-update
Copy link

usage: designate server-update [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--name NAME] id
Copy to Clipboard Toggle word wrap
Update Server

Positional arguments

id
Server ID.

Optional arguments

-h, --help
show this help message and exit
--name NAME
Server name.

20.29. designate sync-all
Copy link

usage: designate sync-all [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX]
Copy to Clipboard Toggle word wrap
Sync Everything

Optional arguments

-h, --help
show this help message and exit

20.30. designate sync-domain
Copy link

usage: designate sync-domain [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] domain_id
Copy to Clipboard Toggle word wrap
Sync a single Domain

Positional arguments

domain_id
Domain ID

Optional arguments

-h, --help
show this help message and exit

20.31. designate sync-record
Copy link

usage: designate sync-record [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] domain_id record_id
Copy to Clipboard Toggle word wrap
Sync a single Record

Positional arguments

domain_id
Domain ID
record_id
Record ID

Optional arguments

-h, --help
show this help message and exit

20.32. designate touch-domain
Copy link

usage: designate touch-domain [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] domain_id
Copy to Clipboard Toggle word wrap
Touch a single Domain

Positional arguments

domain_id
Domain ID

Optional arguments

-h, --help
show this help message and exit
Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat