designateclient(1)
| PYTHON-DESIGNATECLIENT(1) | python-designateclient | PYTHON-DESIGNATECLIENT(1) |
NAME
python-designateclient - python-designateclient 5.2.0
python-designateclient provides python bindings and command line tools for the Designate v2 APIs.
The Python API bindings are provided by the designateclient module.
The designate plugin can be used via the openstack command line tool. More information can be found on the designate command line tool page.
You'll need credentials for an OpenStack cloud that implements the Designate API in order to use the client.
INSTALLATION
Install the client from PyPI
The python-designateclient package is published on PyPI and so can be installed using the pip tool, which will manage installing all python dependencies:
pip install python-designateclient
Warning: the packages on PyPI may lag behind the git repo in functionality.
Setup the client from source
If you want the latest version, straight from github:
git clone git@github.com:openstack/python-designateclient.git cd python-designateclient virtualenv .venv . .venv/bin/activate pip install -r requirements.txt -r test-requirements.txt python setup.py install
Setup the client in development mode
Installing in development mode allows your to make changes to the source code & test directly without having to re-run the "python setup.py install" step. You can find out more about Development Mode
git clone git@github.com:openstack/python-designateclient.git cd python-designateclient virtualenv .venv . .venv/bin/activate pip install -r requirements.txt -r test-requirements.txt python setup.py develop
USING PYTHON-DESIGNATECLIENT
Python Bindings - v2
The python-designateclient package comes with python bindings the Designate API: v2. This can be used to interact with the Designate API from any python program.
Introduction - Bindings v2
To view examples of usage please checkout the doc/examples folder, basic usage is:
#!/usr/bin/env python from designateclient.v2 import client from designateclient import shell from keystoneauth1.identity import generic from keystoneauth1 import session as keystone_session auth = generic.Password(
auth_url=shell.env('OS_AUTH_URL'),
username=shell.env('OS_USERNAME'),
password=shell.env('OS_PASSWORD'),
project_name=shell.env('OS_PROJECT_NAME'),
project_domain_id='default',
user_domain_id='default') session = keystone_session.Session(auth=auth) client = client.Client(session=session) zone = client.zones.create('i.io.', email='i@i.io') rs = client.recordsets.create(zone['id'], 'www', 'A', ['10.0.0.1'])
OpenStack CLI
The python-designateclient package comes with a plugin for the openstack command line tool (installed as openstack). This can be used to access a Designate API without having to manipulate JSON by hand, it can also produce the output in a variety of formats (JSON, CSV) and allow you to select columns to be displayed.
Installation
Both python-openstackclient and python-designateclient must be installed:
$ pip install python-openstackclient python-designateclient
Configuration
openstack requires certain information to talk to the REST API. An in-depth explanation is covered in the OpenStack Client configuration documentation.
To get started, all you usually need are the following variables:
OS_AUTH_VERSION=3 OS_IDENTITY_API_VERSION=3 OS_AUTH_URL=http://127.0.0.1:5000/v3 OS_PROJECT_NAME=demo OS_USERNAME=demo OS_TENANT_NAME=demo OS_PASSWORD=password
Using the Command Line Tool
With enough details now in the environment, you can use the openstack to create a zone and populate it with some records:
$ openstack zone create --email admin@example.com example.com. +----------------+--------------------------------------+ | Field | Value | +----------------+--------------------------------------+ | action | CREATE | | created_at | 2016-04-19T17:44:04.000000 | | description | None | | email | admin@example.com | | id | 388814ef-3c5d-415e-a866-5b1d13d78dae | | masters | | | name | example.com. | | pool_id | 794ccc2c-d751-44fe-b57f-8894c9f5c842 | | project_id | 123456 | | serial | 1461087844 | | status | PENDING | | transferred_at | None | | ttl | 3600 | | type | PRIMARY | | updated_at | None | | version | 1 | +----------------+--------------------------------------+
Now that the zone has been created, we can start adding records.
You'll note that the zone name (example.com) has a trailing ., as per the DNS standard, and we didn't set a TTL.
$ openstack recordset create --type A --records 192.0.2.20 example.com. www +-------------+--------------------------------------+ | Field | Value | +-------------+--------------------------------------+ | action | CREATE | | created_at | 2016-04-19T17:51:12.000000 | | description | None | | id | 180d3574-3c29-4ea2-b6ff-df904bd3f126 | | name | www.example.com. | | records | 192.0.2.20 | | status | PENDING | | ttl | None | | type | A | | updated_at | None | | version | 1 | | zone_id | 388814ef-3c5d-415e-a866-5b1d13d78dae | +-------------+--------------------------------------+
Designate-specific Subcommands
Aside from the zone create and recordset create subcommands, this is the full list of subcommands that enable Designate V2 support:
| subcommand | Notes | Admin Required |
| zone create | Create new zone | |
| zone list | List zones | |
| zone show | Show zone details | |
| zone set | Set zone properties | |
| zone delete | Delete zone | |
| recordset create | Create new recordset | |
| recordset list | List recordsets | |
| recordset list all | List all recordsets in all zones | |
| recordset show | Show recordset details | |
| recordset set | Set recordset properties | |
| recordset delete | Delete recordset | |
| ptr record list | List floatingip ptr records | |
| ptr record show | Show floatingip ptr record details | |
| ptr record set | Set floatingip ptr record | |
| ptr record unset | Unset floatingip ptr record | |
| zone export create | Export a Zone | |
| zone export list | List Zone Exports | |
| zone export show | Show a Zone Export | |
| zone export delete | Delete a Zone Export | |
| zone export showfile | Show the zone file for the Zone Export | |
| zone import create | Import a Zone from a file on the filesystem | |
| zone import list | List Zone Imports | |
| zone import show | Show a Zone Import | |
| zone import delete | Delete a Zone Import | |
| zone transfer request create | Create new zone transfer request | |
| zone transfer request list | List Zone Transfer Requests | |
| zone transfer request show | Show Zone Transfer Request Details | |
| zone transfer request set | Set a Zone Transfer Request | |
| zone transfer request delete | Delete a Zone Transfer Request | |
| zone transfer accept request | Accept a Zone Transfer Request | |
| zone transfer accept list | List Zone Transfer Accepts | |
| zone transfer accept show | Show Zone Transfer Accept | |
| zone abandon | Abandon a zone | Yes |
| zone axfr | AXFR a zone | |
| zone blacklist create | Create new blacklist | Yes |
| zone blacklist list | List blacklists | Yes |
| zone blacklist show | Show blacklist details | Yes |
| zone blacklist set | Set blacklist properties | Yes |
| zone blacklist delete | Delete blacklist | Yes |
| tld create | Create new tld | Yes |
| tld list | List tlds | Yes |
| tld show | Show tld details | Yes |
| tld set | Set tld properties | Yes |
| tld delete | Delete tld | Yes |
Built-in Designate Documentation
You'll find complete documentation on the shell by running: openstack --help
For a specific command, you can execute: openstack subcommand help
Examples
Because command output would make this document long, much of it will be omitted from some examples.
Working with Zones
Create a zone with the following command:
$ openstack zone create --email admin@example.com example.com. +----------------+--------------------------------------+ | Field | Value | +----------------+--------------------------------------+ | action | CREATE | | created_at | 2016-04-19T17:44:04.000000 | | description | None | | email | admin@example.com | | id | 388814ef-3c5d-415e-a866-5b1d13d78dae | | masters | | | name | example.com. | | pool_id | 794ccc2c-d751-44fe-b57f-8894c9f5c842 | | project_id | 123456 | | serial | 1461087844 | | status | PENDING | | transferred_at | None | | ttl | 3600 | | type | PRIMARY | | updated_at | None | | version | 1 | +----------------+--------------------------------------+
See the new zone in your list of zones with the following command:
$ openstack zone list
Display a specific zone with either of these commands; most zone commands accept either the zone_id or name attribute:
$ openstack zone show example.com. $ openstack zone show 388814ef-3c5d-415e-a866-5b1d13d78dae
Update the zone with this command:
$ openstack zone set --description "Description" example.com.
Delete the zone with this command:
$ openstack zone delete example.com.
Working with Recordsets
Using the zone above, create a recordset with the following command:
$ openstack recordset create example.com. --type A www --records 192.0.2.20 +-------------+--------------------------------------+ | Field | Value | +-------------+--------------------------------------+ | action | CREATE | | created_at | 2016-04-19T17:51:12.000000 | | description | None | | id | 180d3574-3c29-4ea2-b6ff-df904bd3f126 | | name | www.example.com. | | records | 192.0.2.20 | | status | PENDING | | ttl | None | | type | A | | updated_at | None | | version | 1 | | zone_id | 388814ef-3c5d-415e-a866-5b1d13d78dae | +-------------+--------------------------------------+
Multiple records can be provided for a specific recordset type:
$ openstack recordset create example.com. --type A www --records 192.0.2.20 192.0.2.21
See the new recordset in the list of recordsets with the following command:
$ openstack recordset list example.com.
Display a specific recordset:
$ openstack recordset show example.com. www.example.com.
Update a specific recordset:
$ openstack recordset set example.com. www.example.com. --ttl 10000 --records 192.0.2.20 192.0.2.21
Delete a recordset:
$ openstack recordset delete example.com. www.example.com.
Working with PTR Records
Reverse DNS for Neutron Floating IPs can be managed with the "ptr" subcommand.
Create a PTR record:
$ openstack ptr record set RegionOne:5c02c519-4928-4a38-bd10-c748c200912f ftp.example.com. +-------------+------------------------------------------------+ | Field | Value | +-------------+------------------------------------------------+ | action | CREATE | | address | 172.24.4.11 | | description | None | | id | RegionOne:5c02c519-4928-4a38-bd10-c748c200912f | | ptrdname | ftp.example.com. | | status | PENDING | | ttl | 3600 | +-------------+------------------------------------------------+
List all PTR records:
$ openstack ptr record list
Show a PTR record:
$ openstack ptr record show RegionOne:5c02c519-4928-4a38-bd10-c748c200912f
Delete a PTR record:
$ openstack ptr record delete RegionOne:5c02c519-4928-4a38-bd10-c748c200912f
Working with Zone Exports
Zone exports enable you to save Designate zone information offline.
Create a zone export:
$ openstack zone export create example.com. +------------+--------------------------------------+ | Field | Value | +------------+--------------------------------------+ | created_at | 2016-04-19T20:42:16.000000 | | id | 6d5acb9d-f3d6-4ed4-96e1-03bc0e405bb5 | | location | None | | message | None | | project_id | 123456 | | status | PENDING | | updated_at | None | | version | 1 | | zone_id | 388814ef-3c5d-415e-a866-5b1d13d78dae | +------------+--------------------------------------+
List zone exports:
$ openstack zone export list
Show zone export:
$ openstack zone export show 6d5acb9d-f3d6-4ed4-96e1-03bc0e405bb5
Show the zone file for the Zone Export:
$ openstack zone export showfile 6d5acb9d-f3d6-4ed4-96e1-03bc0e405bb5 -f value $ORIGIN example.com. $TTL 3600 example.com. IN NS ns2.exampleprovider.com. example.com. IN NS ns1.exampleprovider.com. example.com. IN SOA ns.exampleprovider.com. admin@example.com 1458678636 7200 300 604800 300
Delete zone export:
$ openstack zone export delete 6d5acb9d-f3d6-4ed4-96e1-03bc0e405bb5
Working with Zone Imports
Zone imports enable you to import a zone into Designate from a file on the filesystem.
Create a zone import from a file:
$ openstack zone import create zonefile.txt +------------+--------------------------------------+ | Field | Value | +------------+--------------------------------------+ | created_at | 2016-04-19T20:59:38.000000 | | id | bab6e152-da9f-4dfc-8a59-3f9710fe4894 | | message | None | | project_id | 123456 | | status | PENDING | | updated_at | None | | version | 1 | | zone_id | None | +------------+--------------------------------------+
List zone imports:
$ openstack zone import list
Show zone import:
$ openstack zone import show 839d8041-1960-4d74-8533-118d52218074
Delete zone import:
$ openstack zone import delete 839d8041-1960-4d74-8533-118d52218074
Working with Zone Blacklists
Blacklisting zone names enables you to block any zone pattern from creation.
Create a zone blacklist
$ openstack zone blacklist create --pattern "^example\.com\.$" --description "This is a blacklisted domain." +-------------+--------------------------------------+ | Field | Value | +-------------+--------------------------------------+ | created_at | 2016-05-10 00:26:07 | | description | This is a blacklisted domain. | | id | 308ecb82-4952-4476-88b4-9db18fc78e10 | | pattern | ^example.com.$ | | updated_at | None | +-------------+--------------------------------------+
List zone blacklist
$ openstack zone blacklist list
Show zone blacklist
$ openstack zone blacklist show 308ecb82-4952-4476-88b4-9db18fc78e10
Update zone blacklist
$ openstack zone blacklist set --pattern "^([A-Za-z0-9_\-]+\.)*example\.com\.$" --description "Updated the description" 308ecb82-4952-4476-88b4-9db18fc78e10
Delete a zone blacklist
$ openstack zone blacklist delete 308ecb82-4952-4476-88b4-9db18fc78e10
Working with Zone Transfers Between Projects
Zone Transfers enable you to perform the transfer of zone ownership to another project.
Create a Zone Transfer Request
$ openstack zone transfer request create --target-project-id 9cc52dd7649c4aa99fa9db2fb94dabb8 53cdcf82-9e32-4a00-a90d-32d6ec5db7e9
+-------------------+----------------------------------------------------------------------------------------+
| Field | Value |
+-------------------+----------------------------------------------------------------------------------------+
| created_at | 2016-05-10 01:39:00 |
| description | None |
| id | 98ba1d22-c092-4603-891f-8a0ab04f7e57 |
| key | J6JCET2C |
| links | {u'self': |
| | u'http://192.168.11.182:9001/v2/zones/tasks/transfer_requests/98ba1d22-c092-4603-891f- |
| | 8a0ab04f7e57'} |
| project_id | 10457ad1fe074f4a89bb1e4c0cd83d40 |
| status | ACTIVE |
| target_project_id | 9cc52dd7649c4aa99fa9db2fb94dabb8 |
| updated_at | None |
| zone_id | 53cdcf82-9e32-4a00-a90d-32d6ec5db7e9 |
| zone_name | example.com. |
+-------------------+----------------------------------------------------------------------------------------+
List Zone Transfer Requests
$ openstack zone transfer request list
Show Zone Transfer Request Details
$ openstack zone transfer request show 98ba1d22-c092-4603-891f-8a0ab04f7e57
Update a Zone Transfer Request
$ openstack zone transfer request set 98ba1d22-c092-4603-891f-8a0ab04f7e57 --description "demo transfer"
Delete a Zone Transfer Request
$ openstack zone transfer request delete 98ba1d22-c092-4603-891f-8a0ab04f7e57
Accept a Zone Transfer Request
$ openstack zone transfer accept request --transfer-id 98ba1d22-c092-4603-891f-8a0ab04f7e57 --key J6JCET2C
+--------------------------+---------------------------------------------------------------------------------+
| Field | Value |
+--------------------------+---------------------------------------------------------------------------------+
| created_at | 2016-05-10 05:02:52 |
| id | a8750f50-d7e6-403a-89d2-e209d62ef60e |
| key | J6JCET2C |
| links | {u'self': |
| | u'http://192.168.11.182:9001/v2/zones/tasks/transfer_accepts/a8750f50-d7e6 |
| | -403a-89d2-e209d62ef60e', u'zone': |
| | u'http://192.168.11.182:9001/v2/zones/53cdcf82-9e32-4a00-a90d-32d6ec5db7e9'} |
| project_id | 10457ad1fe074f4a89bb1e4c0cd83d40 |
| status | COMPLETE |
| updated_at | 2016-05-10 05:02:52 |
| zone_id | 53cdcf82-9e32-4a00-a90d-32d6ec5db7e9 |
| zone_transfer_request_id | 98ba1d22-c092-4603-891f-8a0ab04f7e57 |
+--------------------------+---------------------------------------------------------------------------------+
Show Zone Transfer Accept
$ openstack zone transfer accept show a8750f50-d7e6-403a-89d2-e209d62ef60e
List Zone Transfer Accept
$ openstack zone transfer accept list
Working with Top Level Domains
The tld commands enable you to manage top level domains.
Create a TLD
$ openstack tld create --name com --description "demo TLD" +-------------+--------------------------------------+ | Field | Value | +-------------+--------------------------------------+ | created_at | 2016-05-10 05:21:40 | | description | demo TLD | | id | a7bba387-712b-4b42-9368-4508642c6113 | | name | com | | updated_at | None | +-------------+--------------------------------------+
List TLDs
$ openstack tld list
Show TLD Details
$ openstack tld show a7bba387-712b-4b42-9368-4508642c6113
Update a TLD
$ openstack tld set a7bba387-712b-4b42-9368-4508642c6113 --name org --description "TLD description"
Delete a TLD
$ openstack tld delete a7bba387-712b-4b42-9368-4508642c6113
DESIGNATE OPENSTACK CLIENT COMMAND REFERENCE
List of released CLI commands available in OpenStack client. These commands can be referenced by doing openstack help <command>.
Managing the DNS Service
dns quota list
List quotas
dns quota list
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--all-projects]
[--sudo-project-id SUDO_PROJECT_ID]
[--project-id PROJECT_ID]
- -f <FORMATTER>, --format <FORMATTER>
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated to show multiple columns
- --noindent
- whether to disable indenting the JSON
- --prefix <PREFIX>
- add a prefix to all variable names
- --max-width <integer>
- Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
- --fit-width
- Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
- --print-empty
- Print empty table if there is no data to show.
- --all-projects
- Show results from all projects. Default: False
- --sudo-project-id <SUDO_PROJECT_ID>
- Project ID to impersonate for this command. Default: None
- --project-id <PROJECT_ID>
- Project ID Default: current project
This command is provided by the python-designateclient plugin.
dns quota reset
Reset quotas
dns quota reset
[--all-projects]
[--sudo-project-id SUDO_PROJECT_ID]
[--project-id PROJECT_ID]
- --all-projects
- Show results from all projects. Default: False
- --sudo-project-id <SUDO_PROJECT_ID>
- Project ID to impersonate for this command. Default: None
- --project-id <PROJECT_ID>
- Project ID
This command is provided by the python-designateclient plugin.
dns quota set
Set quotas
dns quota set
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--all-projects]
[--sudo-project-id SUDO_PROJECT_ID]
[--project-id PROJECT_ID]
[--api-export-size <api-export-size>]
[--recordset-records <recordset-records>]
[--zone-records <zone-records>]
[--zone-recordsets <zone-recordsets>]
[--zones <zones>]
- -f <FORMATTER>, --format <FORMATTER>
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated to show multiple columns
- --noindent
- whether to disable indenting the JSON
- --prefix <PREFIX>
- add a prefix to all variable names
- --max-width <integer>
- Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
- --fit-width
- Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
- --print-empty
- Print empty table if there is no data to show.
- --all-projects
- Show results from all projects. Default: False
- --sudo-project-id <SUDO_PROJECT_ID>
- Project ID to impersonate for this command. Default: None
- --project-id <PROJECT_ID>
- Project ID
- --api-export-size <api-export-size>
- New value for the api-export-size quota
- --recordset-records <recordset-records>
- New value for the recordset-records quota
- --zone-records <zone-records>
- New value for the zone-records quota
- --zone-recordsets <zone-recordsets>
- New value for the zone-recordsets quota
- --zones <zones>
- New value for the zones quota
This command is provided by the python-designateclient plugin.
dns service list
List service statuses
dns service list
[-f {csv,json,table,value,yaml}]
[-c COLUMN]
[--quote {all,minimal,none,nonnumeric}]
[--noindent]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending]
[--hostname HOSTNAME]
[--service_name SERVICE_NAME]
[--status STATUS]
[--all-projects]
[--sudo-project-id SUDO_PROJECT_ID]
- -f <FORMATTER>, --format <FORMATTER>
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated to show multiple columns
- --quote <QUOTE_MODE>
- when to include quotes, defaults to nonnumeric
- --noindent
- whether to disable indenting the JSON
- --max-width <integer>
- Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
- --fit-width
- Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
- --print-empty
- Print empty table if there is no data to show.
- --sort-column SORT_COLUMN
- specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
- --sort-ascending
- sort the column(s) in ascending order
- --sort-descending
- sort the column(s) in descending order
- --hostname <HOSTNAME>
- Hostname
- --service_name <SERVICE_NAME>
- Service Name
- --status <STATUS>
- Status
- --all-projects
- Show results from all projects. Default: False
- --sudo-project-id <SUDO_PROJECT_ID>
- Project ID to impersonate for this command. Default: None
This command is provided by the python-designateclient plugin.
dns service show
Show service status details
dns service show
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--all-projects]
[--sudo-project-id SUDO_PROJECT_ID]
id
- -f <FORMATTER>, --format <FORMATTER>
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated to show multiple columns
- --noindent
- whether to disable indenting the JSON
- --prefix <PREFIX>
- add a prefix to all variable names
- --max-width <integer>
- Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
- --fit-width
- Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
- --print-empty
- Print empty table if there is no data to show.
- --all-projects
- Show results from all projects. Default: False
- --sudo-project-id <SUDO_PROJECT_ID>
- Project ID to impersonate for this command. Default: None
- id
- Service Status ID
This command is provided by the python-designateclient plugin.
Pointer Records
ptr record list
List floatingip ptr records
ptr record list
[-f {csv,json,table,value,yaml}]
[-c COLUMN]
[--quote {all,minimal,none,nonnumeric}]
[--noindent]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending]
[--all-projects]
[--sudo-project-id SUDO_PROJECT_ID]
- -f <FORMATTER>, --format <FORMATTER>
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated to show multiple columns
- --quote <QUOTE_MODE>
- when to include quotes, defaults to nonnumeric
- --noindent
- whether to disable indenting the JSON
- --max-width <integer>
- Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
- --fit-width
- Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
- --print-empty
- Print empty table if there is no data to show.
- --sort-column SORT_COLUMN
- specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
- --sort-ascending
- sort the column(s) in ascending order
- --sort-descending
- sort the column(s) in descending order
- --all-projects
- Show results from all projects. Default: False
- --sudo-project-id <SUDO_PROJECT_ID>
- Project ID to impersonate for this command. Default: None
This command is provided by the python-designateclient plugin.
ptr record set
Set floatingip ptr record
ptr record set
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--description DESCRIPTION | --no-description]
[--ttl TTL | --no-ttl]
[--all-projects]
[--sudo-project-id SUDO_PROJECT_ID]
floatingip_id
ptrdname
- -f <FORMATTER>, --format <FORMATTER>
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated to show multiple columns
- --noindent
- whether to disable indenting the JSON
- --prefix <PREFIX>
- add a prefix to all variable names
- --max-width <integer>
- Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
- --fit-width
- Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
- --print-empty
- Print empty table if there is no data to show.
- --description <DESCRIPTION>
- Description
- --no-description
- --ttl <TTL>
- TTL
- --no-ttl
- --all-projects
- Show results from all projects. Default: False
- --sudo-project-id <SUDO_PROJECT_ID>
- Project ID to impersonate for this command. Default: None
- floatingip_id
- Floating IP ID in format region:floatingip_id
- ptrdname
- PTRD Name
This command is provided by the python-designateclient plugin.
ptr record show
Show floatingip ptr record details
ptr record show
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--all-projects]
[--sudo-project-id SUDO_PROJECT_ID]
floatingip_id
- -f <FORMATTER>, --format <FORMATTER>
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated to show multiple columns
- --noindent
- whether to disable indenting the JSON
- --prefix <PREFIX>
- add a prefix to all variable names
- --max-width <integer>
- Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
- --fit-width
- Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
- --print-empty
- Print empty table if there is no data to show.
- --all-projects
- Show results from all projects. Default: False
- --sudo-project-id <SUDO_PROJECT_ID>
- Project ID to impersonate for this command. Default: None
- floatingip_id
- Floating IP ID in format region:floatingip_id
This command is provided by the python-designateclient plugin.
ptr record unset
Unset floatingip ptr record
ptr record unset
[--all-projects]
[--sudo-project-id SUDO_PROJECT_ID]
floatingip_id
- --all-projects
- Show results from all projects. Default: False
- --sudo-project-id <SUDO_PROJECT_ID>
- Project ID to impersonate for this command. Default: None
- floatingip_id
- Floating IP ID in format region:floatingip_id
This command is provided by the python-designateclient plugin.
Record Sets
recordset create
Create new recordset
recordset create
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
--record RECORD
--type TYPE
[--ttl TTL]
[--description DESCRIPTION]
[--all-projects]
[--sudo-project-id SUDO_PROJECT_ID]
zone_id
name
- -f <FORMATTER>, --format <FORMATTER>
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated to show multiple columns
- --noindent
- whether to disable indenting the JSON
- --prefix <PREFIX>
- add a prefix to all variable names
- --max-width <integer>
- Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
- --fit-width
- Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
- --print-empty
- Print empty table if there is no data to show.
- --record <RECORD>
- RecordSet Record, repeat if necessary
- --type <TYPE>
- RecordSet Type
- --ttl <TTL>
- Time To Live (Seconds)
- --description <DESCRIPTION>
- Description
- --all-projects
- Show results from all projects. Default: False
- --sudo-project-id <SUDO_PROJECT_ID>
- Project ID to impersonate for this command. Default: None
- zone_id
- Zone ID
- name
- RecordSet Name
This command is provided by the python-designateclient plugin.
recordset delete
Delete recordset
recordset delete
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--all-projects]
[--sudo-project-id SUDO_PROJECT_ID]
[--edit-managed]
zone_id
id
- -f <FORMATTER>, --format <FORMATTER>
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated to show multiple columns
- --noindent
- whether to disable indenting the JSON
- --prefix <PREFIX>
- add a prefix to all variable names
- --max-width <integer>
- Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
- --fit-width
- Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
- --print-empty
- Print empty table if there is no data to show.
- --all-projects
- Show results from all projects. Default: False
- --sudo-project-id <SUDO_PROJECT_ID>
- Project ID to impersonate for this command. Default: None
- --edit-managed
- Edit resources marked as managed. Default: False
- zone_id
- Zone ID
- id
- RecordSet ID
This command is provided by the python-designateclient plugin.
recordset list
List recordsets
recordset list
[-f {csv,json,table,value,yaml}]
[-c COLUMN]
[--quote {all,minimal,none,nonnumeric}]
[--noindent]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending]
[--name NAME]
[--type TYPE]
[--data DATA]
[--ttl TTL]
[--description DESCRIPTION]
[--status STATUS]
[--action ACTION]
[--all-projects]
[--sudo-project-id SUDO_PROJECT_ID]
zone_id
- -f <FORMATTER>, --format <FORMATTER>
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated to show multiple columns
- --quote <QUOTE_MODE>
- when to include quotes, defaults to nonnumeric
- --noindent
- whether to disable indenting the JSON
- --max-width <integer>
- Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
- --fit-width
- Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
- --print-empty
- Print empty table if there is no data to show.
- --sort-column SORT_COLUMN
- specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
- --sort-ascending
- sort the column(s) in ascending order
- --sort-descending
- sort the column(s) in descending order
- --name <NAME>
- RecordSet Name
- --type <TYPE>
- RecordSet Type
- --data <DATA>
- RecordSet Record Data
- --ttl <TTL>
- Time To Live (Seconds)
- --description <DESCRIPTION>
- Description
- --status <STATUS>
- RecordSet Status
- --action <ACTION>
- RecordSet Action
- --all-projects
- Show results from all projects. Default: False
- --sudo-project-id <SUDO_PROJECT_ID>
- Project ID to impersonate for this command. Default: None
- zone_id
- Zone ID. To list all recordsets specify 'all'
This command is provided by the python-designateclient plugin.
recordset set
Set recordset properties
recordset set
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--record RECORD]
[--description DESCRIPTION | --no-description]
[--ttl TTL | --no-ttl]
[--all-projects]
[--sudo-project-id SUDO_PROJECT_ID]
[--edit-managed]
zone_id
id
- -f <FORMATTER>, --format <FORMATTER>
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated to show multiple columns
- --noindent
- whether to disable indenting the JSON
- --prefix <PREFIX>
- add a prefix to all variable names
- --max-width <integer>
- Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
- --fit-width
- Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
- --print-empty
- Print empty table if there is no data to show.
- --record <RECORD>
- RecordSet Record, repeat if necessary
- --description <DESCRIPTION>
- Description
- --no-description
- --ttl <TTL>
- TTL
- --no-ttl
- --all-projects
- Show results from all projects. Default: False
- --sudo-project-id <SUDO_PROJECT_ID>
- Project ID to impersonate for this command. Default: None
- --edit-managed
- Edit resources marked as managed. Default: False
- zone_id
- Zone ID
- id
- RecordSet ID
This command is provided by the python-designateclient plugin.
recordset show
Show recordset details
recordset show
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--all-projects]
[--sudo-project-id SUDO_PROJECT_ID]
zone_id
id
- -f <FORMATTER>, --format <FORMATTER>
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated to show multiple columns
- --noindent
- whether to disable indenting the JSON
- --prefix <PREFIX>
- add a prefix to all variable names
- --max-width <integer>
- Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
- --fit-width
- Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
- --print-empty
- Print empty table if there is no data to show.
- --all-projects
- Show results from all projects. Default: False
- --sudo-project-id <SUDO_PROJECT_ID>
- Project ID to impersonate for this command. Default: None
- zone_id
- Zone ID
- id
- RecordSet ID
This command is provided by the python-designateclient plugin.
Top Level Domains
tld create
Create new tld
tld create
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
--name NAME
[--description DESCRIPTION]
[--all-projects]
[--sudo-project-id SUDO_PROJECT_ID]
- -f <FORMATTER>, --format <FORMATTER>
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated to show multiple columns
- --noindent
- whether to disable indenting the JSON
- --prefix <PREFIX>
- add a prefix to all variable names
- --max-width <integer>
- Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
- --fit-width
- Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
- --print-empty
- Print empty table if there is no data to show.
- --name <NAME>
- TLD Name
- --description <DESCRIPTION>
- Description
- --all-projects
- Show results from all projects. Default: False
- --sudo-project-id <SUDO_PROJECT_ID>
- Project ID to impersonate for this command. Default: None
This command is provided by the python-designateclient plugin.
tld delete
Delete tld
tld delete [--all-projects] [--sudo-project-id SUDO_PROJECT_ID] id
- --all-projects
- Show results from all projects. Default: False
- --sudo-project-id <SUDO_PROJECT_ID>
- Project ID to impersonate for this command. Default: None
- id
- TLD name or ID
This command is provided by the python-designateclient plugin.
tld list
List tlds
tld list
[-f {csv,json,table,value,yaml}]
[-c COLUMN]
[--quote {all,minimal,none,nonnumeric}]
[--noindent]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending]
[--name NAME]
[--description DESCRIPTION]
[--all-projects]
[--sudo-project-id SUDO_PROJECT_ID]
- -f <FORMATTER>, --format <FORMATTER>
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated to show multiple columns
- --quote <QUOTE_MODE>
- when to include quotes, defaults to nonnumeric
- --noindent
- whether to disable indenting the JSON
- --max-width <integer>
- Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
- --fit-width
- Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
- --print-empty
- Print empty table if there is no data to show.
- --sort-column SORT_COLUMN
- specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
- --sort-ascending
- sort the column(s) in ascending order
- --sort-descending
- sort the column(s) in descending order
- --name <NAME>
- TLD NAME
- --description <DESCRIPTION>
- TLD Description
- --all-projects
- Show results from all projects. Default: False
- --sudo-project-id <SUDO_PROJECT_ID>
- Project ID to impersonate for this command. Default: None
This command is provided by the python-designateclient plugin.
tld set
Set tld properties
tld set
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--name NAME]
[--description DESCRIPTION | --no-description]
[--all-projects]
[--sudo-project-id SUDO_PROJECT_ID]
id
- -f <FORMATTER>, --format <FORMATTER>
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated to show multiple columns
- --noindent
- whether to disable indenting the JSON
- --prefix <PREFIX>
- add a prefix to all variable names
- --max-width <integer>
- Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
- --fit-width
- Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
- --print-empty
- Print empty table if there is no data to show.
- --name <NAME>
- TLD Name
- --description <DESCRIPTION>
- Description
- --no-description
- --all-projects
- Show results from all projects. Default: False
- --sudo-project-id <SUDO_PROJECT_ID>
- Project ID to impersonate for this command. Default: None
- id
- TLD name or ID
This command is provided by the python-designateclient plugin.
tld show
Show tld details
tld show
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--all-projects]
[--sudo-project-id SUDO_PROJECT_ID]
id
- -f <FORMATTER>, --format <FORMATTER>
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated to show multiple columns
- --noindent
- whether to disable indenting the JSON
- --prefix <PREFIX>
- add a prefix to all variable names
- --max-width <integer>
- Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
- --fit-width
- Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
- --print-empty
- Print empty table if there is no data to show.
- --all-projects
- Show results from all projects. Default: False
- --sudo-project-id <SUDO_PROJECT_ID>
- Project ID to impersonate for this command. Default: None
- id
- TLD name or ID
This command is provided by the python-designateclient plugin.
Transaction Signature Keys
tsigkey create
Create new tsigkey
tsigkey create
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
--name NAME
--algorithm ALGORITHM
--secret SECRET
--scope SCOPE
--resource-id RESOURCE_ID
[--all-projects]
[--sudo-project-id SUDO_PROJECT_ID]
- -f <FORMATTER>, --format <FORMATTER>
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated to show multiple columns
- --noindent
- whether to disable indenting the JSON
- --prefix <PREFIX>
- add a prefix to all variable names
- --max-width <integer>
- Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
- --fit-width
- Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
- --print-empty
- Print empty table if there is no data to show.
- --name <NAME>
- TSIGKey Name
- --algorithm <ALGORITHM>
- TSIGKey algorithm
- --secret <SECRET>
- TSIGKey secret
- --scope <SCOPE>
- TSIGKey scope
- --resource-id <RESOURCE_ID>
- TSIGKey resource_id
- --all-projects
- Show results from all projects. Default: False
- --sudo-project-id <SUDO_PROJECT_ID>
- Project ID to impersonate for this command. Default: None
This command is provided by the python-designateclient plugin.
tsigkey delete
Delete tsigkey
tsigkey delete [--all-projects] [--sudo-project-id SUDO_PROJECT_ID] id
- --all-projects
- Show results from all projects. Default: False
- --sudo-project-id <SUDO_PROJECT_ID>
- Project ID to impersonate for this command. Default: None
- id
- TSIGKey ID
This command is provided by the python-designateclient plugin.
tsigkey list
List tsigkeys
tsigkey list
[-f {csv,json,table,value,yaml}]
[-c COLUMN]
[--quote {all,minimal,none,nonnumeric}]
[--noindent]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending]
[--name NAME]
[--algorithm ALGORITHM]
[--scope SCOPE]
[--all-projects]
[--sudo-project-id SUDO_PROJECT_ID]
- -f <FORMATTER>, --format <FORMATTER>
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated to show multiple columns
- --quote <QUOTE_MODE>
- when to include quotes, defaults to nonnumeric
- --noindent
- whether to disable indenting the JSON
- --max-width <integer>
- Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
- --fit-width
- Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
- --print-empty
- Print empty table if there is no data to show.
- --sort-column SORT_COLUMN
- specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
- --sort-ascending
- sort the column(s) in ascending order
- --sort-descending
- sort the column(s) in descending order
- --name <NAME>
- TSIGKey NAME
- --algorithm <ALGORITHM>
- TSIGKey algorithm
- --scope <SCOPE>
- TSIGKey scope
- --all-projects
- Show results from all projects. Default: False
- --sudo-project-id <SUDO_PROJECT_ID>
- Project ID to impersonate for this command. Default: None
This command is provided by the python-designateclient plugin.
tsigkey set
Set tsigkey properties
tsigkey set
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--name NAME]
[--algorithm ALGORITHM]
[--secret SECRET]
[--scope SCOPE]
[--all-projects]
[--sudo-project-id SUDO_PROJECT_ID]
id
- -f <FORMATTER>, --format <FORMATTER>
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated to show multiple columns
- --noindent
- whether to disable indenting the JSON
- --prefix <PREFIX>
- add a prefix to all variable names
- --max-width <integer>
- Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
- --fit-width
- Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
- --print-empty
- Print empty table if there is no data to show.
- --name <NAME>
- TSIGKey Name
- --algorithm <ALGORITHM>
- TSIGKey algorithm
- --secret <SECRET>
- TSIGKey secret
- --scope <SCOPE>
- TSIGKey scope
- --all-projects
- Show results from all projects. Default: False
- --sudo-project-id <SUDO_PROJECT_ID>
- Project ID to impersonate for this command. Default: None
- id
- TSIGKey ID
This command is provided by the python-designateclient plugin.
tsigkey show
Show tsigkey details
tsigkey show
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--all-projects]
[--sudo-project-id SUDO_PROJECT_ID]
id
- -f <FORMATTER>, --format <FORMATTER>
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated to show multiple columns
- --noindent
- whether to disable indenting the JSON
- --prefix <PREFIX>
- add a prefix to all variable names
- --max-width <integer>
- Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
- --fit-width
- Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
- --print-empty
- Print empty table if there is no data to show.
- --all-projects
- Show results from all projects. Default: False
- --sudo-project-id <SUDO_PROJECT_ID>
- Project ID to impersonate for this command. Default: None
- id
- TSIGKey ID
This command is provided by the python-designateclient plugin.
Managing Zones
zone abandon
Abandon a zone
zone abandon [--all-projects] [--sudo-project-id SUDO_PROJECT_ID] id
- --all-projects
- Show results from all projects. Default: False
- --sudo-project-id <SUDO_PROJECT_ID>
- Project ID to impersonate for this command. Default: None
- id
- Zone ID
This command is provided by the python-designateclient plugin.
zone axfr
AXFR a zone
zone axfr [--all-projects] [--sudo-project-id SUDO_PROJECT_ID] id
- --all-projects
- Show results from all projects. Default: False
- --sudo-project-id <SUDO_PROJECT_ID>
- Project ID to impersonate for this command. Default: None
- id
- Zone ID
This command is provided by the python-designateclient plugin.
zone blacklist create
Create new blacklist
zone blacklist create
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
--pattern PATTERN
[--description DESCRIPTION]
[--all-projects]
[--sudo-project-id SUDO_PROJECT_ID]
- -f <FORMATTER>, --format <FORMATTER>
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated to show multiple columns
- --noindent
- whether to disable indenting the JSON
- --prefix <PREFIX>
- add a prefix to all variable names
- --max-width <integer>
- Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
- --fit-width
- Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
- --print-empty
- Print empty table if there is no data to show.
- --pattern <PATTERN>
- Blacklist pattern
- --description <DESCRIPTION>
- Description
- --all-projects
- Show results from all projects. Default: False
- --sudo-project-id <SUDO_PROJECT_ID>
- Project ID to impersonate for this command. Default: None
This command is provided by the python-designateclient plugin.
zone blacklist delete
Delete blacklist
zone blacklist delete
[--all-projects]
[--sudo-project-id SUDO_PROJECT_ID]
id
- --all-projects
- Show results from all projects. Default: False
- --sudo-project-id <SUDO_PROJECT_ID>
- Project ID to impersonate for this command. Default: None
- id
- Blacklist ID
This command is provided by the python-designateclient plugin.
zone blacklist list
List blacklists
zone blacklist list
[-f {csv,json,table,value,yaml}]
[-c COLUMN]
[--quote {all,minimal,none,nonnumeric}]
[--noindent]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending]
[--all-projects]
[--sudo-project-id SUDO_PROJECT_ID]
- -f <FORMATTER>, --format <FORMATTER>
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated to show multiple columns
- --quote <QUOTE_MODE>
- when to include quotes, defaults to nonnumeric
- --noindent
- whether to disable indenting the JSON
- --max-width <integer>
- Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
- --fit-width
- Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
- --print-empty
- Print empty table if there is no data to show.
- --sort-column SORT_COLUMN
- specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
- --sort-ascending
- sort the column(s) in ascending order
- --sort-descending
- sort the column(s) in descending order
- --all-projects
- Show results from all projects. Default: False
- --sudo-project-id <SUDO_PROJECT_ID>
- Project ID to impersonate for this command. Default: None
This command is provided by the python-designateclient plugin.
zone blacklist set
Set blacklist properties
zone blacklist set
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--pattern PATTERN]
[--description DESCRIPTION | --no-description]
[--all-projects]
[--sudo-project-id SUDO_PROJECT_ID]
id
- -f <FORMATTER>, --format <FORMATTER>
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated to show multiple columns
- --noindent
- whether to disable indenting the JSON
- --prefix <PREFIX>
- add a prefix to all variable names
- --max-width <integer>
- Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
- --fit-width
- Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
- --print-empty
- Print empty table if there is no data to show.
- --pattern <PATTERN>
- Blacklist pattern
- --description <DESCRIPTION>
- Description
- --no-description
- --all-projects
- Show results from all projects. Default: False
- --sudo-project-id <SUDO_PROJECT_ID>
- Project ID to impersonate for this command. Default: None
- id
- Blacklist ID
This command is provided by the python-designateclient plugin.
zone blacklist show
Show blacklist details
zone blacklist show
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--all-projects]
[--sudo-project-id SUDO_PROJECT_ID]
id
- -f <FORMATTER>, --format <FORMATTER>
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated to show multiple columns
- --noindent
- whether to disable indenting the JSON
- --prefix <PREFIX>
- add a prefix to all variable names
- --max-width <integer>
- Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
- --fit-width
- Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
- --print-empty
- Print empty table if there is no data to show.
- --all-projects
- Show results from all projects. Default: False
- --sudo-project-id <SUDO_PROJECT_ID>
- Project ID to impersonate for this command. Default: None
- id
- Blacklist ID
This command is provided by the python-designateclient plugin.
zone create
Create new zone
zone create
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--email EMAIL]
[--type {PRIMARY,SECONDARY}]
[--ttl TTL]
[--description DESCRIPTION]
[--masters MASTERS [MASTERS ...]]
[--attributes ATTRIBUTES [ATTRIBUTES ...]]
[--all-projects]
[--sudo-project-id SUDO_PROJECT_ID]
name
- -f <FORMATTER>, --format <FORMATTER>
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated to show multiple columns
- --noindent
- whether to disable indenting the JSON
- --prefix <PREFIX>
- add a prefix to all variable names
- --max-width <integer>
- Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
- --fit-width
- Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
- --print-empty
- Print empty table if there is no data to show.
- --email <EMAIL>
- Zone Email
- --type <TYPE>
- Zone Type
- --ttl <TTL>
- Time To Live (Seconds)
- --description <DESCRIPTION>
- Description
- --masters <MASTERS>
- Zone Masters
- --attributes <ATTRIBUTES>
- Zone Attributes
- --all-projects
- Show results from all projects. Default: False
- --sudo-project-id <SUDO_PROJECT_ID>
- Project ID to impersonate for this command. Default: None
- name
- Zone Name
This command is provided by the python-designateclient plugin.
zone delete
Delete zone
zone delete
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--delete-shares]
[--all-projects]
[--sudo-project-id SUDO_PROJECT_ID]
[--hard-delete]
id
- -f <FORMATTER>, --format <FORMATTER>
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated to show multiple columns
- --noindent
- whether to disable indenting the JSON
- --prefix <PREFIX>
- add a prefix to all variable names
- --max-width <integer>
- Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
- --fit-width
- Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
- --print-empty
- Print empty table if there is no data to show.
- --delete-shares
- Delete existing zone shares. Default: False
- --all-projects
- Show results from all projects. Default: False
- --sudo-project-id <SUDO_PROJECT_ID>
- Project ID to impersonate for this command. Default: None
- --hard-delete
- Delete zone along-with backend zone resources (i.e. files). Default: False
- id
- Zone ID
This command is provided by the python-designateclient plugin.
zone export create
Export a Zone
zone export create
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--all-projects]
[--sudo-project-id SUDO_PROJECT_ID]
zone_id
- -f <FORMATTER>, --format <FORMATTER>
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated to show multiple columns
- --noindent
- whether to disable indenting the JSON
- --prefix <PREFIX>
- add a prefix to all variable names
- --max-width <integer>
- Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
- --fit-width
- Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
- --print-empty
- Print empty table if there is no data to show.
- --all-projects
- Show results from all projects. Default: False
- --sudo-project-id <SUDO_PROJECT_ID>
- Project ID to impersonate for this command. Default: None
- zone_id
- Zone ID
This command is provided by the python-designateclient plugin.
zone export delete
Delete a Zone Export
zone export delete
[--all-projects]
[--sudo-project-id SUDO_PROJECT_ID]
zone_export_id
- --all-projects
- Show results from all projects. Default: False
- --sudo-project-id <SUDO_PROJECT_ID>
- Project ID to impersonate for this command. Default: None
- zone_export_id
- Zone Export ID
This command is provided by the python-designateclient plugin.
zone export list
List Zone Exports
zone export list
[-f {csv,json,table,value,yaml}]
[-c COLUMN]
[--quote {all,minimal,none,nonnumeric}]
[--noindent]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending]
[--all-projects]
[--sudo-project-id SUDO_PROJECT_ID]
- -f <FORMATTER>, --format <FORMATTER>
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated to show multiple columns
- --quote <QUOTE_MODE>
- when to include quotes, defaults to nonnumeric
- --noindent
- whether to disable indenting the JSON
- --max-width <integer>
- Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
- --fit-width
- Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
- --print-empty
- Print empty table if there is no data to show.
- --sort-column SORT_COLUMN
- specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
- --sort-ascending
- sort the column(s) in ascending order
- --sort-descending
- sort the column(s) in descending order
- --all-projects
- Show results from all projects. Default: False
- --sudo-project-id <SUDO_PROJECT_ID>
- Project ID to impersonate for this command. Default: None
This command is provided by the python-designateclient plugin.
zone export show
Show a Zone Export
zone export show
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--all-projects]
[--sudo-project-id SUDO_PROJECT_ID]
zone_export_id
- -f <FORMATTER>, --format <FORMATTER>
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated to show multiple columns
- --noindent
- whether to disable indenting the JSON
- --prefix <PREFIX>
- add a prefix to all variable names
- --max-width <integer>
- Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
- --fit-width
- Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
- --print-empty
- Print empty table if there is no data to show.
- --all-projects
- Show results from all projects. Default: False
- --sudo-project-id <SUDO_PROJECT_ID>
- Project ID to impersonate for this command. Default: None
- zone_export_id
- Zone Export ID
This command is provided by the python-designateclient plugin.
zone export showfile
Show the zone file for the Zone Export
zone export showfile
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--all-projects]
[--sudo-project-id SUDO_PROJECT_ID]
zone_export_id
- -f <FORMATTER>, --format <FORMATTER>
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated to show multiple columns
- --noindent
- whether to disable indenting the JSON
- --prefix <PREFIX>
- add a prefix to all variable names
- --max-width <integer>
- Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
- --fit-width
- Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
- --print-empty
- Print empty table if there is no data to show.
- --all-projects
- Show results from all projects. Default: False
- --sudo-project-id <SUDO_PROJECT_ID>
- Project ID to impersonate for this command. Default: None
- zone_export_id
- Zone Export ID
This command is provided by the python-designateclient plugin.
zone import create
Import a Zone from a file on the filesystem
zone import create
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--all-projects]
[--sudo-project-id SUDO_PROJECT_ID]
zone_file_path
- -f <FORMATTER>, --format <FORMATTER>
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated to show multiple columns
- --noindent
- whether to disable indenting the JSON
- --prefix <PREFIX>
- add a prefix to all variable names
- --max-width <integer>
- Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
- --fit-width
- Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
- --print-empty
- Print empty table if there is no data to show.
- --all-projects
- Show results from all projects. Default: False
- --sudo-project-id <SUDO_PROJECT_ID>
- Project ID to impersonate for this command. Default: None
- zone_file_path
- Path to a zone file
This command is provided by the python-designateclient plugin.
zone import delete
Delete a Zone Import
zone import delete
[--all-projects]
[--sudo-project-id SUDO_PROJECT_ID]
zone_import_id
- --all-projects
- Show results from all projects. Default: False
- --sudo-project-id <SUDO_PROJECT_ID>
- Project ID to impersonate for this command. Default: None
- zone_import_id
- Zone Import ID
This command is provided by the python-designateclient plugin.
zone import list
List Zone Imports
zone import list
[-f {csv,json,table,value,yaml}]
[-c COLUMN]
[--quote {all,minimal,none,nonnumeric}]
[--noindent]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending]
[--all-projects]
[--sudo-project-id SUDO_PROJECT_ID]
- -f <FORMATTER>, --format <FORMATTER>
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated to show multiple columns
- --quote <QUOTE_MODE>
- when to include quotes, defaults to nonnumeric
- --noindent
- whether to disable indenting the JSON
- --max-width <integer>
- Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
- --fit-width
- Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
- --print-empty
- Print empty table if there is no data to show.
- --sort-column SORT_COLUMN
- specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
- --sort-ascending
- sort the column(s) in ascending order
- --sort-descending
- sort the column(s) in descending order
- --all-projects
- Show results from all projects. Default: False
- --sudo-project-id <SUDO_PROJECT_ID>
- Project ID to impersonate for this command. Default: None
This command is provided by the python-designateclient plugin.
zone import show
Show a Zone Import
zone import show
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--all-projects]
[--sudo-project-id SUDO_PROJECT_ID]
zone_import_id
- -f <FORMATTER>, --format <FORMATTER>
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated to show multiple columns
- --noindent
- whether to disable indenting the JSON
- --prefix <PREFIX>
- add a prefix to all variable names
- --max-width <integer>
- Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
- --fit-width
- Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
- --print-empty
- Print empty table if there is no data to show.
- --all-projects
- Show results from all projects. Default: False
- --sudo-project-id <SUDO_PROJECT_ID>
- Project ID to impersonate for this command. Default: None
- zone_import_id
- Zone Import ID
This command is provided by the python-designateclient plugin.
zone list
List zones
zone list
[-f {csv,json,table,value,yaml}]
[-c COLUMN]
[--quote {all,minimal,none,nonnumeric}]
[--noindent]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending]
[--name NAME]
[--email EMAIL]
[--type {PRIMARY,SECONDARY}]
[--ttl TTL]
[--description DESCRIPTION]
[--status STATUS]
[--all-projects]
[--sudo-project-id SUDO_PROJECT_ID]
- -f <FORMATTER>, --format <FORMATTER>
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated to show multiple columns
- --quote <QUOTE_MODE>
- when to include quotes, defaults to nonnumeric
- --noindent
- whether to disable indenting the JSON
- --max-width <integer>
- Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
- --fit-width
- Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
- --print-empty
- Print empty table if there is no data to show.
- --sort-column SORT_COLUMN
- specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
- --sort-ascending
- sort the column(s) in ascending order
- --sort-descending
- sort the column(s) in descending order
- --name <NAME>
- Zone Name
- --email <EMAIL>
- Zone Email
- --type <TYPE>
- Zone Type
- --ttl <TTL>
- Time To Live (Seconds)
- --description <DESCRIPTION>
- Description
- --status <STATUS>
- Zone Status
- --all-projects
- Show results from all projects. Default: False
- --sudo-project-id <SUDO_PROJECT_ID>
- Project ID to impersonate for this command. Default: None
This command is provided by the python-designateclient plugin.
zone set
Set zone properties
zone set
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--email EMAIL]
[--ttl TTL]
[--description DESCRIPTION | --no-description]
[--masters MASTERS [MASTERS ...]]
[--all-projects]
[--sudo-project-id SUDO_PROJECT_ID]
id
- -f <FORMATTER>, --format <FORMATTER>
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated to show multiple columns
- --noindent
- whether to disable indenting the JSON
- --prefix <PREFIX>
- add a prefix to all variable names
- --max-width <integer>
- Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
- --fit-width
- Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
- --print-empty
- Print empty table if there is no data to show.
- --email <EMAIL>
- Zone Email
- --ttl <TTL>
- Time To Live (Seconds)
- --description <DESCRIPTION>
- Description
- --no-description
- --masters <MASTERS>
- Zone Masters
- --all-projects
- Show results from all projects. Default: False
- --sudo-project-id <SUDO_PROJECT_ID>
- Project ID to impersonate for this command. Default: None
- id
- Zone ID
This command is provided by the python-designateclient plugin.
zone share create
Share a Zone
zone share create
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--all-projects]
[--sudo-project-id SUDO_PROJECT_ID]
zone
target_project_id
- -f <FORMATTER>, --format <FORMATTER>
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated to show multiple columns
- --noindent
- whether to disable indenting the JSON
- --prefix <PREFIX>
- add a prefix to all variable names
- --max-width <integer>
- Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
- --fit-width
- Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
- --print-empty
- Print empty table if there is no data to show.
- --all-projects
- Show results from all projects. Default: False
- --sudo-project-id <SUDO_PROJECT_ID>
- Project ID to impersonate for this command. Default: None
- zone
- The zone name or ID to share.
- target_project_id
- Target project ID to share the zone with.
This command is provided by the python-designateclient plugin.
zone share delete
Delete a Zone Share
zone share delete
[--all-projects]
[--sudo-project-id SUDO_PROJECT_ID]
zone
shared_zone_id
- --all-projects
- Show results from all projects. Default: False
- --sudo-project-id <SUDO_PROJECT_ID>
- Project ID to impersonate for this command. Default: None
- zone
- The zone name or ID to share.
- The zone share ID to delete.
This command is provided by the python-designateclient plugin.
zone share list
List Zone Shares
zone share list
[-f {csv,json,table,value,yaml}]
[-c COLUMN]
[--quote {all,minimal,none,nonnumeric}]
[--noindent]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending]
[--all-projects]
[--sudo-project-id SUDO_PROJECT_ID]
[--target-project-id TARGET_PROJECT_ID]
zone
- -f <FORMATTER>, --format <FORMATTER>
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated to show multiple columns
- --quote <QUOTE_MODE>
- when to include quotes, defaults to nonnumeric
- --noindent
- whether to disable indenting the JSON
- --max-width <integer>
- Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
- --fit-width
- Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
- --print-empty
- Print empty table if there is no data to show.
- --sort-column SORT_COLUMN
- specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
- --sort-ascending
- sort the column(s) in ascending order
- --sort-descending
- sort the column(s) in descending order
- --all-projects
- Show results from all projects. Default: False
- --sudo-project-id <SUDO_PROJECT_ID>
- Project ID to impersonate for this command. Default: None
- --target-project-id <TARGET_PROJECT_ID>
- The target project ID to filter on.
- zone
- The zone name or ID to share.
This command is provided by the python-designateclient plugin.
zone share show
Show Zone Share Details
zone share show
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--all-projects]
[--sudo-project-id SUDO_PROJECT_ID]
zone
shared_zone_id
- -f <FORMATTER>, --format <FORMATTER>
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated to show multiple columns
- --noindent
- whether to disable indenting the JSON
- --prefix <PREFIX>
- add a prefix to all variable names
- --max-width <integer>
- Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
- --fit-width
- Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
- --print-empty
- Print empty table if there is no data to show.
- --all-projects
- Show results from all projects. Default: False
- --sudo-project-id <SUDO_PROJECT_ID>
- Project ID to impersonate for this command. Default: None
- zone
- The zone name or ID to share.
- The zone share ID to show.
This command is provided by the python-designateclient plugin.
zone show
Show zone details
zone show
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--all-projects]
[--sudo-project-id SUDO_PROJECT_ID]
id
- -f <FORMATTER>, --format <FORMATTER>
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated to show multiple columns
- --noindent
- whether to disable indenting the JSON
- --prefix <PREFIX>
- add a prefix to all variable names
- --max-width <integer>
- Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
- --fit-width
- Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
- --print-empty
- Print empty table if there is no data to show.
- --all-projects
- Show results from all projects. Default: False
- --sudo-project-id <SUDO_PROJECT_ID>
- Project ID to impersonate for this command. Default: None
- id
- Zone ID
This command is provided by the python-designateclient plugin.
zone transfer accept list
List Zone Transfer Accepts
zone transfer accept list
[-f {csv,json,table,value,yaml}]
[-c COLUMN]
[--quote {all,minimal,none,nonnumeric}]
[--noindent]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending]
[--all-projects]
[--sudo-project-id SUDO_PROJECT_ID]
- -f <FORMATTER>, --format <FORMATTER>
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated to show multiple columns
- --quote <QUOTE_MODE>
- when to include quotes, defaults to nonnumeric
- --noindent
- whether to disable indenting the JSON
- --max-width <integer>
- Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
- --fit-width
- Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
- --print-empty
- Print empty table if there is no data to show.
- --sort-column SORT_COLUMN
- specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
- --sort-ascending
- sort the column(s) in ascending order
- --sort-descending
- sort the column(s) in descending order
- --all-projects
- Show results from all projects. Default: False
- --sudo-project-id <SUDO_PROJECT_ID>
- Project ID to impersonate for this command. Default: None
This command is provided by the python-designateclient plugin.
zone transfer accept request
Accept a Zone Transfer Request
zone transfer accept request
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
--transfer-id TRANSFER_ID
--key KEY
[--all-projects]
[--sudo-project-id SUDO_PROJECT_ID]
- -f <FORMATTER>, --format <FORMATTER>
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated to show multiple columns
- --noindent
- whether to disable indenting the JSON
- --prefix <PREFIX>
- add a prefix to all variable names
- --max-width <integer>
- Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
- --fit-width
- Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
- --print-empty
- Print empty table if there is no data to show.
- --transfer-id <TRANSFER_ID>
- Transfer ID
- --key <KEY>
- Transfer Key
- --all-projects
- Show results from all projects. Default: False
- --sudo-project-id <SUDO_PROJECT_ID>
- Project ID to impersonate for this command. Default: None
This command is provided by the python-designateclient plugin.
zone transfer accept show
Show Zone Transfer Accept
zone transfer accept show
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--all-projects]
[--sudo-project-id SUDO_PROJECT_ID]
id
- -f <FORMATTER>, --format <FORMATTER>
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated to show multiple columns
- --noindent
- whether to disable indenting the JSON
- --prefix <PREFIX>
- add a prefix to all variable names
- --max-width <integer>
- Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
- --fit-width
- Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
- --print-empty
- Print empty table if there is no data to show.
- --all-projects
- Show results from all projects. Default: False
- --sudo-project-id <SUDO_PROJECT_ID>
- Project ID to impersonate for this command. Default: None
- id
- Zone Tranfer Accept ID
This command is provided by the python-designateclient plugin.
zone transfer request create
Create new zone transfer request
zone transfer request create
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--target-project-id TARGET_PROJECT_ID]
[--description DESCRIPTION]
[--all-projects]
[--sudo-project-id SUDO_PROJECT_ID]
zone_id
- -f <FORMATTER>, --format <FORMATTER>
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated to show multiple columns
- --noindent
- whether to disable indenting the JSON
- --prefix <PREFIX>
- add a prefix to all variable names
- --max-width <integer>
- Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
- --fit-width
- Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
- --print-empty
- Print empty table if there is no data to show.
- --target-project-id <TARGET_PROJECT_ID>
- Target Project ID to transfer to.
- --description <DESCRIPTION>
- Description
- --all-projects
- Show results from all projects. Default: False
- --sudo-project-id <SUDO_PROJECT_ID>
- Project ID to impersonate for this command. Default: None
- zone_id
- Zone ID to transfer.
This command is provided by the python-designateclient plugin.
zone transfer request delete
Delete a Zone Transfer Request
zone transfer request delete
[--all-projects]
[--sudo-project-id SUDO_PROJECT_ID]
id
- --all-projects
- Show results from all projects. Default: False
- --sudo-project-id <SUDO_PROJECT_ID>
- Project ID to impersonate for this command. Default: None
- id
- Zone Transfer Request ID
This command is provided by the python-designateclient plugin.
zone transfer request list
List Zone Transfer Requests
zone transfer request list
[-f {csv,json,table,value,yaml}]
[-c COLUMN]
[--quote {all,minimal,none,nonnumeric}]
[--noindent]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending]
[--all-projects]
[--sudo-project-id SUDO_PROJECT_ID]
- -f <FORMATTER>, --format <FORMATTER>
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated to show multiple columns
- --quote <QUOTE_MODE>
- when to include quotes, defaults to nonnumeric
- --noindent
- whether to disable indenting the JSON
- --max-width <integer>
- Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
- --fit-width
- Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
- --print-empty
- Print empty table if there is no data to show.
- --sort-column SORT_COLUMN
- specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
- --sort-ascending
- sort the column(s) in ascending order
- --sort-descending
- sort the column(s) in descending order
- --all-projects
- Show results from all projects. Default: False
- --sudo-project-id <SUDO_PROJECT_ID>
- Project ID to impersonate for this command. Default: None
This command is provided by the python-designateclient plugin.
zone transfer request set
Set a Zone Transfer Request
zone transfer request set
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--description DESCRIPTION | --no-description]
[--target-project-id TARGET_PROJECT_ID]
[--all-projects]
[--sudo-project-id SUDO_PROJECT_ID]
id
- -f <FORMATTER>, --format <FORMATTER>
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated to show multiple columns
- --noindent
- whether to disable indenting the JSON
- --prefix <PREFIX>
- add a prefix to all variable names
- --max-width <integer>
- Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
- --fit-width
- Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
- --print-empty
- Print empty table if there is no data to show.
- --description <DESCRIPTION>
- Description
- --no-description
- --target-project-id <TARGET_PROJECT_ID>
- Target Project ID to transfer to.
- --all-projects
- Show results from all projects. Default: False
- --sudo-project-id <SUDO_PROJECT_ID>
- Project ID to impersonate for this command. Default: None
- id
- Zone Transfer Request ID
This command is provided by the python-designateclient plugin.
zone transfer request show
Show Zone Transfer Request Details
zone transfer request show
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--all-projects]
[--sudo-project-id SUDO_PROJECT_ID]
id
- -f <FORMATTER>, --format <FORMATTER>
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated to show multiple columns
- --noindent
- whether to disable indenting the JSON
- --prefix <PREFIX>
- add a prefix to all variable names
- --max-width <integer>
- Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
- --fit-width
- Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
- --print-empty
- Print empty table if there is no data to show.
- --all-projects
- Show results from all projects. Default: False
- --sudo-project-id <SUDO_PROJECT_ID>
- Project ID to impersonate for this command. Default: None
- id
- Zone Tranfer Request ID
This command is provided by the python-designateclient plugin.
CONTRIBUTORS GUIDE
Contributing
Code is hosted on GitHub. Submit bugs to the Designate Client project on Launchpad. Submit code to the openstack/python-designateclient project using Gerrit.
Here's a quick summary:
Install the git-review package to make life easier
pip install git-review
Branch, work, & submit:
# cut a new branch, tracking master git checkout --track -b bug/id origin/master # work work work git add stuff git commit # rebase/squash to a single commit before submitting git rebase -i # submit git-review
Functional Tests
The functional tests invoke the client executable to see that it actually works with a running Designate. WARNING: these tests will create and delete zones, recordsets, and other resources in Designate.
Installation
cd python-designateclient pip install python-openstackclient pip install -r requirements.txt -r test-requirements.txt pip install -e .
Configuration
The functional tests look for a variable TEMPEST_CONFIG which specifies a config file for the test.
export TEMPEST_CONFIG=tempest.conf
The tests will use Keystone to grab the Designate endpoint to test against. They need at least three users (two regular users, and one admin) for all the tests to run.
[identity] uri = http://localhost:5000/v2.0 uri_v3 = http://localhost:5000/v3 auth_version = v2 region = RegionOne username = demo tenant_name = demo password = password domain_name = Default alt_username = alt_demo alt_tenant_name = alt_demo alt_password = password alt_domain_name = Default admin_username = admin admin_tenant_name = admin admin_password = password admin_domain_name = Default [designateclient] # the directory containing the openstack executable directory=/root/python-designateclient/.venv/bin
Running the tests
The functional tests are run with tox (installed with pip install tox):
tox -e functional
PYTHON-DESIGNATECLIENT PACKAGE REFERENCE
designateclient
designateclient package
Subpackages
designateclient.osc package
Submodules
designateclient.osc.plugin module
OpenStackClient plugin for DNS service.
- designateclient.osc.plugin.build_option_parser(parser)
- Hook to add global options.
- designateclient.osc.plugin.make_client(instance)
Module contents
designateclient.v2 package
Subpackages
designateclient.v2.cli package
Submodules
designateclient.v2.cli.blacklists module
- class designateclient.v2.cli.blacklists.CreateBlacklistCommand(app, app_args, cmd_name=None)
- Bases: ShowOne
Create new blacklist
- get_parser(prog_name)
- Return an argparse.ArgumentParser.
- log = <Logger designateclient.v2.cli.blacklists.CreateBlacklistCommand (WARNING)>
- take_action(parsed_args)
- Return a two-part tuple with a tuple of column names and a tuple of values.
- class designateclient.v2.cli.blacklists.DeleteBlacklistCommand(app, app_args, cmd_name=None)
- Bases: Command
Delete blacklist
- get_parser(prog_name)
- Return an argparse.ArgumentParser.
- log = <Logger designateclient.v2.cli.blacklists.DeleteBlacklistCommand (WARNING)>
- take_action(parsed_args)
- Override to do something useful.
The returned value will be returned by the program.
- class designateclient.v2.cli.blacklists.ListBlacklistsCommand(app, app_args, cmd_name=None)
- Bases: Lister
List blacklists
- columns = ['id', 'pattern', 'description']
- get_parser(prog_name)
- Return an argparse.ArgumentParser.
- log = <Logger designateclient.v2.cli.blacklists.ListBlacklistsCommand (WARNING)>
- take_action(parsed_args)
- Run command.
Return a tuple containing the column names and an iterable containing the data to be listed.
- class designateclient.v2.cli.blacklists.SetBlacklistCommand(app, app_args, cmd_name=None)
- Bases: ShowOne
Set blacklist properties
- get_parser(prog_name)
- Return an argparse.ArgumentParser.
- log = <Logger designateclient.v2.cli.blacklists.SetBlacklistCommand (WARNING)>
- take_action(parsed_args)
- Return a two-part tuple with a tuple of column names and a tuple of values.
- class designateclient.v2.cli.blacklists.ShowBlacklistCommand(app, app_args, cmd_name=None)
- Bases: ShowOne
Show blacklist details
- get_parser(prog_name)
- Return an argparse.ArgumentParser.
- log = <Logger designateclient.v2.cli.blacklists.ShowBlacklistCommand (WARNING)>
- take_action(parsed_args)
- Return a two-part tuple with a tuple of column names and a tuple of values.
designateclient.v2.cli.common module
- designateclient.v2.cli.common.add_all_common_options(parser)
- designateclient.v2.cli.common.add_all_projects_option(parser)
- designateclient.v2.cli.common.add_edit_managed_option(parser)
- designateclient.v2.cli.common.add_hard_delete_option(parser)
- designateclient.v2.cli.common.add_sudo_project_id_option(parser)
- designateclient.v2.cli.common.set_all_common_headers(client, parsed_args)
- designateclient.v2.cli.common.set_all_projects(client, value)
- designateclient.v2.cli.common.set_edit_managed(client, value)
- designateclient.v2.cli.common.set_hard_delete(client, value)
- designateclient.v2.cli.common.set_sudo_project_id(client, value)
designateclient.v2.cli.quotas module
- class designateclient.v2.cli.quotas.ListQuotasCommand(app, app_args, cmd_name=None)
- Bases: ShowOne
List quotas
- get_parser(prog_name)
- Return an argparse.ArgumentParser.
- take_action(parsed_args)
- Return a two-part tuple with a tuple of column names and a tuple of values.
- class designateclient.v2.cli.quotas.ResetQuotasCommand(app, app_args, cmd_name=None)
- Bases: Command
Reset quotas
- get_parser(prog_name)
- Return an argparse.ArgumentParser.
- take_action(parsed_args)
- Override to do something useful.
The returned value will be returned by the program.
- class designateclient.v2.cli.quotas.SetQuotasCommand(app, app_args, cmd_name=None)
- Bases: ShowOne
Set quotas
- get_parser(prog_name)
- Return an argparse.ArgumentParser.
- take_action(parsed_args)
- Return a two-part tuple with a tuple of column names and a tuple of values.
designateclient.v2.cli.recordsets module
- class designateclient.v2.cli.recordsets.CreateRecordSetCommand(app, app_args, cmd_name=None)
- Bases: ShowOne
Create new recordset
- get_parser(prog_name)
- Return an argparse.ArgumentParser.
- log = <Logger deprecated (WARNING)>
- take_action(parsed_args)
- Return a two-part tuple with a tuple of column names and a tuple of values.
- class designateclient.v2.cli.recordsets.DeleteRecordSetCommand(app, app_args, cmd_name=None)
- Bases: ShowOne
Delete recordset
- get_parser(prog_name)
- Return an argparse.ArgumentParser.
- log = <Logger designateclient.v2.cli.recordsets.DeleteRecordSetCommand (WARNING)>
- take_action(parsed_args)
- Return a two-part tuple with a tuple of column names and a tuple of values.
- class designateclient.v2.cli.recordsets.ListRecordSetsCommand(app, app_args, cmd_name=None)
- Bases: Lister
List recordsets
- columns = ['id', 'name', 'type', 'records', 'status', 'action']
- get_parser(prog_name)
- Return an argparse.ArgumentParser.
- log = <Logger designateclient.v2.cli.recordsets.ListRecordSetsCommand (WARNING)>
- take_action(parsed_args)
- Run command.
Return a tuple containing the column names and an iterable containing the data to be listed.
- class designateclient.v2.cli.recordsets.SetRecordSetCommand(app, app_args, cmd_name=None)
- Bases: ShowOne
Set recordset properties
- get_parser(prog_name)
- Return an argparse.ArgumentParser.
- log = <Logger designateclient.v2.cli.recordsets.SetRecordSetCommand (WARNING)>
- take_action(parsed_args)
- Return a two-part tuple with a tuple of column names and a tuple of values.
- class designateclient.v2.cli.recordsets.ShowRecordSetCommand(app, app_args, cmd_name=None)
- Bases: ShowOne
Show recordset details
- get_parser(prog_name)
- Return an argparse.ArgumentParser.
- log = <Logger designateclient.v2.cli.recordsets.ShowRecordSetCommand (WARNING)>
- take_action(parsed_args)
- Return a two-part tuple with a tuple of column names and a tuple of values.
designateclient.v2.cli.reverse module
- class designateclient.v2.cli.reverse.ListFloatingIPCommand(app, app_args, cmd_name=None)
- Bases: Lister
List floatingip ptr records
- columns = ['id', 'ptrdname', 'description', 'ttl']
- get_parser(prog_name)
- Return an argparse.ArgumentParser.
- log = <Logger designateclient.v2.cli.reverse.ListFloatingIPCommand (WARNING)>
- take_action(parsed_args)
- Run command.
Return a tuple containing the column names and an iterable containing the data to be listed.
- class designateclient.v2.cli.reverse.SetFloatingIPCommand(app, app_args, cmd_name=None)
- Bases: ShowOne
Set floatingip ptr record
- get_parser(prog_name)
- Return an argparse.ArgumentParser.
- log = <Logger designateclient.v2.cli.reverse.SetFloatingIPCommand (WARNING)>
- take_action(parsed_args)
- Return a two-part tuple with a tuple of column names and a tuple of values.
- class designateclient.v2.cli.reverse.ShowFloatingIPCommand(app, app_args, cmd_name=None)
- Bases: ShowOne
Show floatingip ptr record details
- get_parser(prog_name)
- Return an argparse.ArgumentParser.
- log = <Logger designateclient.v2.cli.reverse.ShowFloatingIPCommand (WARNING)>
- take_action(parsed_args)
- Return a two-part tuple with a tuple of column names and a tuple of values.
- class designateclient.v2.cli.reverse.UnsetFloatingIPCommand(app, app_args, cmd_name=None)
- Bases: Command
Unset floatingip ptr record
- get_parser(prog_name)
- Return an argparse.ArgumentParser.
- log = <Logger designateclient.v2.cli.reverse.UnsetFloatingIPCommand (WARNING)>
- take_action(parsed_args)
- Override to do something useful.
The returned value will be returned by the program.
designateclient.v2.cli.service_statuses module
- class designateclient.v2.cli.service_statuses.ListServiceStatusesCommand(app, app_args, cmd_name=None)
- Bases: Lister
List service statuses
- columns = ['id', 'hostname', 'service_name', 'status', 'stats', 'capabilities']
- get_parser(prog_name)
- Return an argparse.ArgumentParser.
- log = <Logger designateclient.v2.cli.service_statuses.ListServiceStatusesCommand (WARNING)>
- take_action(parsed_args)
- Run command.
Return a tuple containing the column names and an iterable containing the data to be listed.
- class designateclient.v2.cli.service_statuses.ShowServiceStatusCommand(app, app_args, cmd_name=None)
- Bases: ShowOne
Show service status details
- get_parser(prog_name)
- Return an argparse.ArgumentParser.
- log = <Logger designateclient.v2.cli.service_statuses.ShowServiceStatusCommand (WARNING)>
- take_action(parsed_args)
- Return a two-part tuple with a tuple of column names and a tuple of values.
designateclient.v2.cli.tlds module
- class designateclient.v2.cli.tlds.CreateTLDCommand(app, app_args, cmd_name=None)
- Bases: ShowOne
Create new tld
- get_parser(prog_name)
- Return an argparse.ArgumentParser.
- log = <Logger designateclient.v2.cli.tlds.CreateTLDCommand (WARNING)>
- take_action(parsed_args)
- Return a two-part tuple with a tuple of column names and a tuple of values.
- class designateclient.v2.cli.tlds.DeleteTLDCommand(app, app_args, cmd_name=None)
- Bases: Command
Delete tld
- get_parser(prog_name)
- Return an argparse.ArgumentParser.
- log = <Logger designateclient.v2.cli.tlds.DeleteTLDCommand (WARNING)>
- take_action(parsed_args)
- Override to do something useful.
The returned value will be returned by the program.
- class designateclient.v2.cli.tlds.ListTLDsCommand(app, app_args, cmd_name=None)
- Bases: Lister
List tlds
- columns = ['id', 'name', 'description']
- get_parser(prog_name)
- Return an argparse.ArgumentParser.
- log = <Logger designateclient.v2.cli.tlds.ListTLDsCommand (WARNING)>
- take_action(parsed_args)
- Run command.
Return a tuple containing the column names and an iterable containing the data to be listed.
- class designateclient.v2.cli.tlds.SetTLDCommand(app, app_args, cmd_name=None)
- Bases: ShowOne
Set tld properties
- get_parser(prog_name)
- Return an argparse.ArgumentParser.
- log = <Logger designateclient.v2.cli.tlds.SetTLDCommand (WARNING)>
- take_action(parsed_args)
- Return a two-part tuple with a tuple of column names and a tuple of values.
- class designateclient.v2.cli.tlds.ShowTLDCommand(app, app_args, cmd_name=None)
- Bases: ShowOne
Show tld details
- get_parser(prog_name)
- Return an argparse.ArgumentParser.
- log = <Logger designateclient.v2.cli.tlds.ShowTLDCommand (WARNING)>
- take_action(parsed_args)
- Return a two-part tuple with a tuple of column names and a tuple of values.
designateclient.v2.cli.tsigkeys module
- class designateclient.v2.cli.tsigkeys.CreateTSIGKeyCommand(app, app_args, cmd_name=None)
- Bases: ShowOne
Create new tsigkey
- get_parser(prog_name)
- Return an argparse.ArgumentParser.
- log = <Logger designateclient.v2.cli.tsigkeys.CreateTSIGKeyCommand (WARNING)>
- take_action(parsed_args)
- Return a two-part tuple with a tuple of column names and a tuple of values.
- class designateclient.v2.cli.tsigkeys.DeleteTSIGKeyCommand(app, app_args, cmd_name=None)
- Bases: Command
Delete tsigkey
- get_parser(prog_name)
- Return an argparse.ArgumentParser.
- log = <Logger designateclient.v2.cli.tsigkeys.DeleteTSIGKeyCommand (WARNING)>
- take_action(parsed_args)
- Override to do something useful.
The returned value will be returned by the program.
- class designateclient.v2.cli.tsigkeys.ListTSIGKeysCommand(app, app_args, cmd_name=None)
- Bases: Lister
List tsigkeys
- columns = ['id', 'name', 'algorithm', 'secret', 'scope', 'resource_id']
- get_parser(prog_name)
- Return an argparse.ArgumentParser.
- log = <Logger designateclient.v2.cli.tsigkeys.ListTSIGKeysCommand (WARNING)>
- take_action(parsed_args)
- Run command.
Return a tuple containing the column names and an iterable containing the data to be listed.
- class designateclient.v2.cli.tsigkeys.SetTSIGKeyCommand(app, app_args, cmd_name=None)
- Bases: ShowOne
Set tsigkey properties
- get_parser(prog_name)
- Return an argparse.ArgumentParser.
- log = <Logger designateclient.v2.cli.tsigkeys.SetTSIGKeyCommand (WARNING)>
- take_action(parsed_args)
- Return a two-part tuple with a tuple of column names and a tuple of values.
- class designateclient.v2.cli.tsigkeys.ShowTSIGKeyCommand(app, app_args, cmd_name=None)
- Bases: ShowOne
Show tsigkey details
- get_parser(prog_name)
- Return an argparse.ArgumentParser.
- log = <Logger designateclient.v2.cli.tsigkeys.ShowTSIGKeyCommand (WARNING)>
- take_action(parsed_args)
- Return a two-part tuple with a tuple of column names and a tuple of values.
designateclient.v2.cli.zones module
- class designateclient.v2.cli.zones.AXFRZoneCommand(app, app_args, cmd_name=None)
- Bases: Command
AXFR a zone
- get_parser(prog_name)
- Return an argparse.ArgumentParser.
- log = <Logger designateclient.v2.cli.zones.AXFRZoneCommand (WARNING)>
- take_action(parsed_args)
- Override to do something useful.
The returned value will be returned by the program.
- class designateclient.v2.cli.zones.AbandonZoneCommand(app, app_args, cmd_name=None)
- Bases: Command
Abandon a zone
- get_parser(prog_name)
- Return an argparse.ArgumentParser.
- log = <Logger designateclient.v2.cli.zones.AbandonZoneCommand (WARNING)>
- take_action(parsed_args)
- Override to do something useful.
The returned value will be returned by the program.
- class designateclient.v2.cli.zones.AcceptTransferRequestCommand(app, app_args, cmd_name=None)
- Bases: ShowOne
Accept a Zone Transfer Request
- get_parser(prog_name)
- Return an argparse.ArgumentParser.
- log = <Logger designateclient.v2.cli.zones.AcceptTransferRequestCommand (WARNING)>
- take_action(parsed_args)
- Return a two-part tuple with a tuple of column names and a tuple of values.
- class designateclient.v2.cli.zones.CreateTransferRequestCommand(app, app_args, cmd_name=None)
- Bases: ShowOne
Create new zone transfer request
- get_parser(prog_name)
- Return an argparse.ArgumentParser.
- log = <Logger designateclient.v2.cli.zones.CreateTransferRequestCommand (WARNING)>
- take_action(parsed_args)
- Return a two-part tuple with a tuple of column names and a tuple of values.
- class designateclient.v2.cli.zones.CreateZoneCommand(app, app_args, cmd_name=None)
- Bases: ShowOne
Create new zone
- get_parser(prog_name)
- Return an argparse.ArgumentParser.
- log = <Logger designateclient.v2.cli.zones.CreateZoneCommand (WARNING)>
- take_action(parsed_args)
- Return a two-part tuple with a tuple of column names and a tuple of values.
- class designateclient.v2.cli.zones.DeleteSharedZoneCommand(app, app_args, cmd_name=None)
- Bases: Command
Delete a Zone Share
- get_parser(prog_name)
- Return an argparse.ArgumentParser.
- log = <Logger designateclient.v2.cli.zones.DeleteSharedZoneCommand (WARNING)>
- take_action(parsed_args)
- Override to do something useful.
The returned value will be returned by the program.
- class designateclient.v2.cli.zones.DeleteTransferRequestCommand(app, app_args, cmd_name=None)
- Bases: Command
Delete a Zone Transfer Request
- get_parser(prog_name)
- Return an argparse.ArgumentParser.
- log = <Logger designateclient.v2.cli.zones.DeleteTransferRequestCommand (WARNING)>
- take_action(parsed_args)
- Override to do something useful.
The returned value will be returned by the program.
- class designateclient.v2.cli.zones.DeleteZoneCommand(app, app_args, cmd_name=None)
- Bases: ShowOne
Delete zone
- get_parser(prog_name)
- Return an argparse.ArgumentParser.
- log = <Logger designateclient.v2.cli.zones.DeleteZoneCommand (WARNING)>
- take_action(parsed_args)
- Return a two-part tuple with a tuple of column names and a tuple of values.
- class designateclient.v2.cli.zones.DeleteZoneExportCommand(app, app_args, cmd_name=None)
- Bases: Command
Delete a Zone Export
- get_parser(prog_name)
- Return an argparse.ArgumentParser.
- log = <Logger designateclient.v2.cli.zones.DeleteZoneExportCommand (WARNING)>
- take_action(parsed_args)
- Override to do something useful.
The returned value will be returned by the program.
- class designateclient.v2.cli.zones.DeleteZoneImportCommand(app, app_args, cmd_name=None)
- Bases: Command
Delete a Zone Import
- get_parser(prog_name)
- Return an argparse.ArgumentParser.
- log = <Logger designateclient.v2.cli.zones.DeleteZoneImportCommand (WARNING)>
- take_action(parsed_args)
- Override to do something useful.
The returned value will be returned by the program.
- class designateclient.v2.cli.zones.ExportZoneCommand(app, app_args, cmd_name=None)
- Bases: ShowOne
Export a Zone
- get_parser(prog_name)
- Return an argparse.ArgumentParser.
- log = <Logger designateclient.v2.cli.zones.ExportZoneCommand (WARNING)>
- take_action(parsed_args)
- Return a two-part tuple with a tuple of column names and a tuple of values.
- class designateclient.v2.cli.zones.ImportZoneCommand(app, app_args, cmd_name=None)
- Bases: ShowOne
Import a Zone from a file on the filesystem
- get_parser(prog_name)
- Return an argparse.ArgumentParser.
- log = <Logger designateclient.v2.cli.zones.ImportZoneCommand (WARNING)>
- take_action(parsed_args)
- Return a two-part tuple with a tuple of column names and a tuple of values.
- class designateclient.v2.cli.zones.ListSharedZonesCommand(app, app_args, cmd_name=None)
- Bases: Lister
List Zone Shares
- columns = ['id', 'zone_id', 'target_project_id']
- get_parser(prog_name)
- Return an argparse.ArgumentParser.
- log = <Logger designateclient.v2.cli.zones.ListSharedZonesCommand (WARNING)>
- take_action(parsed_args)
- Run command.
Return a tuple containing the column names and an iterable containing the data to be listed.
- class designateclient.v2.cli.zones.ListTransferAcceptsCommand(app, app_args, cmd_name=None)
- Bases: Lister
List Zone Transfer Accepts
- columns = ['id', 'zone_id', 'project_id', 'zone_transfer_request_id', 'status', 'key']
- get_parser(prog_name)
- Return an argparse.ArgumentParser.
- log = <Logger designateclient.v2.cli.zones.ListTransferAcceptsCommand (WARNING)>
- take_action(parsed_args)
- Run command.
Return a tuple containing the column names and an iterable containing the data to be listed.
- class designateclient.v2.cli.zones.ListTransferRequestsCommand(app, app_args, cmd_name=None)
- Bases: Lister
List Zone Transfer Requests
- columns = ['id', 'zone_id', 'zone_name', 'project_id', 'target_project_id', 'status', 'key']
- get_parser(prog_name)
- Return an argparse.ArgumentParser.
- log = <Logger designateclient.v2.cli.zones.ListTransferRequestsCommand (WARNING)>
- take_action(parsed_args)
- Run command.
Return a tuple containing the column names and an iterable containing the data to be listed.
- class designateclient.v2.cli.zones.ListZoneExportsCommand(app, app_args, cmd_name=None)
- Bases: Lister
List Zone Exports
- columns = ['id', 'zone_id', 'created_at', 'status']
- get_parser(prog_name)
- Return an argparse.ArgumentParser.
- log = <Logger designateclient.v2.cli.zones.ListZoneExportsCommand (WARNING)>
- take_action(parsed_args)
- Run command.
Return a tuple containing the column names and an iterable containing the data to be listed.
- class designateclient.v2.cli.zones.ListZoneImportsCommand(app, app_args, cmd_name=None)
- Bases: Lister
List Zone Imports
- columns = ['id', 'zone_id', 'created_at', 'status', 'message']
- get_parser(prog_name)
- Return an argparse.ArgumentParser.
- log = <Logger designateclient.v2.cli.zones.ListZoneImportsCommand (WARNING)>
- take_action(parsed_args)
- Run command.
Return a tuple containing the column names and an iterable containing the data to be listed.
- class designateclient.v2.cli.zones.ListZonesCommand(app, app_args, cmd_name=None)
- Bases: Lister
List zones
- columns = ['id', 'name', 'type', 'serial', 'status', 'action']
- get_parser(prog_name)
- Return an argparse.ArgumentParser.
- log = <Logger designateclient.v2.cli.zones.ListZonesCommand (WARNING)>
- take_action(parsed_args)
- Run command.
Return a tuple containing the column names and an iterable containing the data to be listed.
- class designateclient.v2.cli.zones.SetTransferRequestCommand(app, app_args, cmd_name=None)
- Bases: ShowOne
Set a Zone Transfer Request
- get_parser(prog_name)
- Return an argparse.ArgumentParser.
- log = <Logger designateclient.v2.cli.zones.SetTransferRequestCommand (WARNING)>
- take_action(parsed_args)
- Return a two-part tuple with a tuple of column names and a tuple of values.
- class designateclient.v2.cli.zones.SetZoneCommand(app, app_args, cmd_name=None)
- Bases: ShowOne
Set zone properties
- get_parser(prog_name)
- Return an argparse.ArgumentParser.
- log = <Logger designateclient.v2.cli.zones.SetZoneCommand (WARNING)>
- take_action(parsed_args)
- Return a two-part tuple with a tuple of column names and a tuple of values.
- class designateclient.v2.cli.zones.ShareZoneCommand(app, app_args, cmd_name=None)
- Bases: ShowOne
Share a Zone
- get_parser(prog_name)
- Return an argparse.ArgumentParser.
- log = <Logger designateclient.v2.cli.zones.ShareZoneCommand (WARNING)>
- take_action(parsed_args)
- Return a two-part tuple with a tuple of column names and a tuple of values.
- class designateclient.v2.cli.zones.ShowSharedZoneCommand(app, app_args, cmd_name=None)
- Bases: ShowOne
Show Zone Share Details
- get_parser(prog_name)
- Return an argparse.ArgumentParser.
- log = <Logger designateclient.v2.cli.zones.ShowSharedZoneCommand (WARNING)>
- take_action(parsed_args)
- Return a two-part tuple with a tuple of column names and a tuple of values.
- class designateclient.v2.cli.zones.ShowTransferAcceptCommand(app, app_args, cmd_name=None)
- Bases: ShowOne
Show Zone Transfer Accept
- get_parser(prog_name)
- Return an argparse.ArgumentParser.
- log = <Logger designateclient.v2.cli.zones.ShowTransferAcceptCommand (WARNING)>
- take_action(parsed_args)
- Return a two-part tuple with a tuple of column names and a tuple of values.
- class designateclient.v2.cli.zones.ShowTransferRequestCommand(app, app_args, cmd_name=None)
- Bases: ShowOne
Show Zone Transfer Request Details
- get_parser(prog_name)
- Return an argparse.ArgumentParser.
- log = <Logger designateclient.v2.cli.zones.ShowTransferRequestCommand (WARNING)>
- take_action(parsed_args)
- Return a two-part tuple with a tuple of column names and a tuple of values.
- class designateclient.v2.cli.zones.ShowZoneCommand(app, app_args, cmd_name=None)
- Bases: ShowOne
Show zone details
- get_parser(prog_name)
- Return an argparse.ArgumentParser.
- log = <Logger designateclient.v2.cli.zones.ShowZoneCommand (WARNING)>
- take_action(parsed_args)
- Return a two-part tuple with a tuple of column names and a tuple of values.
- class designateclient.v2.cli.zones.ShowZoneExportCommand(app, app_args, cmd_name=None)
- Bases: ShowOne
Show a Zone Export
- get_parser(prog_name)
- Return an argparse.ArgumentParser.
- log = <Logger designateclient.v2.cli.zones.ShowZoneExportCommand (WARNING)>
- take_action(parsed_args)
- Return a two-part tuple with a tuple of column names and a tuple of values.
- class designateclient.v2.cli.zones.ShowZoneExportFileCommand(app, app_args, cmd_name=None)
- Bases: ShowOne
Show the zone file for the Zone Export
- get_parser(prog_name)
- Return an argparse.ArgumentParser.
- log = <Logger designateclient.v2.cli.zones.ShowZoneExportFileCommand (WARNING)>
- take_action(parsed_args)
- Return a two-part tuple with a tuple of column names and a tuple of values.
- class designateclient.v2.cli.zones.ShowZoneImportCommand(app, app_args, cmd_name=None)
- Bases: ShowOne
Show a Zone Import
- get_parser(prog_name)
- Return an argparse.ArgumentParser.
- log = <Logger designateclient.v2.cli.zones.ShowZoneImportCommand (WARNING)>
- take_action(parsed_args)
- Return a two-part tuple with a tuple of column names and a tuple of values.
Module contents
Submodules
designateclient.v2.base module
- class designateclient.v2.base.DesignateList(iterable=(), /)
- Bases: list
- next_link_criterion = {}
- next_page = False
- class designateclient.v2.base.V2Controller(client)
- Bases: Controller
designateclient.v2.blacklists module
- class designateclient.v2.blacklists.BlacklistController(client)
- Bases: V2Controller
- create(pattern, description=None)
- delete(blacklist_id)
- get(blacklist_id)
- list(criterion=None, marker=None, limit=None)
- update(blacklist_id, values)
designateclient.v2.client module
- class designateclient.v2.client.Client(region_name=None, endpoint_type='publicURL', extensions=None, service_type='dns', service_name=None, http_log_debug=False, session=None, auth=None, timeout=None, endpoint_override=None, all_projects=False, edit_managed=False, hard_delete=False, sudo_project_id=None)
- Bases: object
- class designateclient.v2.client.DesignateAdapter(*args, **kwargs)
- Bases: LegacyJsonAdapter
Adapter around LegacyJsonAdapter.
The user can pass a timeout keyword that will apply only to the Designate Client, in order:
- timeout keyword passed to request()
- timeout attribute on keystone session
- request(*args, **kwargs)
designateclient.v2.limits module
- class designateclient.v2.limits.LimitController(client)
- Bases: V2Controller
- get()
designateclient.v2.nameservers module
- class designateclient.v2.nameservers.NameServerController(client)
- Bases: V2Controller
- list(zone)
designateclient.v2.pools module
- class designateclient.v2.pools.PoolController(client)
- Bases: V2Controller
- list()
designateclient.v2.quotas module
- class designateclient.v2.quotas.QuotasController(client)
- Bases: V2Controller
- list(project_id)
- reset(project_id)
- update(project_id, values)
designateclient.v2.recordsets module
- class designateclient.v2.recordsets.RecordSetController(client)
- Bases: V2Controller
- create(zone, name, type_, records, description=None, ttl=None)
- delete(zone, recordset)
- get(zone, recordset)
- list(zone, criterion=None, marker=None, limit=None)
- list_all_zones(criterion=None, marker=None, limit=None)
- update(zone, recordset, values)
designateclient.v2.reverse module
- class designateclient.v2.reverse.FloatingIPController(client)
- Bases: V2Controller
- get(floatingip_id)
- list(criterion=None)
- set(floatingip_id, ptrdname, description=None, ttl=None)
- unset(floatingip_id)
designateclient.v2.service_statuses module
- class designateclient.v2.service_statuses.ServiceStatusesController(client)
- Bases: V2Controller
- get(service_status_id)
- list(criterion=None, marker=None, limit=None)
designateclient.v2.tlds module
- class designateclient.v2.tlds.TLDController(client)
- Bases: V2Controller
- create(name, description=None)
- delete(tld)
- get(tld)
- list(criterion=None, marker=None, limit=None)
- update(tld, values)
designateclient.v2.tsigkeys module
- class designateclient.v2.tsigkeys.TSIGKeysController(client)
- Bases: V2Controller
- create(name, algorithm, secret, scope, resource_id)
- delete(tsigkey)
- get(tsigkey)
- list(criterion=None, marker=None, limit=None)
- update(tsigkey, values)
designateclient.v2.utils module
- designateclient.v2.utils.get_all(function, criterion=None, args=None)
- Parameters
- function -- Function to be called to get data
- criterion -- dict of filters to be applied
- args -- arguments to be given to the function
- Returns
- DesignateList()
- designateclient.v2.utils.parse_query_from_url(url)
- Helper to get key bits of data from the "next" url returned from the API on collections :param url: :return: dict
- designateclient.v2.utils.resolve_by_name(func, name, *args)
- Helper to resolve a "name" a'la foo.com to it's ID by using REST api's query support and filtering on name.
designateclient.v2.zones module
- class designateclient.v2.zones.ZoneController(client)
- Bases: V2Controller
- abandon(zone)
- axfr(zone)
- create(name, type_=None, email=None, description=None, ttl=None, masters=None, attributes=None)
- delete(zone, delete_shares=False)
- get(zone)
- list(criterion=None, marker=None, limit=None)
- update(zone, values)
- class designateclient.v2.zones.ZoneExportsController(client)
- Bases: V2Controller
- create(zone)
- delete(zone_export_id)
- get_export(zone_export_id)
- get_export_record(zone_export_id)
- list()
- class designateclient.v2.zones.ZoneImportsController(client)
- Bases: V2Controller
- create(zone_file_contents)
- delete(zone_import_id)
- get_import_record(zone_import_id)
- list()
- class designateclient.v2.zones.ZoneShareController(client)
- Bases: V2Controller
- create(zone, target_project_id)
- delete(zone, shared_zone_id)
- get(zone, shared_zone_id)
- list(zone, criterion=None, marker=None, limit=None)
- class designateclient.v2.zones.ZoneTransfersController(client)
- Bases: V2Controller
- accept_request(transfer_id, key)
- create_request(zone, target_project_id, description=None)
- delete_request(transfer_id)
- get_accept(accept_id)
- get_request(transfer_id)
- list_accepts()
- list_requests()
- update_request(transfer_id, values)
Module contents
Submodules
designateclient.client module
- designateclient.client.Client(version, *args, **kwargs)
- class designateclient.client.Controller(client)
- Bases: object
- build_url(url, criterion=None, marker=None, limit=None)
- class designateclient.client.CrudController(client)
- Bases: Controller
- abstract create(*args, **kw)
- Create a resource
- abstract delete(*args, **kw)
- Delete a resource
- abstract get(*args, **kw)
- Get a resource
- abstract list(*args, **kw)
- List a resource
- abstract update(*args, **kw)
- Update a resource
- designateclient.client.get_versions()
designateclient.exceptions module
- exception designateclient.exceptions.BadRequest(message=None, code=None, type=None, errors=None, request_id=None, **ignore)
- Bases: RemoteError
- exception designateclient.exceptions.Base(message=None)
- Bases: Exception
- exception designateclient.exceptions.Conflict(message=None, code=None, type=None, errors=None, request_id=None, **ignore)
- Bases: RemoteError
- exception designateclient.exceptions.Forbidden(message=None, code=None, type=None, errors=None, request_id=None, **ignore)
- Bases: RemoteError
- exception designateclient.exceptions.NoUniqueMatch(message=None)
- Bases: Base
- exception designateclient.exceptions.NotFound(message=None, code=None, type=None, errors=None, request_id=None, **ignore)
- Bases: RemoteError
- exception designateclient.exceptions.OverQuota(message=None, code=None, type=None, errors=None, request_id=None, **ignore)
- Bases: RemoteError
- exception designateclient.exceptions.RemoteError(message=None, code=None, type=None, errors=None, request_id=None, **ignore)
- Bases: Base
- exception designateclient.exceptions.ResourceNotFound(message=None)
- Bases: Base
- exception designateclient.exceptions.Unknown(message=None, code=None, type=None, errors=None, request_id=None, **ignore)
- Bases: RemoteError
- exception designateclient.exceptions.UnsupportedVersion(message=None)
- Bases: Base
designateclient.utils module
- class designateclient.utils.AdapterWithTimeout(*args, **kw)
- Bases: Adapter
adapter.Adapter wraps around a Session.
The user can pass a timeout keyword that will apply only to the Designate Client, in order:
- timeout keyword passed to request()
- timeout keyword passed to AdapterWithTimeout()
- timeout attribute on keystone session
- request(*args, **kwargs)
- designateclient.utils.find_resourceid_by_name_or_id(resource_client, name_or_id)
- Find resource id from its id or name.
- designateclient.utils.get_columns(data)
- Some row's might have variable count of columns, ensure that we have the same.
- Parameters
- data -- Results in [{}, {]}]
- designateclient.utils.get_item_properties(item, fields, mixed_case_fields=(), formatters=None)
- Return a tuple containing the item properties.
- Parameters
- item -- a single item resource (e.g. Server, Tenant, etc)
- fields -- tuple of strings with the desired field names
- mixed_case_fields -- tuple of field names to preserve case
- formatters -- dictionary mapping field names to callables to format the values
designateclient.version module
Module contents
Indices and tables
- Index
- Module Index
- Search Page
AUTHOR
unknown
COPYRIGHT
2023, Managed I.T. 2013-2014, Hewlett-Packard Development Company, L.P.
| October 16, 2023 | 5.2.0 |