Skip to content

Update slcli doc with new subcommands #816

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 25, 2017
Merged

Update slcli doc with new subcommands #816

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
90 changes: 48 additions & 42 deletions docs/cli.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,48 +58,54 @@ To discover the available commands, simply type `slcli`.
::

$ slcli
Usage: slcli [OPTIONS] COMMAND [ARGS]...

SoftLayer Command-line Client

Options:
--format [table|raw|json] Output format
-C, --config PATH Config file location
--debug [0|1|2|3] Sets the debug noise level
-v, --verbose Sets the debug noise level
--timings Time each API call and display after results
--proxy TEXT HTTP[S] proxy to be use to make API calls
-y, --really Confirm all prompt actions
--fixtures Use fixtures instead of actually making API calls
--version Show the version and exit.
--help Show this message and exit.

Commands:
call-api Call arbitrary API endpoints.
cdn Content Delivery Network.
config CLI configuration.
dns Domain Name System.
firewall Firewalls.
globalip Global IP addresses.
image Compute images.
iscsi iSCSI storage.
loadbal Load balancers.
messaging Message queue service.
metadata Find details about this machine.
nas Network Attached Storage.
rwhois Referral Whois.
server Hardware servers.
snapshot Snapshots.
sshkey SSH Keys.
ssl SSL Certificates.
subnet Network subnets.
summary Account summary.
ticket Support tickets.
vlan Network VLANs.
vs Virtual Servers.

To use most commands your SoftLayer username and api_key need to be
configured. The easiest way to do that is to use: 'slcli setup'
Usage: slcli [OPTIONS] COMMAND [ARGS]...

SoftLayer Command-line Client

Options:
--format [table|raw|json|jsonraw]
Output format [default: table]
-C, --config PATH Config file location [default:
~/.softlayer]
-v, --verbose Sets the debug noise level, specify multiple
times for more verbosity.
--proxy TEXT HTTP[S] proxy to be use to make API calls
-y, --really / --not-really Confirm all prompt actions
--demo / --no-demo Use demo data instead of actually making API
calls
--version Show the version and exit.
-h, --help Show this message and exit.

Commands:
block Block Storage.
call-api Call arbitrary API endpoints.
cdn Content Delivery Network.
config CLI configuration.
dns Domain Name System.
file File Storage.
firewall Firewalls.
globalip Global IP addresses.
hardware Hardware servers.
image Compute images.
loadbal Load balancers.
messaging Message queue service.
metadata Find details about this machine.
nas Network Attached Storage.
object-storage Object Storage.
report Reports.
rwhois Referral Whois.
setup Edit configuration.
shell Enters a shell for slcli.
sshkey SSH Keys.
ssl SSL Certificates.
subnet Network subnets.
summary Account summary.
ticket Support tickets.
virtual Virtual Servers.
vlan Network VLANs.

To use most commands your SoftLayer username and api_key need to be
configured. The easiest way to do that is to use: 'slcli setup'

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