Merge pull request #2065 from softlayer/jayasilan-issue2022

Example for slcli dns zone-create, slcli dns record-list, slcli dns record-remove command #2022

Author: allmightyspiff

SoftLayer/CLI/dns/record_list.py

@@ -19,7 +19,13 @@
 @click.option('--type', 'record_type', help='Record type, such as A or CNAME')
 @environment.pass_env
 def cli(env, zone, data, record, ttl, record_type):
-    """List all records in a zone."""
+    """List all records in a zone.
+
+    Example::
+        slcli dns record-list ibm.com --record elasticsearch --type A --ttl 900
+        This command lists all A records under the zone: ibm.com, and \
+filters by host is elasticsearch and ttl is 900 seconds.
+"""
 
     manager = SoftLayer.DNSManager(env.client)
     table = formatting.Table(['id', 'record', 'type', 'ttl', 'data'])

SoftLayer/CLI/dns/record_remove.py

@@ -13,7 +13,12 @@
 @click.argument('record_id')
 @environment.pass_env
 def cli(env, record_id):
-    """Remove resource record."""
+    """Remove resource record.
+
+    Example::
+        slcli dns record-remove 12345678
+        This command removes resource record with ID 12345678.
+"""
 
     manager = SoftLayer.DNSManager(env.client)
 

SoftLayer/CLI/dns/zone_create.py

@@ -11,7 +11,12 @@
 @click.argument('zone')
 @environment.pass_env
 def cli(env, zone):
-    """Create a zone."""
+    """Create a zone.
+
+    Example::
+        slcli dns zone-create ibm.com
+        This command creates a zone that is named ibm.com.
+"""
 
     manager = SoftLayer.DNSManager(env.client)
     manager.create_zone(zone)