1LINODE-DOMAIN(1) User Contributed Perl Documentation LINODE-DOMAIN(1)
2
6 linode-domain - command-line interface for Linode Domains
7
9 linode-domain [-a action] [action-options...] [options...]
10 -a create, --action create create a domain
12 -a update, --action update update a domain
13 -a delete, --action delete delete a domain
14 -a list, --action list list info about domains
15 -a show, --action show show detailed info about a domain
16 -a record-create, --action record-create create a domain record
17 -a record-update, --action record-update update a domain record
18 -a record-delete, --action record-delete delete a domain record
19 -a record-list, --action record-list list info about a record
20 -a record-show, --action record-show show detailed info about a record
21 --api-key=KEY your user's API key
22 -h, --help display this help and exit
23 -j, --json return output in JSON format
24 -u, --username=USER username for Linode CLI config file
25
27 -a, --action
28 An action to perform on Linode Domains. One of: create, update,
29 delete, list, show, record-create, record-update, record-
30 delete, record-list, record-show.
31 --api-key
33 API key to use when communicating with the Linode API. The API
34 key can also be set using an environment variable
35 (LINODE_API_KEY). Alternatively, you can specify the API key in
36 a .linodecli file in the working user's home directory, using
37 the format `api-key foobar`.
38 -u, --username:
40 Optional. Allows users to specify the username, if using with
41 multiple accounts and configuration files.
42 -j, --json:
44 Optional. JSON output.
45 -h, --help
47 Displays help documentation.
48
50 CREATE
51 Create a Domain.
52 -l --label
53 The Domain (name). The zone's name.
54 -t --type
56 Either master or slave. Default: master
57 -e --email
59 SOA email address. Required for master domains.
60 -D --description
62 Optional. Notes describing details about the Domain.
63 -R --refresh
65 Optional. Default: 0
66 -Y --retry
68 Optional. Default: 0
69 -E --expire
71 Optional. Default: 0
72 -T --ttl
74 Optional. Default: 0
75 -g --group
77 Optional. Linode Manager display group to place this
78 Domain under.
79 -s --status
81 Optional. Statuses are active, edit, or disabled.
82 Default: active
83 -m --masterip
85 Optional. Accepts multiple entries. When the domain is
86 a slave, this is the zone's master DNS servers list.
87 -x --axfrip
89 Optional. Accepts multiple entries. IP addresses
90 allowed to AXFR the entire zone.
91 UPDATE
93 Update a Domain.
94 -l --label
95 The Domain (name). The zone's name.
96 -n --new-label
98 Optional. Renames the Domain.
99 -t --type
101 Either master or slave. Default: master
102 -e --email
104 SOA email address. Required for master domains.
105 -D --description
107 Optional. Notes describing details about the Domain.
108 -R --refresh
110 Optional. Default: 0
111 -Y --retry
113 Optional. Default: 0
114 -E --expire
116 Optional. Default: 0
117 -T --ttl
119 Optional. Default: 0
120 -g --group
122 Optional. Linode Manager display group to place this
123 Domain under.
124 -s --status
126 Optional. Statuses are active, edit, or disabled.
127 Default: active
128 -m --masterip
130 Optional. Accepts multiple entries. When the domain is
131 a slave, this is the zone's master DNS servers list.
132 -x --axfrip
134 Optional. Accepts multiple entries. IP addresses
135 allowed to AXFR the entire zone.
136 DELETE
138 Delete a Domain.
139 -l --label
140 The Domain to delete.
141 LIST
143 List information about one or more Domains.
144 -l --label
145 Optional. A specific Domain to list.
146 SHOW
148 Display detailed information about one or more Domains.
149 -l --label
150 Required. A specific Domain to list.
151 RECORD-CREATE
153 Create a Domain record.
154 -l --label
155 The Domain (name). The zone's name.
156 -t --type
158 One of: NS, MX, A, AAAA, CNAME, TXT, or SRV
159 -n --name
161 Optional. The hostname or FQDN. When Type=MX the
162 subdomain to delegate to the Target MX server. Default:
163 blank.
164 -p --port
166 Optional. Default: 80
167 -R --target
169 Optional. When Type=MX the hostname. When Type=CNAME
170 the target of the alias. When Type=TXT the value of the
171 record. When Type=A or AAAA the token of
172 '[remote_addr]' will be substituted with the IP address
173 of the request.
174 -P --priority
176 Optional. Priority for MX and SRV records, 0-255
177 Default: 10
178 -W --weight
180 Optional. Default: 5
181 -L --protocol
183 Optional. The protocol to append to an SRV record.
184 Ignored on other record types. Default: blank.
185 -T --ttl
187 Optional. Default: 0
188 RECORD-UPDATE
190 Update a Domain record.
191 -l --label
192 The Domain containing the record to update.
193 -t --type
195 The type of the record to delete. One of: NS, MX, A,
196 AAAA, CNAME, TXT, or SRV
197 -m --match
199 The match for the record to delete. Match to a name or
200 target.
201 -n --name
203 Optional. The hostname or FQDN. When Type=MX the
204 subdomain to delegate to the Target MX server. Default:
205 blank.
206 -p --port
208 Optional. Default: 80
209 -R --target
211 Optional. When Type=MX the hostname. When Type=CNAME
212 the target of the alias. When Type=TXT the value of the
213 record. When Type=A or AAAA the token of
214 '[remote_addr]' will be substituted with the IP address
215 of the request.
216 -P --priority
218 Optional. Priority for MX and SRV records, 0-255
219 Default: 10
220 -W --weight
222 Optional. Default: 5
223 -L --protocol
225 Optional. The protocol to append to an SRV record.
226 Ignored on other record types. Default: blank.
227 -T --ttl
229 Optional. Default: 0
230 RECORD-DELETE
232 Delete a Domain record.
233 -l --label
234 The Domain containing the record to delete.
235 -t --type
237 The type of the record to delete. One of: NS, MX, A,
238 AAAA, CNAME, TXT, or SRV
239 -m --match
241 The match for the record to delete. Match to a name or
242 target.
243 RECORD-LIST
245 List Domain Record information for one or more Domains.
246 -l --label
247 Optional. A specific Domain to list.
248 -t --type
250 Optional. Allows domain record filtering by type. One
251 of: NS, MX, A, AAAA, CNAME, TXT, or SRV
252 RECORD-SHOW
254 Display detailed Domain Record information for one or more Domains.
255 -l --label
256 Required. A specific Domain to show.
257 -t --type
259 Optional. Allows domain record filtering by type. One
260 of: NS, MX, A, AAAA, CNAME, TXT, or SRV
261
263 Copyright 2015 Linode, LLC. Linode CLI is made available under the
264 terms of the Perl Artistic License, or GPLv2 at the recipients
265 discretion.
266 Perl Artistic License
268 Read it at <http://dev.perl.org/licenses/artistic.html>.
269 GNU General Public License (GPL) Version 2
271 This program is free software; you can redistribute it and/or modify it
272 under the terms of the GNU General Public License as published by the
273 Free Software Foundation; either version 2 of the License, or (at your
274 option) any later version.
275 This program is distributed in the hope that it will be useful, but
277 WITHOUT ANY WARRANTY; without even the implied warranty of
278 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
279 General Public License for more details.
280 You should have received a copy of the GNU General Public License along
282 with this program. If not, see http://www.gnu.org/licenses/
283 See the full license at <http://www.gnu.org/licenses/>.
285perl v5.30.0 2019-07-25 LINODE-DOMAIN(1)