SmisCommon Class Reference

Collaboration diagram for SmisCommon:

Public Member Functions
def	__init__
def	profile_check
def	EnumerateInstances
def	EnumerateInstanceNames
def	Associators
def	AssociatorNames
def	GetInstance
def	DeleteInstance
def	References
def	is_megaraid
def	is_netappe
def	cim_job_pros
def	cim_job_of_job_id
def	parse_job_id
def	invoke_method
def	invoke_method_wait
def	cim_scs_of_sys_id
def	cim_rs_of_sys_id
def	cim_gmms_of_sys_id
def	cim_ccs_of_sys_id
def	cim_hwms_of_sys_id
def	cim_job_completed_ok
Data Fields
	root_blk_cim_rp
	system_list
Static Public Attributes
int	SNIA_INVOKE_OK = 0
int	SNIA_INVOKE_NOT_SUPPORTED = 1
int	SNIA_INVOKE_FAILED = 4
int	SNIA_INVOKE_ASYNC = 4096
string	SNIA_BLK_ROOT_PROFILE = 'Array'
string	SNIA_BLK_SRVS_PROFILE = 'Block Services'
string	SNIA_DISK_LITE_PROFILE = 'Disk Drive Lite'
string	SNIA_MULTI_SYS_PROFILE = 'Multiple Computer System'
string	SNIA_MASK_PROFILE = 'Masking and Mapping'
string	SNIA_GROUP_MASK_PROFILE = 'Group Masking and Mapping'
string	SNIA_FC_TGT_PORT_PROFILE = 'FC Target Ports'
string	SNIA_ISCSI_TGT_PORT_PROFILE = 'iSCSI Target Ports'
string	SNIA_SPARE_DISK_PROFILE = 'Disk Sparing'
string	SMIS_SPEC_VER_1_1 = '1.1'
string	SMIS_SPEC_VER_1_4 = '1.4'
string	SMIS_SPEC_VER_1_5 = '1.5'
string	SMIS_SPEC_VER_1_6 = '1.6'
tuple	SNIA_REG_ORG_CODE = Uint16(11)
int	JOB_RETRIEVE_NONE = 0
int	JOB_RETRIEVE_VOLUME = 1
int	JOB_RETRIEVE_VOLUME_CREATE = 2
int	IAAN_WBEM_HTTP_PORT = 5988
int	IAAN_WBEM_HTTPS_PORT = 5989

Detailed Description

Definition at line 150 of file smis_common.py.

Member Function Documentation

def __init__	(	self,
		url,
		username,
		password,
		namespace = `dmtf.DEFAULT_NAMESPACE`,
		no_ssl_verify = `False`,
		debug_path = `None`,
		system_list = `None`
	)

Definition at line 190 of file smis_common.py.

def AssociatorNames	(	self,
		ObjectName,
		params
	)

Definition at line 308 of file smis_common.py.

def Associators	(	self,
		ObjectName,
		params
	)

Definition at line 305 of file smis_common.py.

def cim_ccs_of_sys_id	(	self,
		sys_id,
		raise_error = `True`
	)

Return a CIMInstance of CIM_ControllerConfigurationService for given
system id.
Using 'SystemName' property as system id of a service which is defined
by DMTF CIM_Service.

Definition at line 623 of file smis_common.py.

def cim_gmms_of_sys_id	(	self,
		sys_id,
		raise_error = `True`
	)

Return a CIMInstance of CIM_GroupMaskingMappingService for given system
id.
Using 'SystemName' property as system id of a service which is defined
by DMTF CIM_Service.

Definition at line 613 of file smis_common.py.

def cim_hwms_of_sys_id	(	self,
		sys_id,
		raise_error = `True`
	)

Return a CIMInstance of CIM_StorageHardwareIDManagementService for
given system id.
Using 'SystemName' property as system id of a service which is defined
by DMTF CIM_Service.

Definition at line 633 of file smis_common.py.

def cim_job_completed_ok ( status )

Given a concrete job instance, check the operational status.  This
is a little convoluted as different SMI-S proxies return the values in
different positions in list :-)

Definition at line 644 of file smis_common.py.

def cim_job_of_job_id	(	self,
		job_id,
		property_list = `None`
	)

Return CIM_ConcreteJob for given job_id.

Definition at line 331 of file smis_common.py.

def cim_job_pros ( )

Definition at line 328 of file smis_common.py.

def cim_rs_of_sys_id	(	self,
		sys_id,
		raise_error = `True`
	)

Return a CIMInstance of CIM_ReplicationService for given system id.
Using 'SystemName' property as system id of a service which is defined
by DMTF CIM_Service.

Definition at line 604 of file smis_common.py.

def cim_scs_of_sys_id	(	self,
		sys_id,
		raise_error = `True`
	)

Return a CIMInstance of CIM_StorageConfigurationService for given
system id.
Using 'SystemName' property as system id of a service which is defined
by DMTF CIM_Service.

Definition at line 594 of file smis_common.py.

def DeleteInstance	(	self,
		InstanceName,
		params
	)

Definition at line 315 of file smis_common.py.

def EnumerateInstanceNames	(	self,
		ClassName,
		namespace = `None`,
		params
	)

Definition at line 297 of file smis_common.py.

def EnumerateInstances	(	self,
		ClassName,
		namespace = `None`,
		params
	)

Definition at line 289 of file smis_common.py.

def GetInstance	(	self,
		InstanceName,
		params
	)

Definition at line 311 of file smis_common.py.

def invoke_method	(	self,
		cmd,
		cim_path,
		in_params,
		out_handler = `None`,
		error_handler = `None`,
		retrieve_data = `None`,
		method_data = `None`
	)

cmd
    A string of command, example:
'CreateOrModifyElementFromStoragePool'
cim_path
    the CIMInstanceName, example:
CIM_StorageConfigurationService.path
in_params
    A dictionary of input parameter, example:
{'ElementName': volume_name,
 'ElementType': dmtf_element_type,
 'InPool': cim_pool_path,
 'Size': pywbem.Uint64(size_bytes)}
out_handler
    A reference to a method to parse output, example:
self._new_vol_from_name
error_handler
    A reference to a method to handle all exceptions.
retrieve_data
    SmisCommon.JOB_RETRIEVE_XXX, it will be used only
    when a ASYNC job has been created.
method_data
    A string which will be stored in job_id, it could be used by
    job_status() to do error checking.

Definition at line 408 of file smis_common.py.

def invoke_method_wait	(	self,
		cmd,
		cim_path,
		in_params,
		out_key = `None`,
		expect_class = `None`,
		flag_out_array = `False`
	)

InvokeMethod and wait it until done.
Return a CIMInstanceName from out[out_key] or from cim_job:
    CIM_ConcreteJob
|
| CIM_AffectedJobElement
v
    CIMInstanceName # expect_class
If flag_out_array is True, return the first element of out[out_key].

Definition at line 473 of file smis_common.py.

def is_megaraid ( self )

Definition at line 321 of file smis_common.py.

def is_netappe ( self )

Definition at line 324 of file smis_common.py.

def parse_job_id ( job_id )

job_id is assembled by a md5 string, retrieve_data and method_data
This method will split it and return
(md5_str, retrieve_data, method_data)

Definition at line 367 of file smis_common.py.

def profile_check	(	self,
		profile_name,
		spec_ver,
		raise_error = `False`
	)

Usage:
    Check whether we support certain profile at certain SNIA
    specification version or later version.
    Will raise LsmError(ErrorNumber.NO_SUPPORT, 'xxx') if raise_error
    is True when nothing found.
Parameter:
    profile_name    # SmisCommon.SNIA_XXXX_PROFILE
    spec_ver        # SmisCommon.SMIS_SPEC_VER_XXX
    raise_error     # Raise LsmError if not found
Returns:
    True
or
    False

Definition at line 252 of file smis_common.py.

def References	(	self,
		ObjectName,
		params
	)

Definition at line 318 of file smis_common.py.

Field Documentation

int IAAN_WBEM_HTTP_PORT = 5988 [static]

Definition at line 184 of file smis_common.py.

int IAAN_WBEM_HTTPS_PORT = 5989 [static]

Definition at line 185 of file smis_common.py.

int JOB_RETRIEVE_NONE = 0 [static]

Definition at line 180 of file smis_common.py.

int JOB_RETRIEVE_VOLUME = 1 [static]

Definition at line 181 of file smis_common.py.

int JOB_RETRIEVE_VOLUME_CREATE = 2 [static]

Definition at line 182 of file smis_common.py.

root_blk_cim_rp

Definition at line 193 of file smis_common.py.

string SMIS_SPEC_VER_1_1 = '1.1' [static]

Definition at line 170 of file smis_common.py.

string SMIS_SPEC_VER_1_4 = '1.4' [static]

Definition at line 171 of file smis_common.py.

string SMIS_SPEC_VER_1_5 = '1.5' [static]

Definition at line 172 of file smis_common.py.

string SMIS_SPEC_VER_1_6 = '1.6' [static]

Definition at line 173 of file smis_common.py.

string SNIA_BLK_ROOT_PROFILE = 'Array' [static]

Definition at line 161 of file smis_common.py.

string SNIA_BLK_SRVS_PROFILE = 'Block Services' [static]

Definition at line 162 of file smis_common.py.

string SNIA_DISK_LITE_PROFILE = 'Disk Drive Lite' [static]

Definition at line 163 of file smis_common.py.

string SNIA_FC_TGT_PORT_PROFILE = 'FC Target Ports' [static]

Definition at line 167 of file smis_common.py.

string SNIA_GROUP_MASK_PROFILE = 'Group Masking and Mapping' [static]

Definition at line 166 of file smis_common.py.

int SNIA_INVOKE_ASYNC = 4096 [static]

Definition at line 159 of file smis_common.py.

int SNIA_INVOKE_FAILED = 4 [static]

Definition at line 158 of file smis_common.py.

int SNIA_INVOKE_NOT_SUPPORTED = 1 [static]

Definition at line 157 of file smis_common.py.

int SNIA_INVOKE_OK = 0 [static]

Definition at line 156 of file smis_common.py.

string SNIA_ISCSI_TGT_PORT_PROFILE = 'iSCSI Target Ports' [static]

Definition at line 168 of file smis_common.py.

string SNIA_MASK_PROFILE = 'Masking and Mapping' [static]

Definition at line 165 of file smis_common.py.

string SNIA_MULTI_SYS_PROFILE = 'Multiple Computer System' [static]

Definition at line 164 of file smis_common.py.

tuple SNIA_REG_ORG_CODE = Uint16(11) [static]

Definition at line 174 of file smis_common.py.

string SNIA_SPARE_DISK_PROFILE = 'Disk Sparing' [static]

Definition at line 169 of file smis_common.py.

system_list

Definition at line 195 of file smis_common.py.

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

smis_common.py

SmisCommon Class Reference

Public Member Functions

Data Fields

Static Public Attributes

Detailed Description

Member Function Documentation

Field Documentation