Skip to content

Commit f935913

Browse files
allmightyspiffallmightyspiff
committed
#1215 adding in a bunch of CLI documentation
1 parent 867a04b commit f935913

File tree

12 files changed

+398
-12
lines changed

12 files changed

+398
-12
lines changed

‎docs/cli/block.rst‎

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
.. _cli_block:
2+
3+
Block Commands
4+
==============
5+
6+
.. click:: SoftLayer.CLI.block.access.authorize:cli
7+
:prog: block access-authorize
8+
:show-nested:
9+
10+
.. click:: SoftLayer.CLI.block.access.list:cli
11+
:prog: block access-list
12+
:show-nested:
13+
14+
.. click:: SoftLayer.CLI.block.access.revoke:cli
15+
:prog: block access-revoke
16+
:show-nested:
17+
18+
.. click:: SoftLayer.CLI.block.access.password:cli
19+
:prog: block access-password
20+
:show-nested:
21+
22+
.. click:: SoftLayer.CLI.block.replication.failback:cli
23+
:prog: block replica-failback
24+
:show-nested:
25+
26+
.. click:: SoftLayer.CLI.block.replication.failover:cli
27+
:prog: block replica-failover
28+
:show-nested:
29+
30+
.. click:: SoftLayer.CLI.block.replication.order:cli
31+
:prog: block replica-order
32+
:show-nested:
33+
34+
.. click:: SoftLayer.CLI.block.replication.partners:cli
35+
:prog: block replica-partners
36+
:show-nested:
37+
38+
.. click:: SoftLayer.CLI.block.replication.locations:cli
39+
:prog: block replica-locations
40+
:show-nested:
41+
42+
.. click:: SoftLayer.CLI.block.snapshot.cancel:cli
43+
:prog: block snapshot-cancel
44+
:show-nested:
45+
46+
.. click:: SoftLayer.CLI.block.snapshot.create:cli
47+
:prog: block snapshot-create
48+
:show-nested:
49+
50+
.. click:: SoftLayer.CLI.block.snapshot.delete:cli
51+
:prog: block snapshot-delete
52+
:show-nested:
53+
54+
.. click:: SoftLayer.CLI.block.snapshot.disable:cli
55+
:prog: block snapshot-disable
56+
:show-nested:
57+
58+
.. click:: SoftLayer.CLI.block.snapshot.enable:cli
59+
:prog: block snapshot-enable
60+
:show-nested:
61+
62+
.. click:: SoftLayer.CLI.block.snapshot.schedule_list:cli
63+
:prog: block snapshot-schedule-list
64+
:show-nested:
65+
66+
.. click:: SoftLayer.CLI.block.snapshot.list:cli
67+
:prog: block snapshot-list
68+
:show-nested:
69+
70+
.. click:: SoftLayer.CLI.block.snapshot.order:cli
71+
:prog: block snapshot-order
72+
:show-nested:
73+
74+
.. click:: SoftLayer.CLI.block.snapshot.restore:cli
75+
:prog: block snapshot-restore
76+
:show-nested:
77+
78+
.. click:: SoftLayer.CLI.block.cancel:cli
79+
:prog: block volume-cancel
80+
:show-nested:
81+
82+
.. click:: SoftLayer.CLI.block.count:cli
83+
:prog: block volume-count
84+
:show-nested:
85+
86+
.. click:: SoftLayer.CLI.block.detail:cli
87+
:prog: block volume-detail
88+
:show-nested:
89+
90+
.. click:: SoftLayer.CLI.block.duplicate:cli
91+
:prog: block volume-duplicate
92+
:show-nested:
93+
94+
.. click:: SoftLayer.CLI.block.list:cli
95+
:prog: block volume-list
96+
:show-nested:
97+
98+
.. click:: SoftLayer.CLI.block.modify:cli
99+
:prog: block volume-modify
100+
:show-nested:
101+
102+
.. click:: SoftLayer.CLI.block.order:cli
103+
:prog: block volume-order
104+
:show-nested:
105+
106+
.. click:: SoftLayer.CLI.block.lun:cli
107+
:prog: block volume-set-lun-id
108+
:show-nested:
109+
110+
.. click:: SoftLayer.CLI.block.limit:cli
111+
:prog: block volume-limits
112+
:show-nested:

‎docs/cli/call_api.rst‎

Lines changed: 0 additions & 9 deletions
This file was deleted.

‎docs/cli/cdn.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _cli_cdn:
22

33
Interacting with CDN
4-
==============================
4+
=====================
55

66

77
.. click:: SoftLayer.CLI.cdn.detail:cli

‎docs/cli/commands.rst‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
.. _cli_commands:
2+
3+
Call API
4+
========
5+
6+
7+
.. click:: SoftLayer.CLI.call_api:cli
8+
:prog: call-api
9+
:show-nested:
10+
11+
12+
Shell
13+
=====
14+
15+
.. click:: SoftLayer.shell.core:cli
16+
:prog: shell
17+
:show-nested:

‎docs/cli/config.rst‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _cli_config:
22

33
Config
4-
========
4+
======
55

66
`Creating an IBMID apikey <https://cloud.ibm.com/docs/iam?topic=iam-userapikey#create_user_key>`_
77
`IBMid for services <https://cloud.ibm.com/docs/iam?topic=iam-iamapikeysforservices>`_
@@ -16,3 +16,8 @@ Config
1616
.. click:: SoftLayer.CLI.config.show:cli
1717
:prog: config show
1818
:show-nested:
19+
20+
21+
.. click:: SoftLayer.CLI.config.setup:cli
22+
:prog: setup
23+
:show-nested:

‎docs/cli/dedicated.rst‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
.. _cli_dedicated:
2+
3+
Dedicated Host Commands
4+
=======================
5+
6+
7+
.. click:: SoftLayer.CLI.dedicatedhost.list:cli
8+
:prog: dedicatedhost list
9+
:show-nested:
10+
11+
.. click:: SoftLayer.CLI.dedicatedhost.create:cli
12+
:prog: dedicatedhost create
13+
:show-nested:
14+
15+
.. click:: SoftLayer.CLI.dedicatedhost.create_options:cli
16+
:prog: dedicatedhost create-options
17+
:show-nested:
18+
19+
.. click:: SoftLayer.CLI.dedicatedhost.detail:cli
20+
:prog: dedicatedhost detail
21+
:show-nested:
22+
23+
.. click:: SoftLayer.CLI.dedicatedhost.cancel:cli
24+
:prog: dedicatedhost cancel
25+
:show-nested:
26+
27+
.. click:: SoftLayer.CLI.dedicatedhost.cancel_guests:cli
28+
:prog: dedicatedhost cancel-guests
29+
:show-nested:
30+
31+
.. click:: SoftLayer.CLI.dedicatedhost.list_guests:cli
32+
:prog: dedicatedhost list-guests
33+
:show-nested:

‎docs/cli/dns.rst‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
.. _cli_dns:
2+
3+
DNS Management
4+
==============
5+
6+
7+
.. click:: SoftLayer.CLI.dns.zone_import:cli
8+
:prog: dns import
9+
:show-nested:
10+
11+
.. click:: SoftLayer.CLI.dns.record_add:cli
12+
:prog: dns record-add
13+
:show-nested:
14+
15+
.. click:: SoftLayer.CLI.dns.record_edit:cli
16+
:prog: dns record-edit
17+
:show-nested:
18+
19+
.. click:: SoftLayer.CLI.dns.record_list:cli
20+
:prog: dns record-list
21+
:show-nested:
22+
23+
.. click:: SoftLayer.CLI.dns.record_remove:cli
24+
:prog: dns record-remove
25+
:show-nested:
26+
27+
.. click:: SoftLayer.CLI.dns.zone_create:cli
28+
:prog: dns zone-create
29+
:show-nested:
30+
31+
.. click:: SoftLayer.CLI.dns.zone_delete:cli
32+
:prog: dns zone-delete
33+
:show-nested:
34+
35+
.. click:: SoftLayer.CLI.dns.zone_list:cli
36+
:prog: dns zone-list
37+
:show-nested:
38+
39+
.. click:: SoftLayer.CLI.dns.zone_print:cli
40+
:prog: dns zone-print
41+
:show-nested:

‎docs/cli/file.rst‎

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
.. _cli_file:
2+
3+
File Commands
4+
=============
5+
6+
.. click:: SoftLayer.CLI.file.access.authorize:cli
7+
:prog: file access-authorize
8+
:show-nested:
9+
10+
.. click:: SoftLayer.CLI.file.access.list:cli
11+
:prog: file access-list
12+
:show-nested:
13+
14+
.. click:: SoftLayer.CLI.file.access.revoke:cli
15+
:prog: file access-revoke
16+
:show-nested:
17+
18+
.. click:: SoftLayer.CLI.file.replication.failback:cli
19+
:prog: file replica-failback
20+
:show-nested:
21+
22+
.. click:: SoftLayer.CLI.file.replication.failover:cli
23+
:prog: file replica-failover
24+
:show-nested:
25+
26+
.. click:: SoftLayer.CLI.file.replication.order:cli
27+
:prog: file replica-order
28+
:show-nested:
29+
30+
.. click:: SoftLayer.CLI.file.replication.partners:cli
31+
:prog: file replica-partners
32+
:show-nested:
33+
34+
.. click:: SoftLayer.CLI.file.replication.locations:cli
35+
:prog: file replica-locations
36+
:show-nested:
37+
38+
.. click:: SoftLayer.CLI.file.snapshot.cancel:cli
39+
:prog: file snapshot-cancel
40+
:show-nested:
41+
42+
.. click:: SoftLayer.CLI.file.snapshot.create:cli
43+
:prog: file snapshot-create
44+
:show-nested:
45+
46+
.. click:: SoftLayer.CLI.file.snapshot.delete:cli
47+
:prog: file snapshot-delete
48+
:show-nested:
49+
50+
.. click:: SoftLayer.CLI.file.snapshot.disable:cli
51+
:prog: file snapshot-disable
52+
:show-nested:
53+
54+
.. click:: SoftLayer.CLI.file.snapshot.enable:cli
55+
:prog: file snapshot-enable
56+
:show-nested:
57+
58+
.. click:: SoftLayer.CLI.file.snapshot.list:cli
59+
:prog: file snapshot-list
60+
:show-nested:
61+
62+
.. click:: SoftLayer.CLI.file.snapshot.order:cli
63+
:prog: file snapshot-order
64+
:show-nested:
65+
66+
.. click:: SoftLayer.CLI.file.snapshot.restore:cli
67+
:prog: file snapshot-restore
68+
:show-nested:
69+
70+
.. click:: SoftLayer.CLI.file.cancel:cli
71+
:prog: file volume-cancel
72+
:show-nested:
73+
74+
.. click:: SoftLayer.CLI.file.count:cli
75+
:prog: file volume-count
76+
:show-nested:
77+
78+
.. click:: SoftLayer.CLI.file.detail:cli
79+
:prog: file volume-detail
80+
:show-nested:
81+
82+
.. click:: SoftLayer.CLI.file.duplicate:cli
83+
:prog: file volume-duplicate
84+
:show-nested:
85+
86+
.. click:: SoftLayer.CLI.file.list:cli
87+
:prog: file volume-list
88+
:show-nested:
89+
90+
.. click:: SoftLayer.CLI.file.modify:cli
91+
:prog: file volume-modify
92+
:show-nested:
93+
94+
.. click:: SoftLayer.CLI.file.order:cli
95+
:prog: file volume-order
96+
:show-nested:
97+
98+
.. click:: SoftLayer.CLI.file.limit:cli
99+
:prog: file volume-limits
100+
:show-nested:
101+
102+
.. click:: SoftLayer.CLI.file.snapshot.schedule_list:cli
103+
:prog: file snapshot-schedule-list
104+
:show-nested:

‎docs/cli/firewall.rst‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
.. _cli_firewall:
2+
3+
Firewall Management
4+
===================
5+
6+
.. click:: SoftLayer.CLI.firewall.add:cli
7+
:prog: firewall add
8+
:show-nested:
9+
10+
.. click:: SoftLayer.CLI.firewall.cancel:cli
11+
:prog: firewall cancel
12+
:show-nested:
13+
14+
.. click:: SoftLayer.CLI.firewall.detail:cli
15+
:prog: firewall detail
16+
:show-nested:
17+
18+
.. click:: SoftLayer.CLI.firewall.edit:cli
19+
:prog: firewall edit
20+
:show-nested:
21+
22+
.. click:: SoftLayer.CLI.firewall.list:cli
23+
:prog: firewall list
24+
:show-nested:

‎docs/cli/global_ip.rst‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
.. _cli_global_ip:
2+
3+
Global IP Addresses
4+
===================
5+
6+
.. click:: SoftLayer.CLI.globalip.assign:cli
7+
:prog: globalip assign
8+
:show-nested:
9+
10+
.. click:: SoftLayer.CLI.globalip.cancel:cli
11+
:prog: globalip cancel
12+
:show-nested:
13+
14+
.. click:: SoftLayer.CLI.globalip.create:cli
15+
:prog: globalip create
16+
:show-nested:
17+
18+
.. click:: SoftLayer.CLI.globalip.list:cli
19+
:prog: globalip list
20+
:show-nested:
21+
22+
.. click:: SoftLayer.CLI.globalip.unassign:cli
23+
:prog: globalip unassign
24+
:show-nested:

0 commit comments

Comments
 (0)