lsmcli::cmdline Namespace Reference

Data Structures
class	ArgError
	This class represents a command line argument error. More...
class	CmdLine
	Class that encapsulates the command line arguments for lsmcli Note: This class is used by lsmcli and any python plug-ins. More...
Functions
def	cmd_line_wrapper
	Wraps the invocation to the command line.
def	getch
	Get a character from stdin without needing a return key pressed.
def	parse_convert_init
Variables
list	list_choices
tuple	provision_types = ('DEFAULT', 'THIN', 'FULL')
string	provision_help = "provisioning type: "
tuple	replicate_types = ('CLONE', 'COPY', 'MIRROR_ASYNC', 'MIRROR_SYNC')
string	replicate_help = "replication type: "
string	size_help = 'Can use B, KiB, MiB, GiB, TiB, PiB postfix (IEC sizing)'
tuple	sys_id_opt = dict(name='--sys', metavar='<SYS_ID>', help='System ID')
tuple	sys_id_filter_opt = sys_id_opt.copy()
tuple	pool_id_opt = dict(name='--pool', metavar='<POOL_ID>', help='Pool ID')
tuple	pool_id_filter_opt = pool_id_opt.copy()
tuple	vol_id_opt = dict(name='--vol', metavar='<VOL_ID>', help='Volume ID')
tuple	vol_id_filter_opt = vol_id_opt.copy()
tuple	fs_id_opt = dict(name='--fs', metavar='<FS_ID>', help='File System ID')
tuple	ag_id_opt = dict(name='--ag', metavar='<AG_ID>', help='Access Group ID')
tuple	ag_id_filter_opt = ag_id_opt.copy()
tuple	init_id_opt = dict(name='--init', metavar='<INIT_ID>', help='Initiator ID')
tuple	snap_id_opt = dict(name='--snap', metavar='<SNAP_ID>', help='Snapshot ID')
tuple	export_id_opt = dict(name='--export', metavar='<EXPORT_ID>', help='Export ID')
tuple	nfs_export_id_filter_opt
tuple	disk_id_filter_opt
tuple	size_opt = dict(name='--size', metavar='<SIZE>', help=size_help)
tuple	tgt_id_opt
tuple	cmds
tuple	aliases

---

Function Documentation

def lsmcli::cmdline::cmd_line_wrapper

(

c = None

)

Wraps the invocation to the command line.

Parameters:

c

Object to invoke calls on (optional) Common command line code, called.

Definition at line 47 of file cmdline.py.

def lsmcli::cmdline::getch

(

)

Get a character from stdin without needing a return key pressed.

Returns the character pressed

Definition at line 87 of file cmdline.py.

def lsmcli::cmdline::parse_convert_init

(

init_id

)

If init_id is a WWPN, convert it into LSM standard version:
    (?:[0-9a-f]{2}:){7}[0-9a-f]{2}

Return (converted_init_id, lsm_init_type)

Definition at line 98 of file cmdline.py.

---

Variable Documentation

tuple ag_id_filter_opt = ag_id_opt.copy()

Definition at line 167 of file cmdline.py.

tuple ag_id_opt = dict(name='--ag', metavar='<AG_ID>', help='Access Group ID')

Definition at line 166 of file cmdline.py.

tuple aliases

Initial value:

(
    ['ls', 'list --type systems'],
    ['lp', 'list --type pools'],
    ['lv', 'list --type volumes'],
    ['ld', 'list --type disks'],
    ['la', 'list --type access_groups'],
    ['lf', 'list --type fs'],
    ['lt', 'list --type target_ports'],
    ['c', 'capabilities'],
    ['p', 'plugin-info'],
    ['vc', 'volume-create'],
    ['vrc', 'volume-raid-create'],
    ['vrcc', 'volume-raid-create-cap'],
    ['vd', 'volume-delete'],
    ['vr', 'volume-resize'],
    ['vm', 'volume-mask'],
    ['vu', 'volume-unmask'],
    ['ve', 'volume-enable'],
    ['vi', 'volume-disable'],
    ['ac', 'access-group-create'],
    ['aa', 'access-group-add'],
    ['ar', 'access-group-remove'],
    ['ad', 'access-group-delete'],
    ['vri', 'volume-raid-info'],
    ['pmi', 'pool-member-info'],
)

Definition at line 662 of file cmdline.py.

tuple cmds

Definition at line 186 of file cmdline.py.

tuple disk_id_filter_opt

Initial value:

dict(name='--disk', metavar='<DISK_ID>',
                          help='Search by Disk ID')

Definition at line 178 of file cmdline.py.

tuple export_id_opt = dict(name='--export', metavar='<EXPORT_ID>', help='Export ID')

Definition at line 172 of file cmdline.py.

tuple fs_id_opt = dict(name='--fs', metavar='<FS_ID>', help='File System ID')

Definition at line 164 of file cmdline.py.

tuple init_id_opt = dict(name='--init', metavar='<INIT_ID>', help='Initiator ID')

Definition at line 170 of file cmdline.py.

list list_choices

Initial value:

['VOLUMES', 'POOLS', 'FS', 'SNAPSHOTS',
                'EXPORTS', "NFS_CLIENT_AUTH", 'ACCESS_GROUPS',
                'SYSTEMS', 'DISKS', 'PLUGINS', 'TARGET_PORTS']

Definition at line 140 of file cmdline.py.

tuple nfs_export_id_filter_opt

Initial value:

dict(
    name='--nfs-export', metavar='<NFS_EXPORT_ID>',
    help='Search by NFS Export ID')

Definition at line 174 of file cmdline.py.

tuple pool_id_filter_opt = pool_id_opt.copy()

Definition at line 157 of file cmdline.py.

tuple pool_id_opt = dict(name='--pool', metavar='<POOL_ID>', help='Pool ID')

Definition at line 156 of file cmdline.py.

string provision_help = "provisioning type: "

Definition at line 145 of file cmdline.py.

tuple provision_types = ('DEFAULT', 'THIN', 'FULL')

Definition at line 144 of file cmdline.py.

string replicate_help = "replication type: "

Definition at line 148 of file cmdline.py.

tuple replicate_types = ('CLONE', 'COPY', 'MIRROR_ASYNC', 'MIRROR_SYNC')

Definition at line 147 of file cmdline.py.

string size_help = 'Can use B, KiB, MiB, GiB, TiB, PiB postfix (IEC sizing)'

Definition at line 150 of file cmdline.py.

tuple size_opt = dict(name='--size', metavar='<SIZE>', help=size_help)

Definition at line 181 of file cmdline.py.

tuple snap_id_opt = dict(name='--snap', metavar='<SNAP_ID>', help='Snapshot ID')

Definition at line 171 of file cmdline.py.

tuple sys_id_filter_opt = sys_id_opt.copy()

Definition at line 153 of file cmdline.py.

tuple sys_id_opt = dict(name='--sys', metavar='<SYS_ID>', help='System ID')

Definition at line 152 of file cmdline.py.

tuple tgt_id_opt

Initial value:

dict(name="--tgt", help="Search by target port ID",
                  metavar='<TGT_ID>')

Definition at line 183 of file cmdline.py.

tuple vol_id_filter_opt = vol_id_opt.copy()

Definition at line 161 of file cmdline.py.

tuple vol_id_opt = dict(name='--vol', metavar='<VOL_ID>', help='Volume ID')

Definition at line 160 of file cmdline.py.