Skip to content

Commit 6e9864c

Browse files
author
Ryan Rossiter
committed
Update slcli doc with new subcommands
The CLI doc still had some old commands in it, so those have been removed. There have also been new commands added to slcli that weren't reflected in the doc.
1 parent 51eb140 commit 6e9864c

File tree

1 file changed

+48
-42
lines changed

1 file changed

+48
-42
lines changed

docs/cli.rst

Lines changed: 48 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -58,48 +58,54 @@ To discover the available commands, simply type `slcli`.
5858
::
5959

6060
$ slcli
61-
Usage: slcli [OPTIONS] COMMAND [ARGS]...
62-
63-
SoftLayer Command-line Client
64-
65-
Options:
66-
--format [table|raw|json] Output format
67-
-C, --config PATH Config file location
68-
--debug [0|1|2|3] Sets the debug noise level
69-
-v, --verbose Sets the debug noise level
70-
--timings Time each API call and display after results
71-
--proxy TEXT HTTP[S] proxy to be use to make API calls
72-
-y, --really Confirm all prompt actions
73-
--fixtures Use fixtures instead of actually making API calls
74-
--version Show the version and exit.
75-
--help Show this message and exit.
76-
77-
Commands:
78-
call-api Call arbitrary API endpoints.
79-
cdn Content Delivery Network.
80-
config CLI configuration.
81-
dns Domain Name System.
82-
firewall Firewalls.
83-
globalip Global IP addresses.
84-
image Compute images.
85-
iscsi iSCSI storage.
86-
loadbal Load balancers.
87-
messaging Message queue service.
88-
metadata Find details about this machine.
89-
nas Network Attached Storage.
90-
rwhois Referral Whois.
91-
server Hardware servers.
92-
snapshot Snapshots.
93-
sshkey SSH Keys.
94-
ssl SSL Certificates.
95-
subnet Network subnets.
96-
summary Account summary.
97-
ticket Support tickets.
98-
vlan Network VLANs.
99-
vs Virtual Servers.
100-
101-
To use most commands your SoftLayer username and api_key need to be
102-
configured. The easiest way to do that is to use: 'slcli setup'
61+
Usage: slcli [OPTIONS] COMMAND [ARGS]...
62+
63+
SoftLayer Command-line Client
64+
65+
Options:
66+
--format [table|raw|json|jsonraw]
67+
Output format [default: table]
68+
-C, --config PATH Config file location [default:
69+
~/.softlayer]
70+
-v, --verbose Sets the debug noise level, specify multiple
71+
times for more verbosity.
72+
--proxy TEXT HTTP[S] proxy to be use to make API calls
73+
-y, --really / --not-really Confirm all prompt actions
74+
--demo / --no-demo Use demo data instead of actually making API
75+
calls
76+
--version Show the version and exit.
77+
-h, --help Show this message and exit.
78+
79+
Commands:
80+
block Block Storage.
81+
call-api Call arbitrary API endpoints.
82+
cdn Content Delivery Network.
83+
config CLI configuration.
84+
dns Domain Name System.
85+
file File Storage.
86+
firewall Firewalls.
87+
globalip Global IP addresses.
88+
hardware Hardware servers.
89+
image Compute images.
90+
loadbal Load balancers.
91+
messaging Message queue service.
92+
metadata Find details about this machine.
93+
nas Network Attached Storage.
94+
object-storage Object Storage.
95+
report Reports.
96+
rwhois Referral Whois.
97+
setup Edit configuration.
98+
shell Enters a shell for slcli.
99+
sshkey SSH Keys.
100+
ssl SSL Certificates.
101+
subnet Network subnets.
102+
summary Account summary.
103+
ticket Support tickets.
104+
virtual Virtual Servers.
105+
vlan Network VLANs.
106+
107+
To use most commands your SoftLayer username and api_key need to be
108+
configured. The easiest way to do that is to use: 'slcli setup'
103109

104110
As you can see, there are a number of commands/sections. To look at the list of
105111
subcommands for virtual servers type `slcli vs`. For example:

0 commit comments

Comments
 (0)