CmdLine Class Reference

Class that encapsulates the command line arguments for lsmcli Note: This class is used by lsmcli and any python plug-ins. More...

Public Member Functions

def confirm_prompt
 Warn of imminent data loss.
def display_data
 Tries to make the output better when it varies considerably from plug-in to plug-in.
def display_available_plugins
def handle_alias
def cli
 All the command line arguments and options are created in this method.
def display_nfs_client_authentication
 Display the types of nfs client authentication that are supported.
def list
 Method that calls the appropriate method based on what the list type is.
def access_group_create
 Creates an access group.
def access_group_add
 Adds an initiator from an access group.
def access_group_remove
 Removes an initiator from an access group.
def access_group_volumes
def iscsi_chap
def volume_access_group
def access_group_delete
 Used to delete access group.
def fs_delete
 Used to delete a file system.
def fs_create
 Used to create a file system.
def fs_resize
 Used to resize a file system.
def fs_clone
 Used to clone a file system.
def file_clone
 Used to clone a file(s).
def capabilities
def plugin_info
def volume_create
 Creates a volume.
def fs_snap_create
 Creates a snapshot.
def fs_snap_restore
 Restores a snap shot.
def volume_delete
 Deletes a volume.
def fs_snap_delete
 Deletes a snap shot.
def job_status
 Retrieves the status of the specified job.
def volume_replicate
 Replicates a volume.
def volume_replicate_range
 Replicates a range of a volume.
def volume_replicate_range_block_size
 Returns the block size in bytes for each block represented in volume_replicate_range.
def volume_mask
def volume_unmask
def volume_resize
 Re-sizes a volume.
def volume_enable
 Enable a volume.
def volume_disable
 Disable a volume.
def fs_unexport
 Removes a nfs export.
def fs_export
 Exports a file system as a NFS export.
def volume_dependants
 Displays volume dependants.
def volume_dependants_rm
 Removes volume dependants.
def volume_raid_info
def pool_member_info
def volume_raid_create
def volume_raid_create_cap
def fs_dependants
 Displays file system dependants.
def fs_dependants_rm
 Removes file system dependants.
def __init__
 Class constructor.
def shutdown
 Does appropriate clean-up.
def process
 Process the specified command.

Data Fields

 parser
 unknown_args
 uri
 c
 args
 cleanup
 tmo
 password

Detailed Description

Class that encapsulates the command line arguments for lsmcli Note: This class is used by lsmcli and any python plug-ins.

Command line interface class.

Definition at line 692 of file cmdline.py.


Member Function Documentation

def __init__ (   self  ) 

Class constructor.

Definition at line 1464 of file cmdline.py.

def access_group_add (   self,
  args 
)

Adds an initiator from an access group.

Definition at line 1015 of file cmdline.py.

def access_group_create (   self,
  args 
)

Creates an access group.

Definition at line 996 of file cmdline.py.

def access_group_delete (   self,
  args 
)

Used to delete access group.

Definition at line 1044 of file cmdline.py.

def access_group_remove (   self,
  args 
)

Removes an initiator from an access group.

Definition at line 1019 of file cmdline.py.

def access_group_volumes (   self,
  args 
)

Definition at line 1022 of file cmdline.py.

def capabilities (   self,
  args 
)

Definition at line 1125 of file cmdline.py.

def cli (   self  ) 

All the command line arguments and options are created in this method.

Command line interface parameters

Definition at line 766 of file cmdline.py.

def confirm_prompt (   self,
  deleting 
)

Warn of imminent data loss.

Parameters:
deleting Indicate data will be lost vs. may be lost (re-size)
Returns:
True if operation confirmed, else False
Give the user a chance to bail.

Definition at line 702 of file cmdline.py.

def display_available_plugins (   self  ) 

Definition at line 748 of file cmdline.py.

def display_data (   self,
  objects 
)

Tries to make the output better when it varies considerably from plug-in to plug-in.

Parameters:
objects Data, first row is header all other data.

Definition at line 725 of file cmdline.py.

def display_nfs_client_authentication (   self  ) 

Display the types of nfs client authentication that are supported.

Returns:
None
Dump the supported nfs client authentication types

Definition at line 867 of file cmdline.py.

def file_clone (   self,
  args 
)

Used to clone a file(s).

Definition at line 1089 of file cmdline.py.

def fs_clone (   self,
  args 
)

Used to clone a file system.

Definition at line 1074 of file cmdline.py.

def fs_create (   self,
  args 
)

Used to create a file system.

Definition at line 1056 of file cmdline.py.

def fs_delete (   self,
  args 
)

Used to delete a file system.

Definition at line 1050 of file cmdline.py.

def fs_dependants (   self,
  args 
)

Displays file system dependants.

Definition at line 1425 of file cmdline.py.

def fs_dependants_rm (   self,
  args 
)

Removes file system dependants.

Definition at line 1431 of file cmdline.py.

def fs_export (   self,
  args 
)

Exports a file system as a NFS export.

Definition at line 1345 of file cmdline.py.

def fs_resize (   self,
  args 
)

Used to resize a file system.

Definition at line 1064 of file cmdline.py.

def fs_snap_create (   self,
  args 
)

Creates a snapshot.

Definition at line 1169 of file cmdline.py.

def fs_snap_delete (   self,
  args 
)

Deletes a snap shot.

Definition at line 1209 of file cmdline.py.

def fs_snap_restore (   self,
  args 
)

Restores a snap shot.

Definition at line 1180 of file cmdline.py.

def fs_unexport (   self,
  args 
)

Removes a nfs export.

Definition at line 1340 of file cmdline.py.

def handle_alias (   self,
  args 
)

Definition at line 759 of file cmdline.py.

def iscsi_chap (   self,
  args 
)

Definition at line 1028 of file cmdline.py.

def job_status (   self,
  args 
)

Retrieves the status of the specified job.

Definition at line 1247 of file cmdline.py.

def list (   self,
  args 
)

Method that calls the appropriate method based on what the list type is.

Parameters:
args Argparse argument object

Definition at line 878 of file cmdline.py.

def plugin_info (   self,
  args 
)

Definition at line 1147 of file cmdline.py.

def pool_member_info (   self,
  args 
)

Definition at line 1384 of file cmdline.py.

def process (   self,
  cli = None 
)

Process the specified command.

Parameters:
cli The object instance to invoke methods on.

Process the parsed command.

Definition at line 1517 of file cmdline.py.

def shutdown (   self,
  ec = None 
)

Does appropriate clean-up.

Parameters:
ec The exit code

Definition at line 1508 of file cmdline.py.

def volume_access_group (   self,
  args 
)

Definition at line 1038 of file cmdline.py.

def volume_create (   self,
  args 
)

Creates a volume.

Definition at line 1156 of file cmdline.py.

def volume_delete (   self,
  args 
)

Deletes a volume.

Definition at line 1202 of file cmdline.py.

def volume_dependants (   self,
  args 
)

Displays volume dependants.

Definition at line 1366 of file cmdline.py.

def volume_dependants_rm (   self,
  args 
)

Removes volume dependants.

Definition at line 1372 of file cmdline.py.

def volume_disable (   self,
  args 
)

Disable a volume.

Definition at line 1335 of file cmdline.py.

def volume_enable (   self,
  args 
)

Enable a volume.

Definition at line 1330 of file cmdline.py.

def volume_mask (   self,
  args 
)

Definition at line 1309 of file cmdline.py.

def volume_raid_create (   self,
  args 
)

Definition at line 1391 of file cmdline.py.

def volume_raid_create_cap (   self,
  args 
)

Definition at line 1419 of file cmdline.py.

def volume_raid_info (   self,
  args 
)

Definition at line 1377 of file cmdline.py.

def volume_replicate (   self,
  args 
)

Replicates a volume.

Definition at line 1260 of file cmdline.py.

def volume_replicate_range (   self,
  args 
)

Replicates a range of a volume.

Definition at line 1277 of file cmdline.py.

def volume_replicate_range_block_size (   self,
  args 
)

Returns the block size in bytes for each block represented in volume_replicate_range.

Definition at line 1305 of file cmdline.py.

def volume_resize (   self,
  args 
)

Re-sizes a volume.

Definition at line 1320 of file cmdline.py.

def volume_unmask (   self,
  args 
)

Definition at line 1314 of file cmdline.py.


Field Documentation

Definition at line 1469 of file cmdline.py.

c

Definition at line 1466 of file cmdline.py.

Definition at line 1471 of file cmdline.py.

Definition at line 861 of file cmdline.py.

Definition at line 1480 of file cmdline.py.

tmo

Definition at line 1473 of file cmdline.py.

Definition at line 862 of file cmdline.py.

uri

Definition at line 1465 of file cmdline.py.


The documentation for this class was generated from the following file:

Generated on 9 Jul 2015 for libStorageMgmt by  doxygen 1.6.1