Domains

This section details Domain-related Linode CLI commands.

list

Aliases: ls

This is a collection of Domains that you have registered in Linode’s DNS Manager.

Usage

The format accepted by this command.

linode-cli domains list [-h] [--group group] [--domain domain]
    [--tags [tags] ] [--order-by {group,domain,tags}]
    [--order {asc,desc}]

Sample

Examples of how this command might be used.

linode-cli domains list

Filterable Attributes

Arguments used to define a filter for response entries.

Name	Type	Description
--domain	str	The domain this Domain represents.
--group	str	The group this Domain belongs to.
--tags	[]str	An array of tags applied to this object.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
axfr_ips	[]str	N/A	The list of IPs that may perform a zone transfer for this Domain.
description	str	N/A	A description for this Domain.
domain	str	example.org	The domain this Domain represents.
expire_sec	int	300	The amount of time in seconds that may pass before this Domain is no longer authoritative.
group	str	N/A	The group this Domain belongs to.
id	int	1234	This Domain’s unique ID.
master_ips	[]str	N/A	The IP addresses representing the master DNS for this Domain.
refresh_sec	int	300	The amount of time in seconds before this Domain should be refreshed.
retry_sec	int	300	The interval, in seconds, at which a failed refresh should be retried.
soa_email	str	admin@example.org	Start of Authority email address.
status	str	active	Used to control whether this Domain is currently being rendered.
tags	[]str	[“example ta…er example”]	An array of tags applied to this object.
ttl_sec	int	300	“Time to Live” - the amount of time in seconds that this Domain’s records may be cached by resolvers or other domain servers.
type	str	master	Whether this Domain represents the authoritative source of information for the domain it describes (master), or whether it is a read-only copy of a master (slave).

---

view

This is a single Domain that you have registered in Linode’s DNS Manager.

Usage

The format accepted by this command.

linode-cli domains view [-h] [--tags [tags] ] [--group group]
    [--domain domain] [--order-by {tags,group,domain}]
    [--order {asc,desc}] domainId

Sample

Examples of how this command might be used.

linode-cli domains view 123

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
domainId	int	The ID of the Domain to access.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
axfr_ips	[]str	N/A	The list of IPs that may perform a zone transfer for this Domain.
description	str	N/A	A description for this Domain.
domain	str	example.org	The domain this Domain represents.
expire_sec	int	300	The amount of time in seconds that may pass before this Domain is no longer authoritative.
group	str	N/A	The group this Domain belongs to.
id	int	1234	This Domain’s unique ID.
master_ips	[]str	N/A	The IP addresses representing the master DNS for this Domain.
refresh_sec	int	300	The amount of time in seconds before this Domain should be refreshed.
retry_sec	int	300	The interval, in seconds, at which a failed refresh should be retried.
soa_email	str	admin@example.org	Start of Authority email address.
status	str	active	Used to control whether this Domain is currently being rendered.
tags	[]str	[“example ta…er example”]	An array of tags applied to this object.
ttl_sec	int	300	“Time to Live” - the amount of time in seconds that this Domain’s records may be cached by resolvers or other domain servers.
type	str	master	Whether this Domain represents the authoritative source of information for the domain it describes (master), or whether it is a read-only copy of a master (slave).

---

create

Adds a new Domain to Linode’s DNS Manager.

Usage

The format accepted by this command.

linode-cli domains create [-h] [--master_ips master_ips]
    [--ttl_sec ttl_sec] [--retry_sec retry_sec]
    [--axfr_ips axfr_ips] [--soa_email soa_email]
    [--description description] [--type type]
    [--refresh_sec refresh_sec] [--tags tags] [--status status]
    [--domain domain] [--group group] [--expire_sec expire_sec]

Sample

Examples of how this command might be used.

linode-cli domains create \
    --type master \
    --domain example.org \
    --soa_email admin@example.org

Arguments

Additional fields used to execute this request.

Name	Type	Example	Description
--domain *	str	example.org	The domain this Domain represents.
--type *	str	master	Whether this Domain represents the authoritative source of information for the domain it describes (master), or whether it is a read-only copy of a master (slave).
--axfr_ips	[]str	N/A	The list of IPs that may perform a zone transfer for this Domain.
--description	str	N/A	A description for this Domain.
--expire_sec	int	300	The amount of time in seconds that may pass before this Domain is no longer authoritative.
--group	str	N/A	(deprecated) The group this Domain belongs to.
--master_ips	[]str	N/A	The IP addresses representing the master DNS for this Domain.
--refresh_sec	int	300	The amount of time in seconds before this Domain should be refreshed.
--retry_sec	int	300	The interval, in seconds, at which a failed refresh should be retried.
--soa_email	str	admin@example.org	Start of Authority email address.
--status	str	active	Used to control whether this Domain is currently being rendered.
--tags	[]str	example tag	An array of tags applied to this object.
--ttl_sec	int	300	“Time to Live” - the amount of time in seconds that this Domain’s records may be cached by resolvers or other domain servers.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
axfr_ips	[]str	N/A	The list of IPs that may perform a zone transfer for this Domain.
description	str	N/A	A description for this Domain.
domain	str	example.org	The domain this Domain represents.
expire_sec	int	300	The amount of time in seconds that may pass before this Domain is no longer authoritative.
group	str	N/A	The group this Domain belongs to.
id	int	1234	This Domain’s unique ID.
master_ips	[]str	N/A	The IP addresses representing the master DNS for this Domain.
refresh_sec	int	300	The amount of time in seconds before this Domain should be refreshed.
retry_sec	int	300	The interval, in seconds, at which a failed refresh should be retried.
soa_email	str	admin@example.org	Start of Authority email address.
status	str	active	Used to control whether this Domain is currently being rendered.
tags	[]str	[“example ta…er example”]	An array of tags applied to this object.
ttl_sec	int	300	“Time to Live” - the amount of time in seconds that this Domain’s records may be cached by resolvers or other domain servers.
type	str	master	Whether this Domain represents the authoritative source of information for the domain it describes (master), or whether it is a read-only copy of a master (slave).

---

update

Update information about a Domain in Linode’s DNS Manager.

Usage

The format accepted by this command.

linode-cli domains update [-h] [--ttl_sec ttl_sec]
    [--retry_sec retry_sec] [--master_ips master_ips]
    [--description description] [--type type]
    [--soa_email soa_email] [--axfr_ips axfr_ips] [--tags tags]
    [--refresh_sec refresh_sec] [--expire_sec expire_sec]
    [--group group] [--domain domain] [--status status] domainId

Sample

Examples of how this command might be used.

linode-cli domains update 1234 \
    --retry_sec 7200 \
    --ttl_sec 300

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
domainId	int	The ID of the Domain to access.

Arguments

Additional fields used to execute this request.

Name	Type	Example	Description
--axfr_ips	[]str	N/A	The list of IPs that may perform a zone transfer for this Domain.
--description	str	N/A	A description for this Domain.
--domain	str	example.org	The domain this Domain represents.
--expire_sec	int	300	The amount of time in seconds that may pass before this Domain is no longer authoritative.
--group	str	N/A	(deprecated) The group this Domain belongs to.
--master_ips	[]str	N/A	The IP addresses representing the master DNS for this Domain.
--refresh_sec	int	300	The amount of time in seconds before this Domain should be refreshed.
--retry_sec	int	300	The interval, in seconds, at which a failed refresh should be retried.
--soa_email	str	admin@example.org	Start of Authority email address.
--status	str	active	Used to control whether this Domain is currently being rendered.
--tags	[]str	example tag	An array of tags applied to this object.
--ttl_sec	int	300	“Time to Live” - the amount of time in seconds that this Domain’s records may be cached by resolvers or other domain servers.
--type	str	master	Whether this Domain represents the authoritative source of information for the domain it describes (master), or whether it is a read-only copy of a master (slave).

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
axfr_ips	[]str	N/A	The list of IPs that may perform a zone transfer for this Domain.
description	str	N/A	A description for this Domain.
domain	str	example.org	The domain this Domain represents.
expire_sec	int	300	The amount of time in seconds that may pass before this Domain is no longer authoritative.
group	str	N/A	The group this Domain belongs to.
id	int	1234	This Domain’s unique ID.
master_ips	[]str	N/A	The IP addresses representing the master DNS for this Domain.
refresh_sec	int	300	The amount of time in seconds before this Domain should be refreshed.
retry_sec	int	300	The interval, in seconds, at which a failed refresh should be retried.
soa_email	str	admin@example.org	Start of Authority email address.
status	str	active	Used to control whether this Domain is currently being rendered.
tags	[]str	[“example ta…er example”]	An array of tags applied to this object.
ttl_sec	int	300	“Time to Live” - the amount of time in seconds that this Domain’s records may be cached by resolvers or other domain servers.
type	str	master	Whether this Domain represents the authoritative source of information for the domain it describes (master), or whether it is a read-only copy of a master (slave).

---

delete

Aliases: rm

Deletes a Domain from Linode’s DNS Manager.

Usage

The format accepted by this command.

linode-cli domains delete [-h] domainId

Sample

Examples of how this command might be used.

linode-cli domains delete 1234

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
domainId	int	The ID of the Domain to access.

---

clone

Clones a Domain and all associated DNS records from a Domain that is registered in Linode’s DNS manager.

Usage

The format accepted by this command.

linode-cli domains clone [-h] [--domain domain] domainId

Sample

Examples of how this command might be used.

linode-cli domains clone 123 --domain example.com

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
domainId	str	ID of the Domain to clone.

Arguments

Additional fields used to execute this request.

Name	Type	Example	Description
--domain *	str	example.org	The new domain for the clone.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
axfr_ips	[]str	N/A	The list of IPs that may perform a zone transfer for this Domain.
description	str	N/A	A description for this Domain.
domain	str	example.org	The domain this Domain represents.
expire_sec	int	300	The amount of time in seconds that may pass before this Domain is no longer authoritative.
group	str	N/A	The group this Domain belongs to.
id	int	1234	This Domain’s unique ID.
master_ips	[]str	N/A	The IP addresses representing the master DNS for this Domain.
refresh_sec	int	300	The amount of time in seconds before this Domain should be refreshed.
retry_sec	int	300	The interval, in seconds, at which a failed refresh should be retried.
soa_email	str	admin@example.org	Start of Authority email address.
status	str	active	Used to control whether this Domain is currently being rendered.
tags	[]str	[“example ta…er example”]	An array of tags applied to this object.
ttl_sec	int	300	“Time to Live” - the amount of time in seconds that this Domain’s records may be cached by resolvers or other domain servers.
type	str	master	Whether this Domain represents the authoritative source of information for the domain it describes (master), or whether it is a read-only copy of a master (slave).

---

import

Imports a domain zone from a remote nameserver.

Usage

The format accepted by this command.

linode-cli domains import [-h] [--domain domain]
    [--remote_nameserver remote_nameserver]

Sample

Examples of how this command might be used.

linode-cli domains import --domain example.com --remote_nameserver examplenameserver.com

Arguments

Additional fields used to execute this request.

Name	Type	Example	Description
--domain *	str	example.com	The domain to import.
--remote_nameserver *	str	examplenameserver.com	The remote nameserver that allows zone transfers (AXFR).

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
axfr_ips	[]str	N/A	The list of IPs that may perform a zone transfer for this Domain.
description	str	N/A	A description for this Domain.
domain	str	example.org	The domain this Domain represents.
expire_sec	int	300	The amount of time in seconds that may pass before this Domain is no longer authoritative.
group	str	N/A	The group this Domain belongs to.
id	int	1234	This Domain’s unique ID.
master_ips	[]str	N/A	The IP addresses representing the master DNS for this Domain.
refresh_sec	int	300	The amount of time in seconds before this Domain should be refreshed.
retry_sec	int	300	The interval, in seconds, at which a failed refresh should be retried.
soa_email	str	admin@example.org	Start of Authority email address.
status	str	active	Used to control whether this Domain is currently being rendered.
tags	[]str	[“example ta…er example”]	An array of tags applied to this object.
ttl_sec	int	300	“Time to Live” - the amount of time in seconds that this Domain’s records may be cached by resolvers or other domain servers.
type	str	master	Whether this Domain represents the authoritative source of information for the domain it describes (master), or whether it is a read-only copy of a master (slave).

---

records-list

Returns a paginated list of Records configured on a Domain in Linode’s DNS Manager.

Usage

The format accepted by this command.

linode-cli domains records-list [-h] [--tag tag] [--name name]
    [--target target] [--type type]
    [--order-by {tag,name,target,type}] [--order {asc,desc}]
    domainId

Sample

Examples of how this command might be used.

linode-cli domains records-list 1234

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
domainId	int	The ID of the Domain we are accessing Records for.

Filterable Attributes

Arguments used to define a filter for response entries.

Name	Type	Description
--name	str	The name of this Record.
--tag	str	The tag portion of a CAA record.
--target	str	The target for this Record.
--type	str	The type of Record this is in the DNS system.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
created	str	2018-01-01T00:01:01	When this Domain Record was created.
id	int	123456	This Record’s unique ID.
name	str	test	The name of this Record.
port	int	80	The port this Record points to.
priority	int	50	The priority of the target host for this Record.
protocol	str	N/A	The protocol this Record’s service communicates with.
service	str	N/A	The name of the service.
tag	str	N/A	The tag portion of a CAA record.
target	str	192.0.2.0	The target for this Record.
ttl_sec	int	604800	“Time to Live” - the amount of time in seconds that this Domain’s records may be cached by resolvers or other domain servers.
type	str	A	The type of Record this is in the DNS system.
updated	str	2018-01-01T00:01:01	When this Domain Record was last updated.
weight	int	50	The relative weight of this Record used in the case of identical priority.

---

records-view

View a single Record on this Domain.

Usage

The format accepted by this command.

linode-cli domains records-view [-h] [--target target]
    [--tag tag] [--name name] [--type type]
    [--order-by {target,tag,name,type}] [--order {asc,desc}]
    domainId recordId

Sample

Examples of how this command might be used.

linode-cli domains records-view 123 234

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
domainId	int	The ID of the Domain whose Record you are accessing.
recordId	int	The ID of the Record you are accessing.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
created	str	2018-01-01T00:01:01	When this Domain Record was created.
id	int	123456	This Record’s unique ID.
name	str	test	The name of this Record.
port	int	80	The port this Record points to.
priority	int	50	The priority of the target host for this Record.
protocol	str	N/A	The protocol this Record’s service communicates with.
service	str	N/A	The name of the service.
tag	str	N/A	The tag portion of a CAA record.
target	str	192.0.2.0	The target for this Record.
ttl_sec	int	604800	“Time to Live” - the amount of time in seconds that this Domain’s records may be cached by resolvers or other domain servers.
type	str	A	The type of Record this is in the DNS system.
updated	str	2018-01-01T00:01:01	When this Domain Record was last updated.
weight	int	50	The relative weight of this Record used in the case of identical priority.

---

records-create

Adds a new Domain Record to the zonefile this Domain represents.

Usage

The format accepted by this command.

linode-cli domains records-create [-h] [--type type]
    [--weight weight] [--service service] [--priority priority]
    [--ttl_sec ttl_sec] [--port port] [--protocol protocol]
    [--tag tag] [--name name] [--target target] domainId

Sample

Examples of how this command might be used.

linode-cli domains records-create 123 \
    --type A \
    --name test \
    --target 203.0.113.1 \
    --priority 50 \
    --weight 50 \
    --port 80 \
    --ttl_sec 604800

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
domainId	int	The ID of the Domain we are accessing Records for.

Arguments

Additional fields used to execute this request.

Name	Type	Example	Description
--type *	str	A	The type of Record this is in the DNS system.
--name	str	test	The name of this Record.
--port	int	80	The port this Record points to.
--priority	int	50	The priority of the target host for this Record.
--protocol	str	N/A	(nullable) The protocol this Record’s service communicates with.
--service	str	N/A	(nullable) The name of the service.
--tag	str	N/A	(nullable) The tag portion of a CAA record.
--target	str	192.0.2.0	The target for this Record.
--ttl_sec	int	604800	“Time to Live” - the amount of time in seconds that this Domain’s records may be cached by resolvers or other domain servers.
--weight	int	50	The relative weight of this Record used in the case of identical priority.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
created	str	2018-01-01T00:01:01	When this Domain Record was created.
id	int	123456	This Record’s unique ID.
name	str	test	The name of this Record.
port	int	80	The port this Record points to.
priority	int	50	The priority of the target host for this Record.
protocol	str	N/A	The protocol this Record’s service communicates with.
service	str	N/A	The name of the service.
tag	str	N/A	The tag portion of a CAA record.
target	str	192.0.2.0	The target for this Record.
ttl_sec	int	604800	“Time to Live” - the amount of time in seconds that this Domain’s records may be cached by resolvers or other domain servers.
type	str	A	The type of Record this is in the DNS system.
updated	str	2018-01-01T00:01:01	When this Domain Record was last updated.
weight	int	50	The relative weight of this Record used in the case of identical priority.

---

records-update

Updates a single Record on this Domain.

Usage

The format accepted by this command.

linode-cli domains records-update [-h] [--ttl_sec ttl_sec]
    [--priority priority] [--service service] [--port port]
    [--name name] [--weight weight] [--tag tag]
    [--protocol protocol] [--target target] domainId recordId

Sample

Examples of how this command might be used.

linode-cli domains records-update 123 234 \
    --name test \
    --target 203.0.113.1 \
    --priority 50 \
    --weight 50 \
    --port 80 \
    --ttl_sec 604800

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
domainId	int	The ID of the Domain whose Record you are accessing.
recordId	int	The ID of the Record you are accessing.

Arguments

Additional fields used to execute this request.

Name	Type	Example	Description
--name	str	test	The name of this Record.
--port	int	80	The port this Record points to.
--priority	int	50	The priority of the target host for this Record.
--protocol	str	N/A	(nullable) The protocol this Record’s service communicates with.
--service	str	N/A	(nullable) The name of the service.
--tag	str	N/A	(nullable) The tag portion of a CAA record.
--target	str	192.0.2.0	The target for this Record.
--ttl_sec	int	604800	“Time to Live” - the amount of time in seconds that this Domain’s records may be cached by resolvers or other domain servers.
--weight	int	50	The relative weight of this Record used in the case of identical priority.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
created	str	2018-01-01T00:01:01	When this Domain Record was created.
id	int	123456	This Record’s unique ID.
name	str	test	The name of this Record.
port	int	80	The port this Record points to.
priority	int	50	The priority of the target host for this Record.
protocol	str	N/A	The protocol this Record’s service communicates with.
service	str	N/A	The name of the service.
tag	str	N/A	The tag portion of a CAA record.
target	str	192.0.2.0	The target for this Record.
ttl_sec	int	604800	“Time to Live” - the amount of time in seconds that this Domain’s records may be cached by resolvers or other domain servers.
type	str	A	The type of Record this is in the DNS system.
updated	str	2018-01-01T00:01:01	When this Domain Record was last updated.
weight	int	50	The relative weight of this Record used in the case of identical priority.

---

records-delete

Deletes a Record on this Domain.

Usage

The format accepted by this command.

linode-cli domains records-delete [-h] domainId recordId

Sample

Examples of how this command might be used.

linode-cli domains records-delete 123 234

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
domainId	int	The ID of the Domain whose Record you are accessing.
recordId	int	The ID of the Record you are accessing.

zone-file

Returns the zone file for the last rendered zone for the specified domain.

Usage

The format accepted by this command.

linode-cli domains zone-file [-h] [--order-by {}]
    [--order {asc,desc}] domainId

Sample

Examples of how this command might be used.

linode-cli domains zone-file 123

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
domainId	str	ID of the Domain.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
zone_file	[]str	[”; example….inode.com.”]	The lines of the zone file for the last rendered zone for this domain.