python-designateclient — Cli commands

CLI commands — python-designateclient — branch stable/2026.2

Branch stable/2026.2 @ 9231eef90192 (7.0.0 + 2 maintenance commits) — repository https://opendev.org/openstack/python-designateclient — analysed on 2026-11-01

python-designateclient exposes no service API. It is a plugin of the openstack command line, plus the Python library that the plugin calls. Its interface is 60 commands and the designateclient.v2.client.Client class. Its contract with the outside is the HTTP requests sent to Designate (see interactions and client contract).

[observed] means seen by running the real openstack shell against the local stub on 127.0.0.1. The stub is not a service: it shows what the client sends and how it reads a response, and says nothing about what a real Designate accepts or returns. [inferred] means not followed to the end. "Read in Designate" means read in the local clone of designate stable/2026.2 @ e3dd774db145, which was never started.

1. Shared mechanics

Plugin loading

• pyproject.toml:39 declares the entry point openstack.cli.extension, dns = "designateclient.osc.plugin". pyproject.toml:42 opens the group openstack.dns.v2, which lists one entry point per command, up to pyproject.toml:102. The entry point designateclient.versions (pyproject.toml:36) serves designateclient.client.Client only (designateclient/client.py:123).
• There is no console script and no legacy designate shell in this repository: pyproject.toml has no project.scripts. The only process is openstack.
• designateclient/osc/plugin.py:33 builds the client from the session, region and interface of the OSC client manager. It passes no endpoint_override and no timeout, so --os-endpoint has no effect on these commands [observed: scenario os-endpoint-ignored].
• --os-dns-api-version, env OS_DNS_API_VERSION, default 2 (designateclient/osc/plugin.py:43). Any other value logs dns API version 1 is not in supported versions: 2 (openstackclient:openstackclient/shell.py:136). The group openstack.dns.v1 is then empty, so the command is unknown and the process exits 2 [observed: api-version-1].
• The DNS API has no microversions in this client: no OpenStack-API-Version header is sent [observed], and no command checks a version. The Designate minor versions (2.1 to 2.4) are not used by the client.

Options common to all commands

Every command has these two options (designateclient/v2/cli/common.py:54). They are left out of the tables below.

Two more exist on some commands only:

zone delete --delete-shares adds X-Designate-Delete-Shares: true, in lower case (designateclient/v2/zones.py:77).

set_all_common_headers (designateclient/v2/cli/common.py:75) copies the options to the adapter, which keeps them. In one process with several commands this has a side effect, see 02 § 4, defect 8.

Name or ID

• resolve_by_name (designateclient/v2/utils.py:24) returns a UUID-like argument unchanged. Otherwise it lists with ?name=<argument>, and needs exactly one result.
  • 0 results: NotFound, Name <x> didn't resolve (designateclient/v2/utils.py:38).
  • Several: NoUniqueMatch, see 02 § 4, defect 4.
• It applies to zones (every command taking a zone), recordsets, TLDs and TSIG keys. The help says "Zone ID" on most commands, yet names work [observed: name-zone-show].
• It does not apply to blacklists, transfer requests, transfer accepts, exports, imports, shares, service statuses or floating IPs: the argument goes in the path as it is [observed: name-blacklist-not-resolved].
• A recordset name is resolved in its zone with the name as given, so it must be the full name. recordset show <zone> www fails with Name www didn't resolve when the service filters exactly [observed with a chosen answer: name-recordset-relative]. Only recordset create completes relative names (designateclient/v2/recordsets.py:35).

Lists

• get_all (designateclient/v2/utils.py:56) follows links.next until it is absent, re-sending every query parameter found in that URL [observed: pagination-two-pages]. There is no --limit or --marker option: a list command always reads all pages.
• resolve_by_name calls the list method directly, so it reads the first page only (designateclient/v2/utils.py:32).
• Rows are built by get_item_properties (designateclient/utils.py:24). A missing column shows as empty, a None as an empty cell [observed: list-rows-without-columns].
• --all-projects adds a project_id column on zone list and zone share list (designateclient/v2/cli/zones.py:108, designateclient/v2/cli/zones.py:915). On recordset list the column also needs a first row holding that key (designateclient/v2/cli/recordsets.py:115).

Single objects

• Most ShowOne commands end with zip(*sorted(data.items())). Rows are sorted by key. An empty object breaks the unpacking in cliff (cliff:cliff/display.py:160) [observed: quota-empty-object].
• zone share create and zone share show use dict2columns (designateclient/v2/cli/zones.py:877), which accepts an empty object (cliff:cliff/show.py:64).
• The _format_* helpers remove links before display: zones, recordsets, blacklists, TLDs, TSIG keys, floating IPs, service statuses, exports and imports. The transfer and quota commands do not call one (designateclient/v2/cli/zones.py:394), so links shows up there as a row [observed: transfer-show-links, transfer-accept-show-links].

Outputs that print secrets

tsigkey list and tsigkey show print secret; zone transfer request list and show print key (designateclient/v2/cli/tsigkeys.py:36, designateclient/v2/cli/zones.py:400) [observed: tsigkey-list-secret]. tsigkey create --secret also puts the secret on the command line (designateclient/v2/cli/tsigkeys.py:97).

2. Functional description by family

Zones

A zone is the unit of DNS delegation owned by a project. The commands record an intent: Designate answers 202 with status: PENDING, then its workers update the status later (read in Designate: designate:designate/api/v2/controllers/zones/__init__.py:114). No command waits or polls: the operator re-runs zone show (05).

• **zone create**: --type defaults to PRIMARY. PRIMARY needs --email, refused before any request (designateclient/v2/cli/zones.py:180), and may have --ttl. SECONDARY sends --masters without checking that it is set (designateclient/v2/cli/zones.py:191). Options that do not apply to the type are dropped without a message: --masters on PRIMARY, --email and --ttl on SECONDARY [observed: zone-create-primary-masters, zone-create-secondary-masters].
• **--attributes k:v** splits on : and needs exactly one (designateclient/v2/cli/zones.py:170).
• **zone set**: PATCH with only the given fields; --no-description sends null. With no option at all it still sends {} [observed: zone-set-nothing]. See defect 2 for --ttl 0.
• **zone delete**: reads the deleted zone in the response and shows it (designateclient/v2/cli/zones.py:275).
• **zone abandon**, **zone axfr**, **zone move**: POST on /zones/{id}/tasks/...; print nothing. zone move without --pool-id sends {} [observed: zone-move-no-pool].
• **zone nameservers list**: the name servers of the zone's pool.

Recordsets

A recordset is all the records of one name and type in a zone.

• **recordset create**: --record is repeatable and required, --type required. Neither is normalised: --type a goes out as a [observed: recordset-create-fqdn].
• Relative names: a name not ending in . is completed from the zone, which costs a GET /zones/{id} (designateclient/v2/recordsets.py:35) [observed: recordset-create-relative]. A zone given by name costs a lookup too, and a fully qualified name with a zone UUID costs nothing [observed: recordset-create-zone-name, recordset-create-fqdn].
• **recordset list <zone>|all**: the literal all uses GET /recordsets and adds a zone_name column (designateclient/v2/cli/recordsets.py:107) [observed: recordset-list-all]. records shows one per line.
• **recordset set: **PUT, not PATCH (designateclient/v2/recordsets.py:94), with only the given fields. --no-ttl and --no-description send null [observed: recordset-set-no-ttl].
• **recordset delete**: shows the deleted recordset.

Zone transfers

Moving a zone to another project takes two steps and two projects: the owner creates a request and passes its id and key to the recipient, who accepts it.

• **zone transfer request create**: without --target-project-id it sends target_project_id: null [observed: transfer-create-no-target].
• **zone transfer accept request --transfer-id --key**: both required; POST with key and zone_transfer_request_id (designateclient/v2/zones.py:138).

Zone exports and imports

• Export: zone export create starts it; zone export show follows its status; zone export showfile fetches the text with Accept: text/dns (designateclient/v2/zones.py:173) [observed: hdr-export-accept].
• Import: zone import create <file> reads a local file. Without --attributes, the raw text goes as text/dns. With it, a JSON object {zonefile, attributes} (designateclient/v2/zones.py:179) [observed: import-plain, import-attributes]. Read in Designate, the JSON form exists since API 2.4 (designate:designate/api/v2/controllers/zones/tasks/imports.py:79).

Zone shares

zone share create|list|show|delete give another project access to a zone (Designate API 2.1, designate:designate/api/versions.py:54). The zone may be a name. zone delete --delete-shares removes them with the zone.

PTR records

ptr record list|show|set|unset handle the reverse DNS of floating IPs. The identifier is region:floatingip_id, sent with a raw colon in the path [observed]. unset sends {"ptrdname": null} (designateclient/v2/reverse.py:44). See defect 1 on set.

Administration

• Blacklists forbid zone names by pattern; TLDs declare the allowed top-level domains; TSIG keys hold the keys of pools or zones (--scope, --resource-id).
• **dns service list|show** show the state of Designate's processes. --service_name has an underscore, unlike every other option (designateclient/v2/cli/service_statuses.py:47).
• **dns quota list|set|reset** target the current project, or --project-id; see defects 6 and 7.
• **dns limit list** shows the two columns Limit and Value, one row per key of the response (designateclient/v2/cli/limits.py:34).

3. The Python API the commands rely on

The commands only call designateclient/v2/client.py:122 and its controllers.

Other projects call this API directly, see 03 § Python API users.

4. The 60 commands

Summary

5. Command sheets

Arguments, requests and response needs per command. The requests come from the probe, which passes UUIDs and synthetic values, so name lookups do not appear here; they are in § 1. The purpose line is the class docstring.

Zones

openstack zone abandon

Abandon a zone. Class AbandonZoneCommand at designateclient/v2/cli/zones.py:302; output: none.

• Requests with a UUID argument [observed]: POST /zones/{id}/tasks/abandon. Controller: /zones/{id}/tasks/abandon designateclient/v2/zones.py:89.
• The response must hold: nothing is read.
• Exit code on the stub [observed]: 404 mode 1, {} mode 0, fixture mode 0. Unit vectors: 0.

openstack zone axfr

AXFR a zone. Class AXFRZoneCommand at designateclient/v2/cli/zones.py:323; output: none.

• Requests with a UUID argument [observed]: POST /zones/{id}/tasks/xfr. Controller: /zones/{id}/tasks/xfr designateclient/v2/zones.py:96.
• The response must hold: nothing is read.
• Exit code on the stub [observed]: 404 mode 1, {} mode 0, fixture mode 0. Unit vectors: 0.

openstack zone create

Create new zone. Class CreateZoneCommand at designateclient/v2/cli/zones.py:136; output: single.

• Requests with a UUID argument [observed]: POST /zones. Controller: /zones designateclient/v2/zones.py:46.
• Body with the probe's synthetic arguments [observed]: {"name": "x", "type": "PRIMARY", "email": "a@example.org"}
• The response must hold: object with masters (list) and attributes (object) (designateclient/v2/cli/zones.py:30).
• Exit code on the stub [observed]: 404 mode 1, {} mode 1, fixture mode 0. Unit vectors: 2.

openstack zone delete

Delete zone. Class DeleteZoneCommand at designateclient/v2/cli/zones.py:250; output: single.

• Requests with a UUID argument [observed]: DELETE /zones/{id}. Controller: /zones/{id} designateclient/v2/zones.py:78, /zones/{id} designateclient/v2/zones.py:80.
• The response must hold: object with masters (list) and attributes (object) (designateclient/v2/cli/zones.py:30).
• Exit code on the stub [observed]: 404 mode 1, {} mode 1, fixture mode 0. Unit vectors: 0.

openstack zone list

List zones. Class ListZonesCommand at designateclient/v2/cli/zones.py:47; output: list.

• Requests with a UUID argument [observed]: GET /zones. Controller: /zones designateclient/v2/zones.py:51.
• The response must hold: zones (list) (designateclient/v2/zones.py:51).
• Exit code on the stub [observed]: 404 mode 1, {} mode 1, fixture mode 0. Unit vectors: 2.

openstack zone move

Move a zone to another pool. Class PoolMoveZoneCommand at designateclient/v2/cli/zones.py:344; output: none.

• Requests with a UUID argument [observed]: POST /zones/{id}/tasks/pool_move. Controller: /zones/{id}/tasks/pool_move designateclient/v2/zones.py:103.
• Body with the probe's synthetic arguments [observed]: {}
• The response must hold: nothing is read.
• Exit code on the stub [observed]: 404 mode 1, {} mode 0, fixture mode 0. Unit vectors: 0.

openstack zone nameservers list

List Zone Nameservers. Class ListZoneNameserversCommand at designateclient/v2/cli/zones.py:279; output: list.

• Requests with a UUID argument [observed]: GET /zones/{id}/nameservers. Controller: /zones/{id}/nameservers designateclient/v2/zones.py:61.
• The response must hold: nameservers (list) (designateclient/v2/zones.py:62).
• Exit code on the stub [observed]: 404 mode 1, {} mode 1, fixture mode 0. Unit vectors: 0.

openstack zone set

Set zone properties. Class SetZoneCommand at designateclient/v2/cli/zones.py:205; output: single.

• Requests with a UUID argument [observed]: PATCH /zones/{id}. Controller: /zones/{id} designateclient/v2/zones.py:69.
• Body with the probe's synthetic arguments [observed]: {}
• The response must hold: object with masters (list) and attributes (object) (designateclient/v2/cli/zones.py:30).
• Exit code on the stub [observed]: 404 mode 1, {} mode 1, fixture mode 0. Unit vectors: 0.

openstack zone show

Show zone details. Class ShowZoneCommand at designateclient/v2/cli/zones.py:114; output: single.

• Requests with a UUID argument [observed]: GET /zones/{id}. Controller: /zones/{id} designateclient/v2/zones.py:56.
• The response must hold: object with masters (list) and attributes (object) (designateclient/v2/cli/zones.py:30).
• Exit code on the stub [observed]: 404 mode 1, {} mode 1, fixture mode 0. Unit vectors: 0.

Zone blacklists

openstack zone blacklist create

Create new blacklist. Class CreateBlacklistCommand at designateclient/v2/cli/blacklists.py:82; output: single.

• Requests with a UUID argument [observed]: POST /blacklists. Controller: /blacklists designateclient/v2/blacklists.py:28.
• Body with the probe's synthetic arguments [observed]: {"pattern": "x"}
• The response must hold: non-empty object (an empty one fails in zip(*sorted(...))).
• Exit code on the stub [observed]: 404 mode 1, {} mode 1, fixture mode 0. Unit vectors: 0.

openstack zone blacklist delete

Delete blacklist. Class DeleteBlacklistCommand at designateclient/v2/cli/blacklists.py:144; output: none.

• Requests with a UUID argument [observed]: DELETE /blacklists/{id}. Controller: /blacklists/{id} designateclient/v2/blacklists.py:48.
• The response must hold: nothing is read.
• Exit code on the stub [observed]: 404 mode 1, {} mode 0, fixture mode 0. Unit vectors: 0.

openstack zone blacklist list

List blacklists. Class ListBlacklistsCommand at designateclient/v2/cli/blacklists.py:34; output: list.

• Requests with a UUID argument [observed]: GET /blacklists. Controller: /blacklists designateclient/v2/blacklists.py:33.
• The response must hold: blacklists (list) (designateclient/v2/blacklists.py:33).
• Exit code on the stub [observed]: 404 mode 1, {} mode 1, fixture mode 0. Unit vectors: 0.

openstack zone blacklist set

Set blacklist properties. Class SetBlacklistCommand at designateclient/v2/cli/blacklists.py:107; output: single.

• Requests with a UUID argument [observed]: PATCH /blacklists/{id}. Controller: /blacklists/{id} designateclient/v2/blacklists.py:43.
• Body with the probe's synthetic arguments [observed]: {}
• The response must hold: non-empty object (an empty one fails in zip(*sorted(...))).
• Exit code on the stub [observed]: 404 mode 1, {} mode 1, fixture mode 0. Unit vectors: 0.

openstack zone blacklist show

Show blacklist details. Class ShowBlacklistCommand at designateclient/v2/cli/blacklists.py:62; output: single.

• Requests with a UUID argument [observed]: GET /blacklists/{id}. Controller: /blacklists/{id} designateclient/v2/blacklists.py:38.
• The response must hold: non-empty object (an empty one fails in zip(*sorted(...))).
• Exit code on the stub [observed]: 404 mode 1, {} mode 1, fixture mode 0. Unit vectors: 0.

Zone exports

openstack zone export create

Export a Zone. Class ExportZoneCommand at designateclient/v2/cli/zones.py:585; output: single.

• Requests with a UUID argument [observed]: POST /zones/{id}/tasks/export. Controller: /zones/{id}/tasks/export designateclient/v2/zones.py:161.
• The response must hold: non-empty object with id (designateclient/v2/cli/zones.py:605).
• Exit code on the stub [observed]: 404 mode 1, {} mode 1, fixture mode 0. Unit vectors: 0.

openstack zone export delete

Delete a Zone Export. Class DeleteZoneExportCommand at designateclient/v2/cli/zones.py:672; output: none.

• Requests with a UUID argument [observed]: DELETE /zones/tasks/exports/{id}. Controller: /zones/tasks/exports/{id} designateclient/v2/zones.py:171.
• The response must hold: nothing is read.
• Exit code on the stub [observed]: 404 mode 1, {} mode 0, fixture mode 0. Unit vectors: 0.

openstack zone export list

List Zone Exports. Class ListZoneExportsCommand at designateclient/v2/cli/zones.py:610; output: list.

• Requests with a UUID argument [observed]: GET /zones/tasks/exports. Controller: /zones/tasks/exports designateclient/v2/zones.py:168.
• The response must hold: exports (list) (designateclient/v2/zones.py:168).
• Exit code on the stub [observed]: 404 mode 1, {} mode 1, fixture mode 0. Unit vectors: 0.

openstack zone export show

Show a Zone Export. Class ShowZoneExportCommand at designateclient/v2/cli/zones.py:648; output: single.

• Requests with a UUID argument [observed]: GET /zones/tasks/exports/{id}. Controller: /zones/tasks/exports/{id} designateclient/v2/zones.py:164.
• The response must hold: non-empty object (an empty one fails in zip(*sorted(...))).
• Exit code on the stub [observed]: 404 mode 1, {} mode 1, fixture mode 0. Unit vectors: 0.

openstack zone export showfile

Show the zone file for the Zone Export. Class ShowZoneExportFileCommand at designateclient/v2/cli/zones.py:694; output: single.

• Requests with a UUID argument [observed]: GET /zones/tasks/exports/{id}/export. Controller: /zones/tasks/exports/{id}/export designateclient/v2/zones.py:174.
• The response must hold: any body; shown as is (designateclient/v2/cli/zones.py:713).
• Exit code on the stub [observed]: 404 mode 1, {} mode 0, fixture mode 0. Unit vectors: 0.

Zone imports

openstack zone import create

Import a Zone from a file on the filesystem. Class ImportZoneCommand at designateclient/v2/cli/zones.py:716; output: single.

• Requests with a UUID argument [observed]: POST /zones/tasks/imports. Controller: /zones/tasks/imports designateclient/v2/zones.py:190.
• Body with the probe's synthetic arguments [observed]: $ORIGIN example.org. $TTL 300 example.org. IN SOA ns1.example.org. a.example.org. 1 2 3 4 5
• The response must hold: non-empty object with id (designateclient/v2/cli/zones.py:755).
• Exit code on the stub [observed]: 404 mode 1, {} mode 1, fixture mode 0. Unit vectors: 0.

openstack zone import delete

Delete a Zone Import. Class DeleteZoneImportCommand at designateclient/v2/cli/zones.py:827; output: none.

• Requests with a UUID argument [observed]: DELETE /zones/tasks/imports/{id}. Controller: /zones/tasks/imports/{id} designateclient/v2/zones.py:201.
• The response must hold: nothing is read.
• Exit code on the stub [observed]: 404 mode 1, {} mode 0, fixture mode 0. Unit vectors: 0.

openstack zone import list

List Zone Imports. Class ListZoneImportsCommand at designateclient/v2/cli/zones.py:760; output: list.

• Requests with a UUID argument [observed]: GET /zones/tasks/imports. Controller: /zones/tasks/imports designateclient/v2/zones.py:198.
• The response must hold: imports (list) (designateclient/v2/zones.py:198).
• Exit code on the stub [observed]: 404 mode 1, {} mode 1, fixture mode 0. Unit vectors: 0.

openstack zone import show

Show a Zone Import. Class ShowZoneImportCommand at designateclient/v2/cli/zones.py:803; output: single.

• Requests with a UUID argument [observed]: GET /zones/tasks/imports/{id}. Controller: /zones/tasks/imports/{id} designateclient/v2/zones.py:194.
• The response must hold: non-empty object (an empty one fails in zip(*sorted(...))).
• Exit code on the stub [observed]: 404 mode 1, {} mode 1, fixture mode 0. Unit vectors: 0.

Zone transfers

openstack zone transfer accept list

List Zone Transfer Accepts. Class ListTransferAcceptsCommand at designateclient/v2/cli/zones.py:532; output: list.

• Requests with a UUID argument [observed]: GET /zones/tasks/transfer_accepts. Controller: /zones/tasks/transfer_accepts designateclient/v2/zones.py:154.
• The response must hold: transfer_accepts (list) (designateclient/v2/zones.py:154).
• Exit code on the stub [observed]: 404 mode 1, {} mode 1, fixture mode 0. Unit vectors: 0.

openstack zone transfer accept request

Accept a Zone Transfer Request. Class AcceptTransferRequestCommand at designateclient/v2/cli/zones.py:507; output: single.

• Requests with a UUID argument [observed]: POST /zones/tasks/transfer_accepts. Controller: /zones/tasks/transfer_accepts designateclient/v2/zones.py:145.
• Body with the probe's synthetic arguments [observed]: {"key": "x", "zone_transfer_request_id": "11111111-2222-4333-8444-555555555555"}
• The response must hold: non-empty object (an empty one fails in zip(*sorted(...))).
• Exit code on the stub [observed]: 404 mode 1, {} mode 1, fixture mode 0. Unit vectors: 0.

openstack zone transfer accept show

Show Zone Transfer Accept. Class ShowTransferAcceptCommand at designateclient/v2/cli/zones.py:564; output: single.

• Requests with a UUID argument [observed]: GET /zones/tasks/transfer_accepts/{id}. Controller: /zones/tasks/transfer_accepts/{id} designateclient/v2/zones.py:149.
• The response must hold: non-empty object (an empty one fails in zip(*sorted(...))).
• Exit code on the stub [observed]: 404 mode 1, {} mode 1, fixture mode 0. Unit vectors: 0.

openstack zone transfer request create

Create new zone transfer request. Class CreateTransferRequestCommand at designateclient/v2/cli/zones.py:370; output: single.

• Requests with a UUID argument [observed]: POST /zones/{id}/tasks/transfer_requests. Controller: /zones/{id}/tasks/transfer_requests designateclient/v2/zones.py:119.
• Body with the probe's synthetic arguments [observed]: {"target_project_id": null}
• The response must hold: non-empty object (an empty one fails in zip(*sorted(...))).
• Exit code on the stub [observed]: 404 mode 1, {} mode 1, fixture mode 0. Unit vectors: 0.

openstack zone transfer request delete

Delete a Zone Transfer Request. Class DeleteTransferRequestCommand at designateclient/v2/cli/zones.py:486; output: none.

• Requests with a UUID argument [observed]: DELETE /zones/tasks/transfer_requests/{id}. Controller: /zones/tasks/transfer_requests/{id} designateclient/v2/zones.py:136.
• The response must hold: nothing is read.
• Exit code on the stub [observed]: 404 mode 1, {} mode 0, fixture mode 0. Unit vectors: 0.

openstack zone transfer request list

List Zone Transfer Requests. Class ListTransferRequestsCommand at designateclient/v2/cli/zones.py:397; output: list.

• Requests with a UUID argument [observed]: GET /zones/tasks/transfer_requests. Controller: /zones/tasks/transfer_requests designateclient/v2/zones.py:128.
• The response must hold: transfer_requests (list) (designateclient/v2/zones.py:128).
• Exit code on the stub [observed]: 404 mode 1, {} mode 1, fixture mode 0. Unit vectors: 0.

openstack zone transfer request set

Set a Zone Transfer Request. Class SetTransferRequestCommand at designateclient/v2/cli/zones.py:449; output: single.

• Requests with a UUID argument [observed]: PATCH /zones/tasks/transfer_requests/{id}. Controller: /zones/tasks/transfer_requests/{id} designateclient/v2/zones.py:132.
• Body with the probe's synthetic arguments [observed]: {}
• The response must hold: non-empty object (an empty one fails in zip(*sorted(...))).
• Exit code on the stub [observed]: 404 mode 1, {} mode 1, fixture mode 0. Unit vectors: 0.

openstack zone transfer request show

Show Zone Transfer Request Details. Class ShowTransferRequestCommand at designateclient/v2/cli/zones.py:428; output: single.

• Requests with a UUID argument [observed]: GET /zones/tasks/transfer_requests/{id}. Controller: /zones/tasks/transfer_requests/{id} designateclient/v2/zones.py:123.
• The response must hold: non-empty object (an empty one fails in zip(*sorted(...))).
• Exit code on the stub [observed]: 404 mode 1, {} mode 1, fixture mode 0. Unit vectors: 0.

Zone shares

openstack zone share create

Share a Zone. Class ShareZoneCommand at designateclient/v2/cli/zones.py:849; output: single.

• Requests with a UUID argument [observed]: POST /zones/{id}/shares. Controller: /zones/{id}/shares designateclient/v2/zones.py:210.
• Body with the probe's synthetic arguments [observed]: {"target_project_id": "11111111-2222-4333-8444-555555555555"}
• The response must hold: object with id (designateclient/v2/cli/zones.py:873).
• Exit code on the stub [observed]: 404 mode 1, {} mode 1, fixture mode 0. Unit vectors: 0.

openstack zone share delete

Delete a Zone Share. Class DeleteSharedZoneCommand at designateclient/v2/cli/zones.py:946; output: none.

• Requests with a UUID argument [observed]: DELETE /zones/{id}/shares/{id}. Controller: /zones/{id}/shares/{id} designateclient/v2/zones.py:222.
• The response must hold: nothing is read.
• Exit code on the stub [observed]: 404 mode 1, {} mode 0, fixture mode 0. Unit vectors: 0.

openstack zone share list

List Zone Shares. Class ListSharedZonesCommand at designateclient/v2/cli/zones.py:880; output: list.

• Requests with a UUID argument [observed]: GET /zones/{id}/shares. Controller: /zones/{id}/shares designateclient/v2/zones.py:217.
• The response must hold: shared_zones (list) (designateclient/v2/zones.py:217).
• Exit code on the stub [observed]: 404 mode 1, {} mode 1, fixture mode 0. Unit vectors: 0.

openstack zone share show

Show Zone Share Details. Class ShowSharedZoneCommand at designateclient/v2/cli/zones.py:921; output: single.

• Requests with a UUID argument [observed]: GET /zones/{id}/shares/{id}. Controller: /zones/{id}/shares/{id} designateclient/v2/zones.py:227.
• The response must hold: object; empty allowed (designateclient/v2/cli/zones.py:943).
• Exit code on the stub [observed]: 404 mode 1, {} mode 0, fixture mode 0. Unit vectors: 0.

Recordsets

openstack recordset create

Create new recordset. Class CreateRecordSetCommand at designateclient/v2/cli/recordsets.py:149; output: single.

• Requests with a UUID argument [observed]: GET /zones/{id}; POST /zones/{id}/recordsets. Controller: /zones/{id}/recordsets designateclient/v2/recordsets.py:64.
• Body with the probe's synthetic arguments [observed]: {"name": "x.example.org.", "type": "x", "records": ["x"]}
• The response must hold: object with records (list) (designateclient/v2/cli/recordsets.py:29).
• Exit code on the stub [observed]: 404 mode 1, {} mode 1, fixture mode 0. Unit vectors: 1.

openstack recordset delete

Delete recordset. Class DeleteRecordSetCommand at designateclient/v2/cli/recordsets.py:242; output: single.

• Requests with a UUID argument [observed]: DELETE /zones/{id}/recordsets/{id}. Controller: /zones/{id}/recordsets/{id} designateclient/v2/recordsets.py:102.
• The response must hold: object with records (list) (designateclient/v2/cli/recordsets.py:29).
• Exit code on the stub [observed]: 404 mode 1, {} mode 1, fixture mode 0. Unit vectors: 0.

openstack recordset list

List recordsets. Class ListRecordSetsCommand at designateclient/v2/cli/recordsets.py:44; output: list.

• Requests with a UUID argument [observed]: GET /zones/{id}/recordsets. Controller: /recordsets designateclient/v2/recordsets.py:78, /zones/{id}/recordsets designateclient/v2/recordsets.py:73.
• The response must hold: recordsets (list), each with records (designateclient/v2/recordsets.py:73).
• Exit code on the stub [observed]: 404 mode 1, {} mode 1, fixture mode 0. Unit vectors: 3.

openstack recordset set

Set recordset properties. Class SetRecordSetCommand at designateclient/v2/cli/recordsets.py:186; output: single.

• Requests with a UUID argument [observed]: PUT /zones/{id}/recordsets/{id}. Controller: /zones/{id}/recordsets/{id} designateclient/v2/recordsets.py:94.
• Body with the probe's synthetic arguments [observed]: {}
• The response must hold: object with records (list) (designateclient/v2/cli/recordsets.py:29).
• Exit code on the stub [observed]: 404 mode 1, {} mode 1, fixture mode 0. Unit vectors: 0.

openstack recordset show

Show recordset details. Class ShowRecordSetCommand at designateclient/v2/cli/recordsets.py:127; output: single.

• Requests with a UUID argument [observed]: GET /zones/{id}/recordsets/{id}. Controller: /zones/{id}/recordsets/{id} designateclient/v2/recordsets.py:86.
• The response must hold: object with records (list) (designateclient/v2/cli/recordsets.py:29).
• Exit code on the stub [observed]: 404 mode 1, {} mode 1, fixture mode 0. Unit vectors: 0.

PTR records of floating IPs

openstack ptr record list

List floating IP ptr records. Class ListFloatingIPCommand at designateclient/v2/cli/reverse.py:34; output: list.

• Requests with a UUID argument [observed]: GET /reverse/floatingips. Controller: /reverse/floatingips designateclient/v2/reverse.py:37.
• The response must hold: floatingips (list) (designateclient/v2/reverse.py:37).
• Exit code on the stub [observed]: 404 mode 1, {} mode 1, fixture mode 0. Unit vectors: 0.

openstack ptr record set

Set floating IP ptr record. Class SetFloatingIPCommand at designateclient/v2/cli/reverse.py:76; output: single.

• Requests with a UUID argument [observed]: PATCH /reverse/floatingips/{id}. Controller: /reverse/floatingips/{id} designateclient/v2/reverse.py:32.
• Body with the probe's synthetic arguments [observed]: {"ptrdname": "x"}
• The response must hold: non-empty object (an empty one fails in zip(*sorted(...))).
• Exit code on the stub [observed]: 404 mode 1, {} mode 1, fixture mode 0. Unit vectors: 0.

openstack ptr record show

Show floating IP ptr record details. Class ShowFloatingIPCommand at designateclient/v2/cli/reverse.py:55; output: single.

• Requests with a UUID argument [observed]: GET /reverse/floatingips/{id}. Controller: /reverse/floatingips/{id} designateclient/v2/reverse.py:42.
• The response must hold: non-empty object (an empty one fails in zip(*sorted(...))).
• Exit code on the stub [observed]: 404 mode 1, {} mode 1, fixture mode 0. Unit vectors: 0.

openstack ptr record unset

Unset floating IP ptr record. Class UnsetFloatingIPCommand at designateclient/v2/cli/reverse.py:124; output: none.

• Requests with a UUID argument [observed]: PATCH /reverse/floatingips/{id}. Controller: /reverse/floatingips/{id} designateclient/v2/reverse.py:49.
• Body with the probe's synthetic arguments [observed]: {"ptrdname": null}
• The response must hold: nothing is read.
• Exit code on the stub [observed]: 404 mode 1, {} mode 0, fixture mode 0. Unit vectors: 0.

TLDs

openstack tld create

Create new tld. Class CreateTLDCommand at designateclient/v2/cli/tlds.py:82; output: single.

• Requests with a UUID argument [observed]: POST /tlds. Controller: /tlds designateclient/v2/tlds.py:29.
• Body with the probe's synthetic arguments [observed]: {"name": "x"}
• The response must hold: non-empty object (an empty one fails in zip(*sorted(...))).
• Exit code on the stub [observed]: 404 mode 1, {} mode 1, fixture mode 0. Unit vectors: 0.

openstack tld delete

Delete tld. Class DeleteTLDCommand at designateclient/v2/cli/tlds.py:138; output: none.

• Requests with a UUID argument [observed]: DELETE /tlds/{id}. Controller: /tlds/{id} designateclient/v2/tlds.py:49.
• The response must hold: nothing is read.
• Exit code on the stub [observed]: 404 mode 1, {} mode 0, fixture mode 0. Unit vectors: 0.

openstack tld list

List tlds. Class ListTLDsCommand at designateclient/v2/cli/tlds.py:34; output: list.

• Requests with a UUID argument [observed]: GET /tlds. Controller: /tlds designateclient/v2/tlds.py:34.
• The response must hold: tlds (list) (designateclient/v2/tlds.py:34).
• Exit code on the stub [observed]: 404 mode 1, {} mode 1, fixture mode 0. Unit vectors: 2.

openstack tld set

Set tld properties. Class SetTLDCommand at designateclient/v2/cli/tlds.py:103; output: single.

• Requests with a UUID argument [observed]: PATCH /tlds/{id}. Controller: /tlds/{id} designateclient/v2/tlds.py:44.
• Body with the probe's synthetic arguments [observed]: {}
• The response must hold: non-empty object (an empty one fails in zip(*sorted(...))).
• Exit code on the stub [observed]: 404 mode 1, {} mode 1, fixture mode 0. Unit vectors: 0.

openstack tld show

Show tld details. Class ShowTLDCommand at designateclient/v2/cli/tlds.py:62; output: single.

• Requests with a UUID argument [observed]: GET /tlds/{id}. Controller: /tlds/{id} designateclient/v2/tlds.py:39.
• The response must hold: non-empty object (an empty one fails in zip(*sorted(...))).
• Exit code on the stub [observed]: 404 mode 1, {} mode 1, fixture mode 0. Unit vectors: 0.

TSIG keys

openstack tsigkey create

Create new tsigkey. Class CreateTSIGKeyCommand at designateclient/v2/cli/tsigkeys.py:88; output: single.

• Requests with a UUID argument [observed]: POST /tsigkeys. Controller: /tsigkeys designateclient/v2/tsigkeys.py:30.
• Body with the probe's synthetic arguments [observed]: {"name": "x", "algorithm": "x", "secret": "x", "scope": "x", "resource_id": "11111111-2222-4333-8444-555555555555"}
• The response must hold: non-empty object (an empty one fails in zip(*sorted(...))).
• Exit code on the stub [observed]: 404 mode 1, {} mode 1, fixture mode 0. Unit vectors: 0.

openstack tsigkey delete

Delete tsigkey. Class DeleteTSIGKeyCommand at designateclient/v2/cli/tsigkeys.py:152; output: none.

• Requests with a UUID argument [observed]: DELETE /tsigkeys/{id}. Controller: /tsigkeys/{id} designateclient/v2/tsigkeys.py:50.
• The response must hold: nothing is read.
• Exit code on the stub [observed]: 404 mode 1, {} mode 0, fixture mode 0. Unit vectors: 0.

openstack tsigkey list

List tsigkeys. Class ListTSIGKeysCommand at designateclient/v2/cli/tsigkeys.py:33; output: list.

• Requests with a UUID argument [observed]: GET /tsigkeys. Controller: /tsigkeys designateclient/v2/tsigkeys.py:35.
• The response must hold: tsigkeys (list) (designateclient/v2/tsigkeys.py:35).
• Exit code on the stub [observed]: 404 mode 1, {} mode 1, fixture mode 0. Unit vectors: 0.

openstack tsigkey set

Set tsigkey properties. Class SetTSIGKeyCommand at designateclient/v2/cli/tsigkeys.py:116; output: single.

• Requests with a UUID argument [observed]: PATCH /tsigkeys/{id}. Controller: /tsigkeys/{id} designateclient/v2/tsigkeys.py:45.
• Body with the probe's synthetic arguments [observed]: {}
• The response must hold: non-empty object (an empty one fails in zip(*sorted(...))).
• Exit code on the stub [observed]: 404 mode 1, {} mode 1, fixture mode 0. Unit vectors: 0.

openstack tsigkey show

Show tsigkey details. Class ShowTSIGKeyCommand at designateclient/v2/cli/tsigkeys.py:68; output: single.

• Requests with a UUID argument [observed]: GET /tsigkeys/{id}. Controller: /tsigkeys/{id} designateclient/v2/tsigkeys.py:40.
• The response must hold: non-empty object (an empty one fails in zip(*sorted(...))).
• Exit code on the stub [observed]: 404 mode 1, {} mode 1, fixture mode 0. Unit vectors: 0.

Service statuses, quotas and limits

openstack dns limit list

List DNS limits. Class ListLimitsCommand at designateclient/v2/cli/limits.py:18; output: list.

• Requests with a UUID argument [observed]: GET /limits. Controller: /limits designateclient/v2/limits.py:21.
• The response must hold: object (any keys) (designateclient/v2/cli/limits.py:34).
• Exit code on the stub [observed]: 404 mode 1, {} mode 0, fixture mode 0. Unit vectors: 0.

openstack dns quota list

List quotas. Class ListQuotasCommand at designateclient/v2/cli/quotas.py:36; output: single.

• Requests with a UUID argument [observed]: GET /quotas/{id}. Controller: /quotas designateclient/v2/quotas.py:22, /quotas/{id} designateclient/v2/quotas.py:23.
• The response must hold: non-empty object (an empty one fails in zip(*sorted(...))).
• Exit code on the stub [observed]: 404 mode 1, {} mode 1, fixture mode 0. Unit vectors: 0.

openstack dns quota reset

Reset quotas. Class ResetQuotasCommand at designateclient/v2/cli/quotas.py:110; output: none.

• Requests with a UUID argument [observed]: DELETE /quotas/{id}. Controller: /quotas/{id} designateclient/v2/quotas.py:29.
• The response must hold: nothing is read.
• Exit code on the stub [observed]: 404 mode 1, {} mode 0, fixture mode 0. Unit vectors: 0.

openstack dns quota set

Set quotas. Class SetQuotasCommand at designateclient/v2/cli/quotas.py:66; output: single.

• Requests with a UUID argument [observed]: PATCH /quotas/{id}. Controller: /quotas/{id} designateclient/v2/quotas.py:26.
• Body with the probe's synthetic arguments [observed]: {}
• The response must hold: non-empty object (an empty one fails in zip(*sorted(...))).
• Exit code on the stub [observed]: 404 mode 1, {} mode 1, fixture mode 0. Unit vectors: 0.

openstack dns service list

List service statuses. Class ListServiceStatusesCommand at designateclient/v2/cli/service_statuses.py:37; output: list.

• Requests with a UUID argument [observed]: GET /service_statuses. Controller: /service_statuses designateclient/v2/service_statuses.py:23.
• The response must hold: service_statuses (list), each with capabilities and stats (designateclient/v2/service_statuses.py:23).
• Exit code on the stub [observed]: 404 mode 1, {} mode 1, fixture mode 0. Unit vectors: 0.

openstack dns service show

Show service status details. Class ShowServiceStatusCommand at designateclient/v2/cli/service_statuses.py:75; output: single.

• Requests with a UUID argument [observed]: GET /service_statuses/{id}. Controller: /service_statuses/{id} designateclient/v2/service_statuses.py:28.
• The response must hold: object with capabilities and stats (designateclient/v2/cli/service_statuses.py:29).
• Exit code on the stub [observed]: 404 mode 1, {} mode 1, fixture mode 0. Unit vectors: 0.

Source: reverse-spec-python-designateclient/01-cli-commands_stable-2026.2.md. The _rewrite/ and _inventory/ files are not published on the site.