orca zone

Manage Designate zones.

The reference below is generated from the live CLI by mkdocs-click. It always reflects the version installed.

orca zone

Manage DNS zones (Designate).

Usage:

orca zone [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

Subcommands

• abandon: Drop a zone from Designate without notifying the backend (admin).
• axfr: Trigger an AXFR transfer on a secondary zone.
• blacklist: Manage DNS zone blacklists (admin).
• create: Create a DNS zone.
• delete: Delete a DNS zone.
• export: Manage zone export tasks (BIND-format).
• import: Manage zone import tasks (BIND-format).
• list: List DNS zones.
• move: Move a zone to a different project (admin, OSC zone move).
• reverse-lookup: Find PTR records for an IP address.
• set: Update a DNS zone.
• share: Share a zone with other projects.
• show: Show DNS zone details.
• tld: Manage allowed TLDs (admin).
• tld-create: [deprecated, use 'zone tld create' instead]
• tld-delete: [deprecated, use 'zone tld delete' instead]
• tld-list: [deprecated, use 'zone tld list' instead]
• transfer: Manage zone transfer requests and accepts.
• transfer-accept: [deprecated, use 'zone transfer accept' instead]
• transfer-request-create: [deprecated, use 'zone transfer request create' instead]
• transfer-request-delete: [deprecated, use 'zone transfer request delete' instead]
• transfer-request-list: [deprecated, use 'zone transfer request list' instead]
• transfer-request-show: [deprecated, use 'zone transfer request show' instead]
• tree: Show a zone as a Rich tree grouped by record type.

orca zone abandon

Drop a zone from Designate without notifying the backend (admin).

Usage:

orca zone abandon [OPTIONS] ZONE_ID

Options:

Name	Type	Description	Default
--yes, -y	boolean	Skip confirmation.	False
--help	boolean	Show this message and exit.	False

orca zone axfr

Trigger an AXFR transfer on a secondary zone.

Usage:

orca zone axfr [OPTIONS] ZONE_ID

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

orca zone blacklist

Manage DNS zone blacklists (admin).

Usage:

orca zone blacklist [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

Subcommands

• create: Add a blacklist rule (regex pattern matched against zone names).
• delete: Delete a blacklist rule.
• list: List blacklist rules.
• set: Update a blacklist rule.
• show: Show a blacklist rule.

orca zone blacklist create

Add a blacklist rule (regex pattern matched against zone names).

Usage:

orca zone blacklist create [OPTIONS] PATTERN

Options:

Name	Type	Description	Default
--description	text	Blacklist description.	None
--help	boolean	Show this message and exit.	False

orca zone blacklist delete

Delete a blacklist rule.

Usage:

orca zone blacklist delete [OPTIONS] BLACKLIST_ID

Options:

Name	Type	Description	Default
--yes, -y	boolean	Skip confirmation.	False
--help	boolean	Show this message and exit.	False

orca zone blacklist list

List blacklist rules.

Usage:

orca zone blacklist list [OPTIONS]

Options:

Name	Type	Description	Default
--noindent	boolean	Disable JSON indentation.	False
--max-width	integer	Maximum table width (0 = unlimited).	None
--fit-width	boolean	Fit table to terminal width.	False
--column, -c	text	Column to include (repeatable). Shows all if omitted.	Sentinel.UNSET
--format, -f	choice (table | json | value)	Output format.	table
--help	boolean	Show this message and exit.	False

orca zone blacklist set

Update a blacklist rule.

Usage:

orca zone blacklist set [OPTIONS] BLACKLIST_ID

Options:

Name	Type	Description	Default
--pattern	text	New pattern.	None
--description	text	New description.	None
--help	boolean	Show this message and exit.	False

orca zone blacklist show

Show a blacklist rule.

Usage:

orca zone blacklist show [OPTIONS] BLACKLIST_ID

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

orca zone create

Create a DNS zone.

NAME must be a fully-qualified domain name ending with a dot, e.g.: orca zone create example.com. --email admin@example.com

Usage:

orca zone create [OPTIONS] NAME

Options:

Name	Type	Description	Default
--email	text	Zone administrator email.	Sentinel.UNSET
--ttl	integer	Default TTL in seconds.	None
--description	text	Zone description.	None
--type	choice (PRIMARY | SECONDARY)	Zone type.	PRIMARY
--masters	text	Master servers (for SECONDARY zones, repeatable).	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

orca zone delete

Delete a DNS zone.

ZONE can be a zone ID or name.

Usage:

orca zone delete [OPTIONS] ZONE

Options:

Name	Type	Description	Default
--yes, -y	boolean	Skip confirmation.	False
--help	boolean	Show this message and exit.	False

orca zone export

Manage zone export tasks (BIND-format).

Usage:

orca zone export [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

Subcommands

• create: Trigger a zone export and stream the resulting BIND file.
• delete: Delete a recorded export task.
• list: List recorded zone export tasks (OSC parity).
• show: Show a zone export task.
• showfile: Fetch the BIND content produced by a completed zone export.

orca zone export create

Trigger a zone export and stream the resulting BIND file.

Examples: orca zone export create example.com. orca zone export create example.com. --file example.com.zone

Usage:

orca zone export create [OPTIONS] ZONE

Options:

Name	Type	Description	Default
--file	path	Write zone file to this path (default: stdout).	None
--help	boolean	Show this message and exit.	False

orca zone export delete

Delete a recorded export task.

Usage:

orca zone export delete [OPTIONS] EXPORT_ID

Options:

Name	Type	Description	Default
-y, --yes	boolean	Skip confirmation.	False
--help	boolean	Show this message and exit.	False

orca zone export list

List recorded zone export tasks (OSC parity).

Usage:

orca zone export list [OPTIONS]

Options:

Name	Type	Description	Default
--noindent	boolean	Disable JSON indentation.	False
--max-width	integer	Maximum table width (0 = unlimited).	None
--fit-width	boolean	Fit table to terminal width.	False
--column, -c	text	Column to include (repeatable). Shows all if omitted.	Sentinel.UNSET
--format, -f	choice (table | json | value)	Output format.	table
--help	boolean	Show this message and exit.	False

orca zone export show

Show a zone export task.

Usage:

orca zone export show [OPTIONS] EXPORT_ID

Options:

Name	Type	Description	Default
--noindent	boolean	Disable JSON indentation.	False
--max-width	integer	Maximum table width (0 = unlimited).	None
--fit-width	boolean	Fit table to terminal width.	False
--column, -c	text	Column to include (repeatable). Shows all if omitted.	Sentinel.UNSET
--format, -f	choice (table | json | value)	Output format.	table
--help	boolean	Show this message and exit.	False

orca zone export showfile

Fetch the BIND content produced by a completed zone export.

Usage:

orca zone export showfile [OPTIONS] EXPORT_ID

Options:

Name	Type	Description	Default
--file	path	Write the BIND file to this path (default: stdout).	None
--help	boolean	Show this message and exit.	False

orca zone import

Manage zone import tasks (BIND-format).

Usage:

orca zone import [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

Subcommands

• create: Import a zone from a BIND-format zone file.
• delete: Delete a recorded import task.
• list: List recorded zone import tasks (OSC parity).
• show: Show a zone import task.

orca zone import create

Import a zone from a BIND-format zone file.

Example: orca zone import create --file example.com.zone

Usage:

orca zone import create [OPTIONS]

Options:

Name	Type	Description	Default
--file	path	BIND-format zone file to import.	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

orca zone import delete

Delete a recorded import task.

Usage:

orca zone import delete [OPTIONS] IMPORT_ID

Options:

Name	Type	Description	Default
-y, --yes	boolean	Skip confirmation.	False
--help	boolean	Show this message and exit.	False

orca zone import list

List recorded zone import tasks (OSC parity).

Usage:

orca zone import list [OPTIONS]

Options:

Name	Type	Description	Default
--noindent	boolean	Disable JSON indentation.	False
--max-width	integer	Maximum table width (0 = unlimited).	None
--fit-width	boolean	Fit table to terminal width.	False
--column, -c	text	Column to include (repeatable). Shows all if omitted.	Sentinel.UNSET
--format, -f	choice (table | json | value)	Output format.	table
--help	boolean	Show this message and exit.	False

orca zone import show

Show a zone import task.

Usage:

orca zone import show [OPTIONS] IMPORT_ID

Options:

Name	Type	Description	Default
--noindent	boolean	Disable JSON indentation.	False
--max-width	integer	Maximum table width (0 = unlimited).	None
--fit-width	boolean	Fit table to terminal width.	False
--column, -c	text	Column to include (repeatable). Shows all if omitted.	Sentinel.UNSET
--format, -f	choice (table | json | value)	Output format.	table
--help	boolean	Show this message and exit.	False

orca zone list

List DNS zones.

Usage:

orca zone list [OPTIONS]

Options:

Name	Type	Description	Default
--noindent	boolean	Disable JSON indentation.	False
--max-width	integer	Maximum table width (0 = unlimited).	None
--fit-width	boolean	Fit table to terminal width.	False
--column, -c	text	Column to include (repeatable). Shows all if omitted.	Sentinel.UNSET
--format, -f	choice (table | json | value)	Output format.	table
--help	boolean	Show this message and exit.	False

orca zone move

Move a zone to a different project (admin, OSC zone move).

Usage:

orca zone move [OPTIONS] ZONE_ID_OR_NAME

Options:

Name	Type	Description	Default
--project	text	Destination project ID for the zone.	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

orca zone reverse-lookup

Find PTR records for an IP address.

Queries Designate reverse DNS for floating IPs and searches for matching in-addr.arpa / ip6.arpa zones.

Examples: orca zone reverse-lookup 192.0.2.1

Usage:

orca zone reverse-lookup [OPTIONS] IP

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

orca zone set

Update a DNS zone.

ZONE can be a zone ID or name.

Usage:

orca zone set [OPTIONS] ZONE

Options:

Name	Type	Description	Default
--email	text	Zone administrator email.	None
--ttl	integer	Default TTL in seconds.	None
--description	text	Zone description.	None
--help	boolean	Show this message and exit.	False

orca zone share

Share a zone with other projects.

Usage:

orca zone share [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

Subcommands

• create: Share a zone with a target project.
• delete: Revoke a zone share.
• list: List share grants on a zone.
• show: Show a single zone share.

orca zone share create

Share a zone with a target project.

Usage:

orca zone share create [OPTIONS] ZONE_ID

Options:

Name	Type	Description	Default
--target-project	text	Project ID to share the zone with.	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

orca zone share delete

Revoke a zone share.

Usage:

orca zone share delete [OPTIONS] ZONE_ID SHARE_ID

Options:

Name	Type	Description	Default
--yes, -y	boolean	Skip confirmation.	False
--help	boolean	Show this message and exit.	False

orca zone share list

List share grants on a zone.

Usage:

orca zone share list [OPTIONS] ZONE_ID

Options:

Name	Type	Description	Default
--noindent	boolean	Disable JSON indentation.	False
--max-width	integer	Maximum table width (0 = unlimited).	None
--fit-width	boolean	Fit table to terminal width.	False
--column, -c	text	Column to include (repeatable). Shows all if omitted.	Sentinel.UNSET
--format, -f	choice (table | json | value)	Output format.	table
--help	boolean	Show this message and exit.	False

orca zone share show

Show a single zone share.

Usage:

orca zone share show [OPTIONS] ZONE_ID SHARE_ID

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

orca zone show

Show DNS zone details.

ZONE can be a zone ID or name.

Usage:

orca zone show [OPTIONS] ZONE

Options:

Name	Type	Description	Default
--noindent	boolean	Disable JSON indentation.	False
--max-width	integer	Maximum table width (0 = unlimited).	None
--fit-width	boolean	Fit table to terminal width.	False
--column, -c	text	Column to include (repeatable). Shows all if omitted.	Sentinel.UNSET
--format, -f	choice (table | json | value)	Output format.	table
--help	boolean	Show this message and exit.	False

orca zone tld

Manage allowed TLDs (admin).

Usage:

orca zone tld [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

Subcommands

• create: Create a TLD (admin).
• delete: Delete a TLD (admin).
• list: List allowed TLDs (admin).
• set: Update a Designate TLD.
• show: Show a Designate TLD.

orca zone tld create

Create a TLD (admin).

Usage:

orca zone tld create [OPTIONS] NAME

Options:

Name	Type	Description	Default
--description	text	Description.	None
--help	boolean	Show this message and exit.	False

orca zone tld delete

Delete a TLD (admin).

Usage:

orca zone tld delete [OPTIONS] TLD_ID

Options:

Name	Type	Description	Default
--yes, -y	boolean	Skip confirmation.	False
--help	boolean	Show this message and exit.	False

orca zone tld list

List allowed TLDs (admin).

Usage:

orca zone tld list [OPTIONS]

Options:

Name	Type	Description	Default
--noindent	boolean	Disable JSON indentation.	False
--max-width	integer	Maximum table width (0 = unlimited).	None
--fit-width	boolean	Fit table to terminal width.	False
--column, -c	text	Column to include (repeatable). Shows all if omitted.	Sentinel.UNSET
--format, -f	choice (table | json | value)	Output format.	table
--help	boolean	Show this message and exit.	False

orca zone tld set

Update a Designate TLD.

Usage:

orca zone tld set [OPTIONS] TLD_ID

Options:

Name	Type	Description	Default
--name	text	New TLD name (e.g. com).	None
--description	text	Update the description.	None
--help	boolean	Show this message and exit.	False

orca zone tld show

Show a Designate TLD.

Usage:

orca zone tld show [OPTIONS] TLD_ID

Options:

Name	Type	Description	Default
--noindent	boolean	Disable JSON indentation.	False
--max-width	integer	Maximum table width (0 = unlimited).	None
--fit-width	boolean	Fit table to terminal width.	False
--column, -c	text	Column to include (repeatable). Shows all if omitted.	Sentinel.UNSET
--format, -f	choice (table | json | value)	Output format.	table
--help	boolean	Show this message and exit.	False

orca zone tld-create

Create a TLD (admin).

Usage:

orca zone tld-create [OPTIONS] NAME

Options:

Name	Type	Description	Default
--description	text	Description.	None
--help	boolean	Show this message and exit.	False

orca zone tld-delete

Delete a TLD (admin).

Usage:

orca zone tld-delete [OPTIONS] TLD_ID

Options:

Name	Type	Description	Default
--yes, -y	boolean	Skip confirmation.	False
--help	boolean	Show this message and exit.	False

orca zone tld-list

List allowed TLDs (admin).

Usage:

orca zone tld-list [OPTIONS]

Options:

Name	Type	Description	Default
--noindent	boolean	Disable JSON indentation.	False
--max-width	integer	Maximum table width (0 = unlimited).	None
--fit-width	boolean	Fit table to terminal width.	False
--column, -c	text	Column to include (repeatable). Shows all if omitted.	Sentinel.UNSET
--format, -f	choice (table | json | value)	Output format.	table
--help	boolean	Show this message and exit.	False

orca zone transfer

Manage zone transfer requests and accepts.

Usage:

orca zone transfer [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

Subcommands

• accept: Manage zone transfer accepts (OSC parity).
• request: Manage zone transfer requests (sender side).

orca zone transfer accept

Manage zone transfer accepts (OSC parity).

Usage:

orca zone transfer accept [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

Subcommands

• list: List all zone-transfer accepts visible to the caller.
• request: Submit an accept for a pending zone-transfer request.
• show: Show a zone-transfer accept by ID.

orca zone transfer accept list

List all zone-transfer accepts visible to the caller.

Usage:

orca zone transfer accept list [OPTIONS]

Options:

Name	Type	Description	Default
--noindent	boolean	Disable JSON indentation.	False
--max-width	integer	Maximum table width (0 = unlimited).	None
--fit-width	boolean	Fit table to terminal width.	False
--column, -c	text	Column to include (repeatable). Shows all if omitted.	Sentinel.UNSET
--format, -f	choice (table | json | value)	Output format.	table
--help	boolean	Show this message and exit.	False

orca zone transfer accept request

Submit an accept for a pending zone-transfer request.

Usage:

orca zone transfer accept request [OPTIONS] TRANSFER_ID KEY

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

orca zone transfer accept show

Show a zone-transfer accept by ID.

Usage:

orca zone transfer accept show [OPTIONS] ACCEPT_ID

Options:

Name	Type	Description	Default
--noindent	boolean	Disable JSON indentation.	False
--max-width	integer	Maximum table width (0 = unlimited).	None
--fit-width	boolean	Fit table to terminal width.	False
--column, -c	text	Column to include (repeatable). Shows all if omitted.	Sentinel.UNSET
--format, -f	choice (table | json | value)	Output format.	table
--help	boolean	Show this message and exit.	False

orca zone transfer request

Manage zone transfer requests (sender side).

Usage:

orca zone transfer request [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

Subcommands

• create: Create a zone transfer request.
• delete: Delete a zone transfer request.
• list: List zone transfer requests.
• set: Update a zone-transfer request (OSC zone transfer request set).
• show: Show a zone transfer request.

orca zone transfer request create

Create a zone transfer request.

Usage:

orca zone transfer request create [OPTIONS] ZONE_ID

Options:

Name	Type	Description	Default
--target-project-id	text	Restrict transfer to a specific project ID.	None
--description	text	Description.	None
--help	boolean	Show this message and exit.	False

orca zone transfer request delete

Delete a zone transfer request.

Usage:

orca zone transfer request delete [OPTIONS] TRANSFER_ID

Options:

Name	Type	Description	Default
--yes, -y	boolean	Skip confirmation.	False
--help	boolean	Show this message and exit.	False

orca zone transfer request list

List zone transfer requests.

Usage:

orca zone transfer request list [OPTIONS]

Options:

Name	Type	Description	Default
--noindent	boolean	Disable JSON indentation.	False
--max-width	integer	Maximum table width (0 = unlimited).	None
--fit-width	boolean	Fit table to terminal width.	False
--column, -c	text	Column to include (repeatable). Shows all if omitted.	Sentinel.UNSET
--format, -f	choice (table | json | value)	Output format.	table
--help	boolean	Show this message and exit.	False

orca zone transfer request set

Update a zone-transfer request (OSC zone transfer request set).

Usage:

orca zone transfer request set [OPTIONS] TRANSFER_ID

Options:

Name	Type	Description	Default
--description	text	N/A	None
--target-project	text	Restrict the request to this target project.	None
--help	boolean	Show this message and exit.	False

orca zone transfer request show

Show a zone transfer request.

Usage:

orca zone transfer request show [OPTIONS] TRANSFER_ID

Options:

Name	Type	Description	Default
--noindent	boolean	Disable JSON indentation.	False
--max-width	integer	Maximum table width (0 = unlimited).	None
--fit-width	boolean	Fit table to terminal width.	False
--column, -c	text	Column to include (repeatable). Shows all if omitted.	Sentinel.UNSET
--format, -f	choice (table | json | value)	Output format.	table
--help	boolean	Show this message and exit.	False

orca zone transfer-accept

Manage zone transfer accepts (OSC parity).

Usage:

orca zone transfer-accept [OPTIONS]

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

orca zone transfer-request-create

Create a zone transfer request.

Usage:

orca zone transfer-request-create [OPTIONS] ZONE_ID

Options:

Name	Type	Description	Default
--target-project-id	text	Restrict transfer to a specific project ID.	None
--description	text	Description.	None
--help	boolean	Show this message and exit.	False

orca zone transfer-request-delete

Delete a zone transfer request.

Usage:

orca zone transfer-request-delete [OPTIONS] TRANSFER_ID

Options:

Name	Type	Description	Default
--yes, -y	boolean	Skip confirmation.	False
--help	boolean	Show this message and exit.	False

orca zone transfer-request-list

List zone transfer requests.

Usage:

orca zone transfer-request-list [OPTIONS]

Options:

Name	Type	Description	Default
--noindent	boolean	Disable JSON indentation.	False
--max-width	integer	Maximum table width (0 = unlimited).	None
--fit-width	boolean	Fit table to terminal width.	False
--column, -c	text	Column to include (repeatable). Shows all if omitted.	Sentinel.UNSET
--format, -f	choice (table | json | value)	Output format.	table
--help	boolean	Show this message and exit.	False

orca zone transfer-request-show

Show a zone transfer request.

Usage:

orca zone transfer-request-show [OPTIONS] TRANSFER_ID

Options:

Name	Type	Description	Default
--noindent	boolean	Disable JSON indentation.	False
--max-width	integer	Maximum table width (0 = unlimited).	None
--fit-width	boolean	Fit table to terminal width.	False
--column, -c	text	Column to include (repeatable). Shows all if omitted.	Sentinel.UNSET
--format, -f	choice (table | json | value)	Output format.	table
--help	boolean	Show this message and exit.	False

orca zone tree

Show a zone as a Rich tree grouped by record type.

Displays SOA at the top, then NS, then A/AAAA/CNAME/MX/TXT and other types — each colour-coded for quick scanning.

ZONE can be a zone ID or name.

Usage:

orca zone tree [OPTIONS] ZONE

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False