forked from linode/cli
/
linode-domain
executable file
·462 lines (243 loc) · 8.69 KB
/
linode-domain
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
#!/usr/bin/env perl
# linode-cli
# Copyright (C) 2015 Linode, LLC
use 5.010;
use strict;
use warnings;
use FindBin;
use lib "$FindBin::RealBin/lib";
use Linode::CLI;
use Linode::CLI::Util ':basic';
my $mode = 'domain';
my $cmdargs = Linode::CLI::Util::eat_cmdargs($mode);
my $cli = Linode::CLI->new(
api_key => $cmdargs->{'api-key'},
mode => $mode,
opts => $cmdargs,
output_format => $cmdargs->{output},
wait => $cmdargs->{wait},
);
my $runaction = $cmdargs->{run};
$cli->$runaction;
$cli->response;
__END__
=head1 NAME
linode-domain - command-line interface for Linode Domains
=head1 SYNOPSIS
B<linode-domain> [B<-a> action] [action-options...] [options...]
=over
=item S<-a create, --action create create a domain>
=item S<-a update, --action update update a domain>
=item S<-a delete, --action delete delete a domain>
=item S<-a list, --action list list info about domains>
=item S<-a show, --action show show detailed info about a domain>
=item S<-a record-create, --action record-create create a domain record>
=item S<-a record-update, --action record-update update a domain record>
=item S<-a record-delete, --action record-delete delete a domain record>
=item S<-a record-list, --action record-list list info about a record>
=item S<-a record-show, --action record-show show detailed info about a record>
=item S< --api-key=KEY your user's API key>
=item S<-h, --help display this help and exit>
=item S<-j, --json return output in JSON format>
=item S<-u, --username=USER username for Linode CLI config file>
=back
=head1 OPTIONS
=over 8
=item B<-a>, B<--action>
An action to perform on Linode Domains. One of: B<create>, B<update>, B<delete>, B<list>, B<show>, B<record-create>, B<record-update>, B<record-delete>, B<record-list>, B<record-show>.
=item B<--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 B<.linodecli> file in the working user's home directory, using the format `api-key foobar`.
=item B<-u>, B<--username>:
Optional. Allows users to specify the username, if using with multiple accounts and configuration files.
=item B<-j>, B<--json>:
Optional. JSON output.
=item B<-h>, B<--help>
Displays help documentation.
=back
=head1 ACTIONS
=head2 CREATE
=over 8
=item Create a Domain.
=over 8
=item B<-l> B<--label>
The Domain (name). The zone's name.
=item B<-t> B<--type>
Either master or slave. Default: master
=item B<-e> B<--email>
SOA email address. Required for master domains.
=item B<-D> B<--description>
Optional. Notes describing details about the Domain.
=item B<-R> B<--refresh>
Optional. Default: 0
=item B<-Y> B<--retry>
Optional. Default: 0
=item B<-E> B<--expire>
Optional. Default: 0
=item B<-T> B<--ttl>
Optional. Default: 0
=item B<-g> B<--group>
Optional. Linode Manager display group to place this Domain under.
=item B<-s> B<--status>
Optional. Statuses are active, edit, or disabled. Default: active
=item B<-m> B<--masterip>
Optional. Accepts multiple entries. When the domain is a slave, this is the zone's master DNS servers list.
=item B<-x> B<--axfrip>
Optional. Accepts multiple entries. IP addresses allowed to AXFR the entire zone.
=back
=back
=head2 UPDATE
=over 8
=item Update a Domain.
=over 8
=item B<-l> B<--label>
The Domain (name). The zone's name.
=item B<-n> B<--new-label>
Optional. Renames the Domain.
=item B<-t> B<--type>
Either master or slave. Default: master
=item B<-e> B<--email>
SOA email address. Required for master domains.
=item B<-D> B<--description>
Optional. Notes describing details about the Domain.
=item B<-R> B<--refresh>
Optional. Default: 0
=item B<-Y> B<--retry>
Optional. Default: 0
=item B<-E> B<--expire>
Optional. Default: 0
=item B<-T> B<--ttl>
Optional. Default: 0
=item B<-g> B<--group>
Optional. Linode Manager display group to place this Domain under.
=item B<-s> B<--status>
Optional. Statuses are active, edit, or disabled. Default: active
=item B<-m> B<--masterip>
Optional. Accepts multiple entries. When the domain is a slave, this is the zone's master DNS servers list.
=item B<-x> B<--axfrip>
Optional. Accepts multiple entries. IP addresses allowed to AXFR the entire zone.
=back
=back
=head2 DELETE
=over 8
=item Delete a Domain.
=over 8
=item B<-l> B<--label>
The Domain to delete.
=back
=back
=head2 LIST
=over 8
=item List information about one or more Domains.
=over 8
=item B<-l> B<--label>
Optional. A specific Domain to list.
=back
=back
=head2 SHOW
=over 8
=item Display detailed information about one or more Domains.
=over 8
=item B<-l> B<--label>
Required. A specific Domain to list.
=back
=back
=head2 RECORD-CREATE
=over 8
=item Create a Domain record.
=over 8
=item B<-l> B<--label>
The Domain (name). The zone's name.
=item B<-t> B<--type>
One of: NS, MX, A, AAAA, CNAME, TXT, or SRV
=item B<-n> B<--name>
Optional. The hostname or FQDN. When Type=MX the subdomain to delegate to the Target MX server. Default: blank.
=item B<-p> B<--port>
Optional. Default: 80
=item B<-R> B<--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.
=item B<-P> B<--priority>
Optional. Priority for MX and SRV records, 0-255 Default: 10
=item B<-W> B<--weight>
Optional. Default: 5
=item B<-L> B<--protocol>
Optional. The protocol to append to an SRV record. Ignored on other record types. Default: blank.
=item B<-T> B<--ttl>
Optional. Default: 0
=back
=back
=head2 RECORD-UPDATE
=over 8
=item Update a Domain record.
=over 8
=item B<-l> B<--label>
The Domain containing the record to update.
=item B<-t> B<--type>
The type of the record to delete. One of: NS, MX, A, AAAA, CNAME, TXT, or SRV
=item B<-m> B<--match>
The match for the record to delete. Match to a name or target.
=item B<-n> B<--name>
Optional. The hostname or FQDN. When Type=MX the subdomain to delegate to the Target MX server. Default: blank.
=item B<-p> B<--port>
Optional. Default: 80
=item B<-R> B<--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.
=item B<-P> B<--priority>
Optional. Priority for MX and SRV records, 0-255 Default: 10
=item B<-W> B<--weight>
Optional. Default: 5
=item B<-L> B<--protocol>
Optional. The protocol to append to an SRV record. Ignored on other record types. Default: blank.
=item B<-T> B<--ttl>
Optional. Default: 0
=back
=back
=head2 RECORD-DELETE
=over 8
=item Delete a Domain record.
=over 8
=item B<-l> B<--label>
The Domain containing the record to delete.
=item B<-t> B<--type>
The type of the record to delete. One of: NS, MX, A, AAAA, CNAME, TXT, or SRV
=item B<-m> B<--match>
The match for the record to delete. Match to a name or target.
=back
=back
=head2 RECORD-LIST
=over 8
=item List Domain Record information for one or more Domains.
=over 8
=item B<-l> B<--label>
Optional. A specific Domain to list.
=item B<-t> B<--type>
Optional. Allows domain record filtering by type. One of: NS, MX, A, AAAA, CNAME, TXT, or SRV
=back
=back
=head2 RECORD-SHOW
=over 8
=item Display detailed Domain Record information for one or more Domains.
=over 8
=item B<-l> B<--label>
Required. A specific Domain to show.
=item B<-t> B<--type>
Optional. Allows domain record filtering by type. One of: NS, MX, A, AAAA, CNAME, TXT, or SRV
=back
=back
=head1 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.
=head2 Perl Artistic License
Read it at L<http://dev.perl.org/licenses/artistic.html>.
=head2 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 L<http://www.gnu.org/licenses/>.
=cut