slcli hw documentation udpates

Author: allmightyspiff

SoftLayer/CLI/hardware/edit.py

@@ -12,18 +12,16 @@
 @click.command()
 @click.argument('identifier')
 @click.option('--domain', '-D', help="Domain portion of the FQDN")
-@click.option('--userfile', '-F', type=click.Path(exists=True, readable=True, resolve_path=True,
-              help="Read userdata from file"))
+@click.option('--userfile', '-F', type=click.Path(exists=True, readable=True, resolve_path=True),
+              help="Read userdata from file")
 @click.option('--tag', '-g', multiple=True,
               help="Tags to set or empty string to remove all")
 @click.option('--hostname', '-H', help="Host portion of the FQDN")
 @click.option('--userdata', '-u', help="User defined metadata string")
-@click.option('--public-speed', default=None, 
-              type=click.Choice(['0', '10', '100', '1000', '10000', '-1']
-              help="Public port speed. -1 is best speed available"))
-@click.option('--private-speed', default=None,
-              type=click.Choice(['0', '10', '100', '1000', '10000', '-1']
-              help="Private port speed. -1 is best speed available"))
+@click.option('--public-speed', default=None,  type=click.Choice(['0', '10', '100', '1000', '10000', '-1']),
+              help="Public port speed. -1 is best speed available")
+@click.option('--private-speed', default=None, type=click.Choice(['0', '10', '100', '1000', '10000', '-1']),
+              help="Private port speed. -1 is best speed available")
 @environment.pass_env
 def cli(env, identifier, domain, userfile, tag, hostname, userdata, public_speed, private_speed):
     """Edit hardware details."""

docs/cli/hardware.rst

@@ -1,3 +1,11 @@
-.. click:: SoftLayer.CLI.hardware.list:cli
-   :prog: slcli hw list
-   :show-nested:
+.. _cli_hardware:
+
+Interacting with Hardware
+==============================
+
+
+.. toctree::
+    :maxdepth: 1
+    :glob:
+
+    hardware/*

docs/cli/hardware/cancel-reasons.rst

@@ -0,0 +1,3 @@
+.. click:: SoftLayer.CLI.hardware.cancel_reasons:cli
+   :prog: hw cancel-reasons
+   :show-nested:

docs/cli/hardware/cancel.rst

@@ -0,0 +1,3 @@
+.. click:: SoftLayer.CLI.hardware.cancel:cli
+   :prog: hw cancel
+   :show-nested:

docs/cli/hardware/create-options.rst

@@ -0,0 +1,3 @@
+.. click:: SoftLayer.CLI.hardware.create_options:cli
+   :prog: hw create-options
+   :show-nested:

docs/cli/hardware/create.rst

@@ -0,0 +1,6 @@
+.. click:: SoftLayer.CLI.hardware.create:cli
+   :prog: hw create
+   :show-nested:
+
+
+Provides some basic functionality to order a server. `slcli order` has a more full featured method of ordering servers. This command only supports the FAST_PROVISION type.

docs/cli/hardware/credentials.rst

@@ -0,0 +1,3 @@
+.. click:: SoftLayer.CLI.hardware.credentials:cli
+   :prog: hw credentials
+   :show-nested:

docs/cli/hardware/detail.rst

@@ -0,0 +1,3 @@
+.. click:: SoftLayer.CLI.hardware.detail:cli
+   :prog: hw detail
+   :show-nested:

docs/cli/hardware/edit.rst

@@ -0,0 +1,5 @@
+.. click:: SoftLayer.CLI.hardware.edit:cli
+   :prog: hw edit
+   :show-nested:
+
+When setting port speed, use "-1" to indicate best possible configuration. Using 10/100/1000/10000 on a server with a redundant interface may result the interface entering a degraded state. See `setPublicNetworkInterfaceSpeed <http://sldn.softlayer.com/reference/services/SoftLayer_Hardware_Server/setPublicNetworkInterfaceSpeed/>`_ for more information.

docs/cli/hardware/list.rst

@@ -0,0 +1,3 @@
+.. click:: SoftLayer.CLI.hardware.list:cli
+   :prog: hw list
+   :show-nested: