Merge pull request #2074 from ramkishor-ch/issue_2027

added Example for slcli file snapshot-create, slcli file snapshot-disable, slcli file snapshot-enable

Author: allmightyspiff

SoftLayer/CLI/file/snapshot/create.py

@@ -12,7 +12,13 @@
               help='Notes to set on the new snapshot')
 @environment.pass_env
 def cli(env, volume_id, notes):
-    """Creates a snapshot on a given volume"""
+    """Creates a snapshot on a given volume
+
+    Example::
+
+        slcli file snapshot-create 12345678 --note snapshotforsoftlayer
+        This command creates a snapshot for volume with ID 12345678 and with addition note as snapshotforsoftlayer.
+    """
     file_storage_manager = SoftLayer.FileStorageManager(env.client)
     snapshot = file_storage_manager.create_snapshot(volume_id, notes=notes)
 

SoftLayer/CLI/file/snapshot/disable.py

@@ -14,7 +14,13 @@
               required=True)
 @environment.pass_env
 def cli(env, volume_id, schedule_type):
-    """Disables snapshots on the specified schedule for a given volume"""
+    """Disables snapshots on the specified schedule for a given volume
+
+    Example::
+
+        slcli file snapshot-disable 12345678 -s DAILY
+        This command disables daily snapshot for volume with ID 12345678.
+    """
 
     if (schedule_type not in ['INTERVAL', 'HOURLY', 'DAILY', 'WEEKLY']):
         raise exceptions.CLIAbort(

SoftLayer/CLI/file/snapshot/enable.py

@@ -27,7 +27,14 @@
 @environment.pass_env
 def cli(env, volume_id, schedule_type, retention_count,
         minute, hour, day_of_week):
-    """Enables snapshots for a given volume on the specified schedule"""
+    """Enables snapshots for a given volume on the specified schedule
+
+    Example::
+
+        slcli file snapshot-enable 12345678 -s WEEKLY -c 5 -m 0 --hour 2 -d 0
+        This command enables snapshot for volume with ID 12345678, snapshot is
+        taken weekly on every Sunday at 2:00, and up to 5 snapshots are retained.
+    """
     file_manager = SoftLayer.FileStorageManager(env.client)
 
     valid_schedule_types = {'INTERVAL', 'HOURLY', 'DAILY', 'WEEKLY'}