-
Notifications
You must be signed in to change notification settings - Fork 0
/
makePod.go
7807 lines (6203 loc) · 314 KB
/
makePod.go
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
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package main
import(
. "github.com/dirtman/sitepkg"
)
func makePodMap() error {
PodMap["a"] = `
NAME
ibapi a - create, read, update and delete Infoblox A records
USAGE
ibapi a <add|get|update|delete> <options/args>
DESCRIPTION
"ibapi a" can be used to add, get, update and delete Infoblox A records.
The basic format is
* ibapi a <operation> <options/args>
For more details, invoke the specific operation with the --help|-h
option. For example:
* ibapi a add -h
EXAMPLES
ibapi a add -t 600 rb4.rice.edu 168.7.56.224
Add an A record.
ibapi a delete rb4.rice.edu 168.7.56.224
Delete an A record.
FILES
/usr/site/ibapi-1.0/etc/ibapi.conf
/etc/opt/ibapi/ibapi.conf
/etc/opt/ibapi-1.0//ibapi.conf
~/.ibapi/ibapi.conf
~/.ibapi-1.0/ibapi.conf
The IBAPI configuration files which can be used to set defaults for
nearly all of the options described above. Any combination of these
may be used. Each file found is read in turn, with settings in later
files overriding those in previous files. Note that command line
options override all config file settings.
SEE ALSO
a:add(1), a:delete(1), a:get(1), a:update(1), alias(1), alias:add(1),
alias:delete(1), alias:get(1), alias:update(1), cname(1), cname:add(1),
cname:delete(1), cname:get(1), cname:update(1), fixedaddress(1),
fixedaddress:add(1), fixedaddress:delete(1), fixedaddress:get(1),
fixedaddress:update(1), grid(1), host(1), host:add(1), host:delete(1),
host:get(1), host:update(1), ibapi(1), ptr(1), ptr:add(1),
ptr:delete(1), ptr:get(1), ptr:update(1), url(1), url:add(1),
url:delete(1), url:get(1), url:update(1), mx(1), mx:add(1),
mx:delete(1), mx:get(1), mx:update(1), txt(1), txt:add(1),
txt:delete(1), txt:get(1), txt:update(1), authzone(1), authzone:add(1),
authzone:delete(1), authzone:get(1), authzone:update(1), ibapi.conf(5)
`
PodMap["a:add"] = `
NAME
ibapi a add - create Infoblox A records
USAGE
ibapi a add <options/args>
DESCRIPTION
The add command is used to create Infoblox A records. To create a single
A record, a single hostname and IP address can be provided as command
line arguments, in either order. Alternatively, a list of records to add
can be specified in a file (see --filename).
OPTIONS
Some options can be specified with either a short (i.e., -h) or long
(i.e., --help) form. In the latter case, case is non-sensitive.
Boolean options (flags) do not require a value. "-v" is equivalent to
"-v=true". To disable, set to "false" ("-v=false" or "--verbose=false").
Most options have a corresponding configuration file setting that is
equal to the long option name without the "--" prefix. Command line
options always override configuration file settings. Use the
--ShowConfig to view each option and its value.
OPTIONS - General
-V <view>, --View=<view>:
Specify the view for the new record. Default: "default".
-D, --Disable:
Disable the new record. Default: false.
-c <comment>, --Comment=<comment>:
Specify the comment for the new record. Alternatively, you can
specify this via the --fields option. Default: "ibapi:address:add".
--TTL=<ttl>:
Specify the ttl for the new record. Alternatively, you can specify
this via the --fields option.
-F <fields>, --Fields=<fields>:
Specify fields and corresponding values for the new record. For
instance: "comment=RT100931",view=default,ttl=900".
-f <filename>, --Filename=<filename>:
Specify a filename containing a list of A records to create. Each
line should contain a hostname and an IP address, in either order,
separated by one or more spaces. Blank lines and lines beginning
with "#" are ignored, as is anything on a line following a "#".
-C, --Check:
Before creating a new record, check if any "related" records already
exist, and if so do not create the new record. Related records are
those that share the same name and/or content, such as an Host
record and A record with the same name and/or IP address. Default:
false.
OPTIONS - API Options
--APIBaseURL=<url>:
API base URL. Default: "https://infoblox.rice.edu/wapi/v2.11"
--HTTPTimeout=<seconds>:
Timeout in seconds for the HTTP connection. Default: 10.
--APIAuthMethod=<method>:
WAPI authentication method for accessing the Infoblox API.
Currently, only "Basic" authentication (username and password) is
supported.
--username=<username>:
Specify the username used for basic auth.
--password=<password>:
Specify the password used for basic auth. If this option is
specified and is non-empty, either the --username option can be used
to specify the corresponding username, or the current user will be
assumed for username.
--PromptForPassword:
Prompt the user for the password used for basic authentication. This
is done automatically unless one of these options is specified:
--password, --APIAuthToken, --APIAuthTokenID.
--APIAuthToken=<token>:
As an alternative to specifing a username and password separately,
an "authentication token" containing both the username and password,
separated by a ':', can be specified.
--APIAuthTokenID=<tokenID>:
As an alternative to specifying a username/password or an
APIAuthToken directly, the name of an authentication token ID which
maps to an authentication token can be specified. See also
--SecretsDir. Default: "owlapi_basic".
--SecretsDir=<pathname>:
Specify a directory where optional "secret files" are kept. These
files can be used as a slightly safer alternative to storing
authentication credentials in the standard configuration files. The
name of a secret file corresponds to a "tokenID" configured via
--APIAuthTokenID, and the file contains an authentication token.
Obviously, these files should be safely guarded or avoided
altogether. Default: "/etc/opt/ibapi/private".
--GridReference=<grid_reference>:
Specify the Infoblox grid reference ID. This can be used to save a
fetch when the --restartServices option is specified. While this
option is only relevant to a few commands, it is allowed (ignored)
by the other commands.
OPTIONS - Common To All IBAPI Commands
-h, --help:
Help; show usage information and exit.
--showConfig:
Read in and show all configuration settings and exit.
-q, --Quiet:
Be quieter than normal.
--Quieter:
Quieter mode. Suppress all messages except warning and error
messages.
-v, --Verbose:
Be louder than normal. Over-rides the "--Quiet" and "-Quieter"
options. Note such extra details are printed to Stderr so that the
normal output remains the same regardless of verbosity.
--page:
Page help/usage information via the command specified by the --Pager
option or the environment variable "PAGER". If neither of these is
set, this option is ignored. Default: true.
--Pager=<pager>:
Specify a pager command for paging the usage information (shown with
--help). By default, the environment variable PAGER is used. If a
full path is not specified, the command is searched for using the
PATH environment variable.
EXAMPLES
ibapi a add rb4.rice.edu 168.7.56.224
Create a new A record with hostname "rb4.rice.edu" and IP address
"168.7.56.224".
ibapi a add -V external -f /tmp/hosts
Create an A record in the "external" view for each hostname/IP pair
specified in the file "/tmp/hosts".
FILES
/usr/site/ibapi-1.0/etc/ibapi.conf
/etc/opt/ibapi/ibapi.conf
/etc/opt/ibapi-1.0//ibapi.conf
~/.ibapi/ibapi.conf
~/.ibapi-1.0/ibapi.conf
The IBAPI configuration files which can be used to set defaults for
nearly all of the options described above. Any combination of these
may be used. Each file found is read in turn, with settings in later
files overriding those in previous files. Note that command line
options override all config file settings.
SEE ALSO
a(1), a:delete(1), a:get(1), a:update(1), alias(1), alias:add(1),
alias:delete(1), alias:get(1), alias:update(1), cname(1), cname:add(1),
cname:delete(1), cname:get(1), cname:update(1), fixedaddress(1),
fixedaddress:add(1), fixedaddress:delete(1), fixedaddress:get(1),
fixedaddress:update(1), grid(1), host(1), host:add(1), host:delete(1),
host:get(1), host:update(1), ibapi(1), ptr(1), ptr:add(1),
ptr:delete(1), ptr:get(1), ptr:update(1), url(1), url:add(1),
url:delete(1), url:get(1), url:update(1), mx(1), mx:add(1),
mx:delete(1), mx:get(1), mx:update(1), txt(1), txt:add(1),
txt:delete(1), txt:get(1), txt:update(1), authzone(1), authzone:add(1),
authzone:delete(1), authzone:get(1), authzone:update(1), ibapi.conf(5)
`
PodMap["a:delete"] = `
NAME
ibapi a delete - delete Infoblox A records
USAGE
ibapi a delete <options/args>
DESCRIPTION
The delete command is used to delete Infoblox A records. To delete a
single A record, a single hostname and optionally an IP address may be
provided as command line arguments. Alternatively, a list of records to
delete can be specified in a file (see --filename).
If an IP address is specified, the A record to delete must contain that
IP address, else no address will be deleted. If no IP address is
specified, the A record is deleted regardless of its IP address(es).
=head1 OPTIONS
Some options can be specified with either a short (i.e., -h) or long
(i.e., --help) form. In the latter case, case is non-sensitive.
Boolean options (flags) do not require a value. "-v" is equivalent to
"-v=true". To disable, set to "false" ("-v=false" or "--verbose=false").
Most options have a corresponding configuration file setting that is
equal to the long option name without the "--" prefix. Command line
options always override configuration file settings. Use the
--ShowConfig to view each option and its value.
OPTIONS - General
-V <view>, --View=<view>:
Specify the view of the record to delete. Default: "default".
-f <filename>, --filename=<filename>:
Specify a filename containing a list of A records to delete. Each
line should contain a hostname and optionally an IP address, in
either order, separated by one or more spaces. Blank lines and lines
beginning with "#" are ignored, as is anything on a line following a
"#".
OPTIONS - API Options
--APIBaseURL=<url>:
API base URL. Default: "https://infoblox.rice.edu/wapi/v2.11"
--HTTPTimeout=<seconds>:
Timeout in seconds for the HTTP connection. Default: 10.
--APIAuthMethod=<method>:
WAPI authentication method for accessing the Infoblox API.
Currently, only "Basic" authentication (username and password) is
supported.
--username=<username>:
Specify the username used for basic auth.
--password=<password>:
Specify the password used for basic auth. If this option is
specified and is non-empty, either the --username option can be used
to specify the corresponding username, or the current user will be
assumed for username.
--PromptForPassword:
Prompt the user for the password used for basic authentication. This
is done automatically unless one of these options is specified:
--password, --APIAuthToken, --APIAuthTokenID.
--APIAuthToken=<token>:
As an alternative to specifing a username and password separately,
an "authentication token" containing both the username and password,
separated by a ':', can be specified.
--APIAuthTokenID=<tokenID>:
As an alternative to specifying a username/password or an
APIAuthToken directly, the name of an authentication token ID which
maps to an authentication token can be specified. See also
--SecretsDir. Default: "owlapi_basic".
--SecretsDir=<pathname>:
Specify a directory where optional "secret files" are kept. These
files can be used as a slightly safer alternative to storing
authentication credentials in the standard configuration files. The
name of a secret file corresponds to a "tokenID" configured via
--APIAuthTokenID, and the file contains an authentication token.
Obviously, these files should be safely guarded or avoided
altogether. Default: "/etc/opt/ibapi/private".
--GridReference=<grid_reference>:
Specify the Infoblox grid reference ID. This can be used to save a
fetch when the --restartServices option is specified. While this
option is only relevant to a few commands, it is allowed (ignored)
by the other commands.
OPTIONS - Common To All IBAPI Commands
-h, --help:
Help; show usage information and exit.
--showConfig:
Read in and show all configuration settings and exit.
-q, --Quiet:
Be quieter than normal.
--Quieter:
Quieter mode. Suppress all messages except warning and error
messages.
-v, --Verbose:
Be louder than normal. Over-rides the "--Quiet" and "-Quieter"
options. Note such extra details are printed to Stderr so that the
normal output remains the same regardless of verbosity.
--page:
Page help/usage information via the command specified by the --Pager
option or the environment variable "PAGER". If neither of these is
set, this option is ignored. Default: true.
--Pager=<pager>:
Specify a pager command for paging the usage information (shown with
--help). By default, the environment variable PAGER is used. If a
full path is not specified, the command is searched for using the
PATH environment variable.
EXAMPLES
ibapi a delete rb4.rice.edu 168.7.56.224
Delete the A record with hostname "rb4.rice.edu" and IP address
"168.7.56.224".
FILES
/usr/site/ibapi-1.0/etc/ibapi.conf
/etc/opt/ibapi/ibapi.conf
/etc/opt/ibapi-1.0//ibapi.conf
~/.ibapi/ibapi.conf
~/.ibapi-1.0/ibapi.conf
The IBAPI configuration files which can be used to set defaults for
nearly all of the options described above. Any combination of these
may be used. Each file found is read in turn, with settings in later
files overriding those in previous files. Note that command line
options override all config file settings.
SEE ALSO
a(1), a:add(1), a:get(1), a:update(1), alias(1), alias:add(1),
alias:delete(1), alias:get(1), alias:update(1), cname(1), cname:add(1),
cname:delete(1), cname:get(1), cname:update(1), fixedaddress(1),
fixedaddress:add(1), fixedaddress:delete(1), fixedaddress:get(1),
fixedaddress:update(1), grid(1), host(1), host:add(1), host:delete(1),
host:get(1), host:update(1), ibapi(1), ptr(1), ptr:add(1),
ptr:delete(1), ptr:get(1), ptr:update(1), url(1), url:add(1),
url:delete(1), url:get(1), url:update(1), mx(1), mx:add(1),
mx:delete(1), mx:get(1), mx:update(1), txt(1), txt:add(1),
txt:delete(1), txt:get(1), txt:update(1), authzone(1), authzone:add(1),
authzone:delete(1), authzone:get(1), authzone:update(1), ibapi.conf(5)
`
PodMap["a:get"] = `
NAME
ibapi a get - get Infoblox A records
USAGE
ibapi a get <options/args>
DESCRIPTION
The get command is used to read/fetch Infoblox A records.
By default, the hostname and IP address of each fetched record is shown.
The --verbose option can be specified to print out the raw response from
the API.
To fetch a single A record, a single hostname and/or IP address may be
provided as command line arguments. Alternatively, a list of records to
fetch can be specified in a file (see --filename).
OPTIONS
Some options can be specified with either a short (i.e., -h) or long
(i.e., --help) form. In the latter case, case is non-sensitive.
Boolean options (flags) do not require a value. "-v" is equivalent to
"-v=true". To disable, set to "false" ("-v=false" or "--verbose=false").
Most options have a corresponding configuration file setting that is
equal to the long option name without the "--" prefix. Command line
options always override configuration file settings. Use the
--ShowConfig to view each option and its value.
OPTIONS - General
-V <view>, --View=<view>:
Specify the view of the record to fetch. Specify "any" to search for
records in all views. Default: "any".
-F <fields>, --Fields=<fields>:
Specify a comma-separated list of field name/value pairs to restrict
the record(s) fetched.
-R <return_fields>, --rFields=<return_fields>:
Specify additional fields to show when in Verbose mode.
-f <filename>, --filename=<filename>:
Specify a filename containing a list of records to get. Each line
should contain a hostname and/or an IP address, in either order,
separated by one or more spaces. Blank lines and lines beginning
with "#" are ignored, as is anything on a line following a "#".
-r <obj_ref>, --Ref=<obj_ref>:
Instead of showing the name and content of the fetched record(s),
show the object reference of each record.
OPTIONS - API Options
--APIBaseURL=<url>:
API base URL. Default: "https://infoblox.rice.edu/wapi/v2.11"
--HTTPTimeout=<seconds>:
Timeout in seconds for the HTTP connection. Default: 10.
--APIAuthMethod=<method>:
WAPI authentication method for accessing the Infoblox API.
Currently, only "Basic" authentication (username and password) is
supported.
--username=<username>:
Specify the username used for basic auth.
--password=<password>:
Specify the password used for basic auth. If this option is
specified and is non-empty, either the --username option can be used
to specify the corresponding username, or the current user will be
assumed for username.
--PromptForPassword:
Prompt the user for the password used for basic authentication. This
is done automatically unless one of these options is specified:
--password, --APIAuthToken, --APIAuthTokenID.
--APIAuthToken=<token>:
As an alternative to specifing a username and password separately,
an "authentication token" containing both the username and password,
separated by a ':', can be specified.
--APIAuthTokenID=<tokenID>:
As an alternative to specifying a username/password or an
APIAuthToken directly, the name of an authentication token ID which
maps to an authentication token can be specified. See also
--SecretsDir. Default: "owlapi_basic".
--SecretsDir=<pathname>:
Specify a directory where optional "secret files" are kept. These
files can be used as a slightly safer alternative to storing
authentication credentials in the standard configuration files. The
name of a secret file corresponds to a "tokenID" configured via
--APIAuthTokenID, and the file contains an authentication token.
Obviously, these files should be safely guarded or avoided
altogether. Default: "/etc/opt/ibapi/private".
--GridReference=<grid_reference>:
Specify the Infoblox grid reference ID. This can be used to save a
fetch when the --restartServices option is specified. While this
option is only relevant to a few commands, it is allowed (ignored)
by the other commands.
OPTIONS - Common To All IBAPI Commands
-h, --help:
Help; show usage information and exit.
--showConfig:
Read in and show all configuration settings and exit.
-q, --Quiet:
Be quieter than normal.
--Quieter:
Quieter mode. Suppress all messages except warning and error
messages.
-v, --Verbose:
Be louder than normal. Over-rides the "--Quiet" and "-Quieter"
options. Note such extra details are printed to Stderr so that the
normal output remains the same regardless of verbosity.
--page:
Page help/usage information via the command specified by the --Pager
option or the environment variable "PAGER". If neither of these is
set, this option is ignored. Default: true.
--Pager=<pager>:
Specify a pager command for paging the usage information (shown with
--help). By default, the environment variable PAGER is used. If a
full path is not specified, the command is searched for using the
PATH environment variable.
EXAMPLES
ibapi a get -F name~=mx -V external
Fetch each A record (in the external DNS view) whose name matches
"mx".
ibapi a get -F ipv4addr~=128.42.201.
Fetch each A record (in any DNS view) whose IP address matches
"128.42.201.".
ibapi a get rb4.rice.edu
Fetch each A record with hostname "rb4.rice.edu".
ibapi a get 168.7.56.224
Fetch each A record with IP address "168.7.56.224".
ibapi a get rb4.rice.edu 168.7.56.224
Fetch each A record with hostname "rb4.rice.edu" and IP address
"168.7.56.224".
FILES
/usr/site/ibapi-1.0/etc/ibapi.conf
/etc/opt/ibapi/ibapi.conf
/etc/opt/ibapi-1.0//ibapi.conf
~/.ibapi/ibapi.conf
~/.ibapi-1.0/ibapi.conf
The IBAPI configuration files which can be used to set defaults for
nearly all of the options described above. Any combination of these
may be used. Each file found is read in turn, with settings in later
files overriding those in previous files. Note that command line
options override all config file settings.
SEE ALSO
a(1), a:add(1), a:delete(1), a:update(1), alias(1), alias:add(1),
alias:delete(1), alias:get(1), alias:update(1), cname(1), cname:add(1),
cname:delete(1), cname:get(1), cname:update(1), fixedaddress(1),
fixedaddress:add(1), fixedaddress:delete(1), fixedaddress:get(1),
fixedaddress:update(1), grid(1), host(1), host:add(1), host:delete(1),
host:get(1), host:update(1), ibapi(1), ptr(1), ptr:add(1),
ptr:delete(1), ptr:get(1), ptr:update(1), url(1), url:add(1),
url:delete(1), url:get(1), url:update(1), mx(1), mx:add(1),
mx:delete(1), mx:get(1), mx:update(1), txt(1), txt:add(1),
txt:delete(1), txt:get(1), txt:update(1), authzone(1), authzone:add(1),
authzone:delete(1), authzone:get(1), authzone:update(1), ibapi.conf(5)
`
PodMap["alias"] = `
NAME
ibapi alias - create, read, update and delete Infoblox Alias records
USAGE
ibapi alias <add|get|update|delete> <options/args>
DESCRIPTION
"ibapi alias" can be used to add, get, update and delete Infoblox Alias
records. The basic format is
* ibapi alias <operation> <options/args>
For more details, invoke the specific operation with the --help|-h
option. For example:
* ibapi alias add -h
EXAMPLES
ibapi alias add -t 600 rb4.rice.edu somewhere.com
Add an Alias record.
ibapi alias delete rb4.rice.edu somewhere.com
Delete an Alias record with A record target type..
FILES
/usr/site/ibapi-1.0/etc/ibapi.conf
/etc/opt/ibapi/ibapi.conf
/etc/opt/ibapi-1.0//ibapi.conf
~/.ibapi/ibapi.conf
~/.ibapi-1.0/ibapi.conf
The IBAPI configuration files which can be used to set defaults for
nearly all of the options described above. Any combination of these
may be used. Each file found is read in turn, with settings in later
files overriding those in previous files. Note that command line
options override all config file settings.
SEE ALSO
a(1), a:add(1), a:delete(1), a:get(1), a:update(1), alias:add(1),
alias:delete(1), alias:get(1), alias:update(1), cname(1), cname:add(1),
cname:delete(1), cname:get(1), cname:update(1), fixedaddress(1),
fixedaddress:add(1), fixedaddress:delete(1), fixedaddress:get(1),
fixedaddress:update(1), grid(1), host(1), host:add(1), host:delete(1),
host:get(1), host:update(1), ibapi(1), ptr(1), ptr:add(1),
ptr:delete(1), ptr:get(1), ptr:update(1), url(1), url:add(1),
url:delete(1), url:get(1), url:update(1), mx(1), mx:add(1),
mx:delete(1), mx:get(1), mx:update(1), txt(1), txt:add(1),
txt:delete(1), txt:get(1), txt:update(1), authzone(1), authzone:add(1),
authzone:delete(1), authzone:get(1), authzone:update(1), ibapi.conf(5)
`
PodMap["alias:add"] = `
NAME
ibapi alias add - create Infoblox Alias records
USAGE
ibapi alias add <options/args>
DESCRIPTION
The add command is used to create Infoblox Alias records. To create a
single Alias record, a single hostname and target can be provided as
command line arguments. Alternatively, a list of records to add can be
specified in a file (see --filename).
OPTIONS
Some options can be specified with either a short (i.e., -h) or long
(i.e., --help) form. In the latter case, case is non-sensitive.
Boolean options (flags) do not require a value. "-v" is equivalent to
"-v=true". To disable, set to "false" ("-v=false" or "--verbose=false").
Most options have a corresponding configuration file setting that is
equal to the long option name without the "--" prefix. Command line
options always override configuration file settings. Use the
--ShowConfig to view each option and its value.
OPTIONS - General
-V <view>, --View=<view>:
Specify the view for the new record. Default: "default".
-D, --Disable:
Disable the new record. Default: false.
-T <targetType>, --TargetType=<targetType>:
Specify the target type for the Alias record. Default: A record.
-c <comment>, --Comment=<comment>:
Specify the comment for the new record. Alternatively, you can
specify this via the --fields option. Default: "ibapi:alias:add".
-F <fields>, --Fields=<fields>:
Specify fields and corresponding values for the new record. For
instance: "comment=RT100931",view=default,ttl=900".
-f <filename>, --Filename=<filename>:
Specify a filename containing a list of Alias records to create.
Each line should contain a hostname and a target, separated by one
or more spaces. Blank lines and lines beginning with "#" are
ignored, as is anything on a line following a "#".
-C, --Check:
Before creating a new record, check if any "related" records already
exist, and if so do not create the new record. Related records are
those that share the same name and/or content. Default: false.
OPTIONS - API Options
--APIBaseURL=<url>:
API base URL. Default: "https://infoblox.rice.edu/wapi/v2.11"
--HTTPTimeout=<seconds>:
Timeout in seconds for the HTTP connection. Default: 10.
--APIAuthMethod=<method>:
WAPI authentication method for accessing the Infoblox API.
Currently, only "Basic" authentication (username and password) is
supported.
--username=<username>:
Specify the username used for basic auth.
--password=<password>:
Specify the password used for basic auth. If this option is
specified and is non-empty, either the --username option can be used
to specify the corresponding username, or the current user will be
assumed for username.
--PromptForPassword:
Prompt the user for the password used for basic authentication. This
is done automatically unless one of these options is specified:
--password, --APIAuthToken, --APIAuthTokenID.
--APIAuthToken=<token>:
As an alternative to specifing a username and password separately,
an "authentication token" containing both the username and password,
separated by a ':', can be specified.
--APIAuthTokenID=<tokenID>:
As an alternative to specifying a username/password or an
APIAuthToken directly, the name of an authentication token ID which
maps to an authentication token can be specified. See also
--SecretsDir. Default: "owlapi_basic".
--SecretsDir=<pathname>:
Specify a directory where optional "secret files" are kept. These
files can be used as a slightly safer alternative to storing
authentication credentials in the standard configuration files. The
name of a secret file corresponds to a "tokenID" configured via
--APIAuthTokenID, and the file contains an authentication token.
Obviously, these files should be safely guarded or avoided
altogether. Default: "/etc/opt/ibapi/private".
--GridReference=<grid_reference>:
Specify the Infoblox grid reference ID. This can be used to save a
fetch when the --restartServices option is specified. While this
option is only relevant to a few commands, it is allowed (ignored)
by the other commands.
OPTIONS - Common To All IBAPI Commands
-h, --help:
Help; show usage information and exit.
--showConfig:
Read in and show all configuration settings and exit.
-q, --Quiet:
Be quieter than normal.
--Quieter:
Quieter mode. Suppress all messages except warning and error
messages.
-v, --Verbose:
Be louder than normal. Over-rides the "--Quiet" and "-Quieter"
options. Note such extra details are printed to Stderr so that the
normal output remains the same regardless of verbosity.
--page:
Page help/usage information via the command specified by the --Pager
option or the environment variable "PAGER". If neither of these is
set, this option is ignored. Default: true.
--Pager=<pager>:
Specify a pager command for paging the usage information (shown with
--help). By default, the environment variable PAGER is used. If a
full path is not specified, the command is searched for using the
PATH environment variable.
EXAMPLES
ibapi alias add rb4.rice.edu somewhere.com
Create a new Alias record with hostname "rb4.rice.edu" and A record
target "somewhere.com".
ibapi alias add -T TXT rb4.rice.edu somewhere.com
Create a new Alias record with hostname "rb4.rice.edu" and TXT
record target "somewhere.com".
FILES
/usr/site/ibapi-1.0/etc/ibapi.conf
/etc/opt/ibapi/ibapi.conf
/etc/opt/ibapi-1.0//ibapi.conf
~/.ibapi/ibapi.conf
~/.ibapi-1.0/ibapi.conf
The IBAPI configuration files which can be used to set defaults for
nearly all of the options described above. Any combination of these
may be used. Each file found is read in turn, with settings in later
files overriding those in previous files. Note that command line
options override all config file settings.
SEE ALSO
a(1), a:add(1), a:delete(1), a:get(1), a:update(1), alias(1),
alias:delete(1), alias:get(1), alias:update(1), cname(1), cname:add(1),
cname:delete(1), cname:get(1), cname:update(1), fixedaddress(1),
fixedaddress:add(1), fixedaddress:delete(1), fixedaddress:get(1),
fixedaddress:update(1), grid(1), host(1), host:add(1), host:delete(1),
host:get(1), host:update(1), ibapi(1), ptr(1), ptr:add(1),
ptr:delete(1), ptr:get(1), ptr:update(1), url(1), url:add(1),
url:delete(1), url:get(1), url:update(1), mx(1), mx:add(1),
mx:delete(1), mx:get(1), mx:update(1), txt(1), txt:add(1),
txt:delete(1), txt:get(1), txt:update(1), authzone(1), authzone:add(1),
authzone:delete(1), authzone:get(1), authzone:update(1), ibapi.conf(5)
`
PodMap["alias:delete"] = `
NAME
ibapi alias delete - delete Infoblox Alias records
USAGE
ibapi alias delete <options/args>
DESCRIPTION
The delete command is used to delete Infoblox Alias records. To delete a
single Alias record, a single hostname and optionally a target be
provided as command line arguments. Alternatively, a list of records to
delete can be specified in a file (see --filename).
OPTIONS
Some options can be specified with either a short (i.e., -h) or long
(i.e., --help) form. In the latter case, case is non-sensitive.
Boolean options (flags) do not require a value. "-v" is equivalent to
"-v=true". To disable, set to "false" ("-v=false" or "--verbose=false").
Most options have a corresponding configuration file setting that is
equal to the long option name without the "--" prefix. Command line
options always override configuration file settings. Use the
--ShowConfig to view each option and its value.
OPTIONS - General
-V <view>, --View=<view>:
Specify the view of the record to delete. Default: "default".
-T <targetType>, --TargetType=<targetType>:
Specify the target type to delete. Default: A record.
-f <filename>, --filename=<filename>:
Specify a filename containing a list of Alias records to delete.
Each line should contain a hostname and optionally a target,
separated by one or more spaces. Blank lines and lines beginning
with "#" are ignored, as is anything on a line following a "#".
OPTIONS - API Options
--APIBaseURL=<url>:
API base URL. Default: "https://infoblox.rice.edu/wapi/v2.11"
--HTTPTimeout=<seconds>:
Timeout in seconds for the HTTP connection. Default: 10.
--APIAuthMethod=<method>:
WAPI authentication method for accessing the Infoblox API.
Currently, only "Basic" authentication (username and password) is
supported.
--username=<username>:
Specify the username used for basic auth.
--password=<password>:
Specify the password used for basic auth. If this option is
specified and is non-empty, either the --username option can be used
to specify the corresponding username, or the current user will be
assumed for username.
--PromptForPassword:
Prompt the user for the password used for basic authentication. This
is done automatically unless one of these options is specified:
--password, --APIAuthToken, --APIAuthTokenID.
--APIAuthToken=<token>:
As an alternative to specifing a username and password separately,
an "authentication token" containing both the username and password,
separated by a ':', can be specified.
--APIAuthTokenID=<tokenID>:
As an alternative to specifying a username/password or an
APIAuthToken directly, the name of an authentication token ID which
maps to an authentication token can be specified. See also
--SecretsDir. Default: "owlapi_basic".
--SecretsDir=<pathname>:
Specify a directory where optional "secret files" are kept. These
files can be used as a slightly safer alternative to storing
authentication credentials in the standard configuration files. The
name of a secret file corresponds to a "tokenID" configured via
--APIAuthTokenID, and the file contains an authentication token.
Obviously, these files should be safely guarded or avoided
altogether. Default: "/etc/opt/ibapi/private".
--GridReference=<grid_reference>:
Specify the Infoblox grid reference ID. This can be used to save a
fetch when the --restartServices option is specified. While this
option is only relevant to a few commands, it is allowed (ignored)
by the other commands.
OPTIONS - Common To All IBAPI Commands
-h, --help:
Help; show usage information and exit.
--showConfig:
Read in and show all configuration settings and exit.
-q, --Quiet:
Be quieter than normal.
--Quieter:
Quieter mode. Suppress all messages except warning and error
messages.
-v, --Verbose:
Be louder than normal. Over-rides the "--Quiet" and "-Quieter"
options. Note such extra details are printed to Stderr so that the
normal output remains the same regardless of verbosity.
--page:
Page help/usage information via the command specified by the --Pager
option or the environment variable "PAGER". If neither of these is
set, this option is ignored. Default: true.
--Pager=<pager>:
Specify a pager command for paging the usage information (shown with
--help). By default, the environment variable PAGER is used. If a
full path is not specified, the command is searched for using the
PATH environment variable.
EXAMPLES
ibapi alias delete rb4.rice.edu somewhere.com
Delete the Alias record with hostname "rb4.rice.edu" and A record
target "somewhere.com".
ibapi alias delete rb4.rice.edu -T TXT
Delete the "rb4.rice.edu" Alias record of target type TXT.
FILES
/usr/site/ibapi-1.0/etc/ibapi.conf
/etc/opt/ibapi/ibapi.conf
/etc/opt/ibapi-1.0//ibapi.conf
~/.ibapi/ibapi.conf
~/.ibapi-1.0/ibapi.conf
The IBAPI configuration files which can be used to set defaults for
nearly all of the options described above. Any combination of these
may be used. Each file found is read in turn, with settings in later
files overriding those in previous files. Note that command line
options override all config file settings.
SEE ALSO
a(1), a:add(1), a:delete(1), a:get(1), a:update(1), alias(1),
alias:add(1), alias:get(1), alias:update(1), cname(1), cname:add(1),
cname:delete(1), cname:get(1), cname:update(1), fixedaddress(1),
fixedaddress:add(1), fixedaddress:delete(1), fixedaddress:get(1),
fixedaddress:update(1), grid(1), host(1), host:add(1), host:delete(1),
host:get(1), host:update(1), ibapi(1), ptr(1), ptr:add(1),
ptr:delete(1), ptr:get(1), ptr:update(1), url(1), url:add(1),
url:delete(1), url:get(1), url:update(1), mx(1), mx:add(1),
mx:delete(1), mx:get(1), mx:update(1), txt(1), txt:add(1),
txt:delete(1), txt:get(1), txt:update(1), authzone(1), authzone:add(1),
authzone:delete(1), authzone:get(1), authzone:update(1), ibapi.conf(5)
`
PodMap["alias:get"] = `
NAME
ibapi alias get - get Infoblox Alias records
USAGE
ibapi alias get <options/args>
DESCRIPTION
The get command is used to read/fetch Infoblox Alias records.
By default, the hostname and target of each fetched record is shown. The
--verbose option can be specified to print out the raw response from the
API.
To fetch a single Alias record, a single hostname and/or target may be
provided as command line arguments. Alternatively, a list of records to
fetch can be specified in a file (see --filename).
OPTIONS
Some options can be specified with either a short (i.e., -h) or long
(i.e., --help) form. In the latter case, case is non-sensitive.
Boolean options (flags) do not require a value. "-v" is equivalent to
"-v=true". To disable, set to "false" ("-v=false" or "--verbose=false").
Most options have a corresponding configuration file setting that is
equal to the long option name without the "--" prefix. Command line
options always override configuration file settings. Use the
--ShowConfig to view each option and its value.
OPTIONS - General
-V <view>, --View=<view>:
Specify the view of the record to fetch. Specify "any" to search for
records in all views. Default: "any".
-T <targetType>, --TargetType=<targetType>:
Specify the target type of the Alias record to fetch. Specify "any"
to search for all target types. Default: "any".
-F <fields>, --Fields=<fields>:
Specify a comma-separated list of field name/value pairs to restrict
the record(s) fetched.
-R <return_fields>, --rFields=<return_fields>:
Specify additional fields to show when in Verbose mode.
-f <filename>, --filename=<filename>:
Specify a filename containing a list of Alias records to get. Each
line should contain a hostname and/or a target, separated by one or
more spaces. Blank lines and lines beginning with "#" are ignored,
as is anything on a line following a "#".