linode-domain man page

linode-domain — command-line interface for Linode Domains

Synopsis

linode-domain [-a action] [action-options...] [options...]

-a create, --action create    create a domain

-a update, --action update    update a domain

-a delete, --action delete    delete a domain

-a list,   --action list      list info about domains

-a show,   --action show      show detailed info about a domain

-a record-create, --action record-create  create a domain record

-a record-update, --action record-update  update a domain record

-a record-delete, --action record-delete  delete a domain record

-a record-list,   --action record-list    list info about a record

-a record-show,   --action record-show    show detailed info about a record

           --api-key=KEY       your user's API key

-h,        --help             display this help and exit

-j,        --json             return output in JSON format

-u,        --username=USER    username for Linode CLI config file

Options

-a, --action

An action to perform on Linode Domains. One of: create, update, delete, list, show, record-create, record-update, record-delete, record-list, record-show.

--api-key

API key to use when communicating with the Linode API. The API key can also be set using an environment variable (LINODE_API_KEY). Alternatively, you can specify the API key in a .linodecli file in the working user's home directory, using the format `api-key foobar`.

-u, --username:

Optional. Allows users to specify the username, if using with multiple accounts and configuration files.

-j, --json:

Optional. JSON output.

-h, --help

Displays help documentation.

Actions

Create

Create a Domain.
-l --label

The Domain (name). The zone's name.

-t --type

Either master or slave. Default: master

-e --email

SOA email address. Required for master domains.

-D --description

Optional. Notes describing details about the Domain.

-R --refresh

Optional. Default: 0

-Y --retry

Optional. Default: 0

-E --expire

Optional. Default: 0

-T --ttl

Optional. Default: 0

-g --group

Optional. Linode Manager display group to place this Domain under.

-s --status

Optional. Statuses are active, edit, or disabled. Default: active

-m --masterip

Optional. Accepts multiple entries. When the domain is a slave, this is the zone's master DNS servers list.

-x --axfrip

Optional. Accepts multiple entries. IP addresses allowed to AXFR the entire zone.

Update

Update a Domain.
-l --label

The Domain (name). The zone's name.

-n --new-label

Optional.  Renames the Domain.

-t --type

Either master or slave. Default: master

-e --email

SOA email address. Required for master domains.

-D --description

Optional. Notes describing details about the Domain.

-R --refresh

Optional. Default: 0

-Y --retry

Optional. Default: 0

-E --expire

Optional. Default: 0

-T --ttl

Optional. Default: 0

-g --group

Optional. Linode Manager display group to place this Domain under.

-s --status

Optional. Statuses are active, edit, or disabled. Default: active

-m --masterip

Optional. Accepts multiple entries. When the domain is a slave, this is the zone's master DNS servers list.

-x --axfrip

Optional. Accepts multiple entries. IP addresses allowed to AXFR the entire zone.

Delete

Delete a Domain.
-l --label

The Domain to delete.

List

List information about one or more Domains.
-l --label

Optional. A specific Domain to list.

Show

Display detailed information about one or more Domains.
-l --label

Required. A specific Domain to list.

Record-Create

Create a Domain record.
-l --label

The Domain (name). The zone's name.

-t --type

One of: NS, MX, A, AAAA, CNAME, TXT, or SRV

-n --name

Optional. The hostname or FQDN. When Type=MX the subdomain to delegate to the Target MX server. Default: blank.

-p --port

Optional. Default: 80

-R --target

Optional. When Type=MX the hostname. When Type=CNAME the target of the alias. When Type=TXT the value of the record. When Type=A or AAAA the token of '[remote_addr]' will be substituted with the IP address of the request.

-P --priority

Optional. Priority for MX and SRV records, 0-255 Default: 10

-W --weight

Optional. Default: 5

-L --protocol

Optional. The protocol to append to an SRV record. Ignored on other record types. Default: blank.

-T --ttl

Optional. Default: 0

Record-Update

Update a Domain record.
-l --label

The Domain containing the record to update.

-t --type

The type of the record to delete. One of: NS, MX, A, AAAA, CNAME, TXT, or SRV

-m --match

The match for the record to delete. Match to a name or target.

-n --name

Optional. The hostname or FQDN. When Type=MX the subdomain to delegate to the Target MX server. Default: blank.

-p --port

Optional. Default: 80

-R --target

Optional. When Type=MX the hostname. When Type=CNAME the target of the alias. When Type=TXT the value of the record. When Type=A or AAAA the token of '[remote_addr]' will be substituted with the IP address of the request.

-P --priority

Optional. Priority for MX and SRV records, 0-255 Default: 10

-W --weight

Optional. Default: 5

-L --protocol

Optional. The protocol to append to an SRV record. Ignored on other record types. Default: blank.

-T --ttl

Optional. Default: 0

Record-Delete

Delete a Domain record.
-l --label

The Domain containing the record to delete.

-t --type

The type of the record to delete. One of: NS, MX, A, AAAA, CNAME, TXT, or SRV

-m --match

The match for the record to delete. Match to a name or target.

Record-List

List Domain Record information for one or more Domains.
-l --label

Optional. A specific Domain to list.

-t --type

Optional. Allows domain record filtering by type. One of: NS, MX, A, AAAA, CNAME, TXT, or SRV

Record-Show

Display detailed Domain Record information for one or more Domains.
-l --label

Required. A specific Domain to show.

-t --type

Optional. Allows domain record filtering by type. One of: NS, MX, A, AAAA, CNAME, TXT, or SRV

Copyright/License

Copyright 2015 Linode, LLC.  Linode CLI is made available under the terms of the Perl Artistic License, or GPLv2 at the recipients discretion.

Perl Artistic License

Read it at <http://dev.perl.org/licenses/artistic.html>.

GNU General Public License (GPL) Version 2

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program.  If not, see http://www.gnu.org/licenses/

See the full license at <http://www.gnu.org/licenses/>.

Info

2015-01-16 perl v5.26.0 User Contributed Perl Documentation