Merge pull request #2068 from softlayer/jayasilan-issue2025

Example for slcli file disaster-recovery-failover, slcli file replica-failback, slcli file replica-failover, slcli file replica-locations #2025

Author: allmightyspiff

SoftLayer/CLI/file/replication/disaster_recovery_failover.py

@@ -19,7 +19,12 @@
 @click.option('--replicant-id', help="ID of the replicant volume")
 @environment.pass_env
 def cli(env, volume_id, replicant_id):
-    """Failover an inaccessible file volume to its available replicant volume."""
+    """Failover an inaccessible file volume to its available replicant volume.
+
+    Example::
+        slcli file disaster-recovery-failover 12345678 87654321
+        This command performs failover operation for volume with ID 12345678 to replica volume with ID 87654321.
+"""
     file_storage_manager = SoftLayer.FileStorageManager(env.client)
 
     click.secho("""WARNING : Failover an inaccessible file volume to its available replicant volume."""

SoftLayer/CLI/file/replication/failback.py

@@ -11,7 +11,12 @@
 @click.argument('volume-id')
 @environment.pass_env
 def cli(env, volume_id):
-    """Failback a file volume from the given replicant volume."""
+    """Failback a file volume from the given replicant volume.
+
+    Example::
+        slcli file replica-failback 12345678
+        This command performs failback operation for volume with ID 12345678.
+"""
     file_storage_manager = SoftLayer.FileStorageManager(env.client)
 
     success = file_storage_manager.failback_from_replicant(volume_id)

SoftLayer/CLI/file/replication/failover.py

@@ -11,7 +11,12 @@
 @click.option('--replicant-id', help="ID of the replicant volume")
 @environment.pass_env
 def cli(env, volume_id, replicant_id):
-    """Failover a file volume to the given replicant volume."""
+    """Failover a file volume to the given replicant volume.
+
+    Example::
+        slcli file replica-failover 12345678 87654321
+        This command performs failover operation for volume with ID 12345678 to replica volume with ID 87654321.
+"""
     file_storage_manager = SoftLayer.FileStorageManager(env.client)
 
     success = file_storage_manager.failover_to_replicant(

SoftLayer/CLI/file/replication/locations.py

@@ -29,7 +29,12 @@
               default=','.join(DEFAULT_COLUMNS))
 @environment.pass_env
 def cli(env, columns, sortby, volume_id):
-    """List suitable replication datacenters for the given volume."""
+    """List suitable replication datacenters for the given volume.
+
+    Example::
+        slcl file replica-locations 12345678
+        This command lists suitable replication data centers for block volume with ID 12345678.
+    """
     file_storage_manager = SoftLayer.FileStorageManager(env.client)
 
     legal_centers = file_storage_manager.get_replication_locations(