LMIInstanceName Package

class lmi.shell.LMIInstanceName.LMIInstanceName(conn, cim_instance_name)

LMI wrapper class representing CIMInstanceName.

Parameters:

• conn (LMIConnection) – connection object
• cim_instance_name (CIMInstanceName) – wrapped object

associator_names(**kwargs)

Returns a list of associated LMIInstanceName with this object.

Parameters:

• AssocClass (string) – valid CIM association class name. It acts as a filter on the returned set of names by mandating that each returned name identify an object that shall be associated to the source object through an instance of this class or one of its subclasses. Default value is None.
• ResultClass (string) – valid CIM class name. It acts as a filter on the returned set of names by mandating that each returned name identify an object that shall be either an instance of this class (or one of its subclasses) or be this class (or one of its subclasses). Default value is None.
• Role (string) – valid property name. It acts as a filter on the returned set of names by mandating that each returned name identify an object that shall be associated to the source object through an association in which the source object plays the specified role. That is, the name of the property in the association class that refers to the source object shall match the value of this parameter. Default value is None.
• ResultRole (string) – valid property name. It acts as a filter on the returned set of names by mandating that each returned name identify an object that shall be associated to the source object through an association in which the named returned object plays the specified role. That is, the name of the property in the association class that refers to the returned object shall match the value of this parameter. Default value is None.

Returns:

list of associated LMIInstanceName objects

Usage: Associated Instance Names.

associators(**kwargs)

Returns a list of associated LMIInstance objects with this instance.

Parameters:

• AssocClass (string) – valid CIM association class name. It acts as a filter on the returned set of objects by mandating that each returned object shall be associated to the source object through an instance of this class or one of its subclasses. Default value is None.
• ResultClass (string) – valid CIM class name. It acts as a filter on the returned set of objects by mandating that each returned object shall be either an instance of this class (or one of its subclasses) or be this class (or one of its subclasses). Default value is None.
• Role (string) – valid property name. It acts as a filter on the returned set of objects by mandating that each returned object shall be associated with the source object through an association in which the source object plays the specified role. That is, the name of the property in the association class that refers to the source object shall match the value of this parameter. Default value is None.
• ResultRole (string) – valid property name. It acts as a filter on the returned set of objects by mandating that each returned object shall be associated to the source object through an association in which the returned object plays the specified role. That is, the name of the property in the association class that refers to the returned object shall match the value of this parameter. Default value is None.
• IncludeQualifiers (bool) – bool flag indicating, if all qualifiers for each object (including qualifiers on the object and on any returned properties) shall be included as <QUALIFIER> elements in the response. Default value is False.
• IncludeClassOrigin (bool) – bool flag indicating, if the CLASSORIGIN attribute shall be present on all appropriate elements in each returned object. Default value is False.
• PropertyList (list) – if not None, the members of the array define one or more property names. Each returned object shall not include elements for any properties missing from this list. If PropertyList is an empty list, no properties are included in each returned object. If it is None, no additional filtering is defined. Default value is None.

Returns:

list of associated LMIInstance objects

Usage: Associated Instances.

classname

Returns:class name Return type:string

copy()

Returns:copy of itself

first_associator(**kwargs)

Returns the first associated LMIInstance with this object.

Parameters:

• AssocClass (string) – valid CIM association class name. It acts as a filter on the returned set of objects by mandating that each returned object shall be associated to the source object through an instance of this class or one of its subclasses. Default value is None.
• ResultClass (string) – valid CIM class name. It acts as a filter on the returned set of objects by mandating that each returned object shall be either an instance of this class (or one of its subclasses) or be this class (or one of its subclasses). Default value is None.
• Role (string) – valid property name. It acts as a filter on the returned set of objects by mandating that each returned object shall be associated with the source object through an association in which the source object plays the specified role. That is, the name of the property in the association class that refers to the source object shall match the value of this parameter. Default value is None.
• ResultRole (string) – valid property name. It acts as a filter on the returned set of objects by mandating that each returned object shall be associated to the source object through an association in which the returned object plays the specified role. That is, the name of the property in the association class that refers to the returned object shall match the value of this parameter. Default value is None.
• IncludeQualifiers (bool) – bool flag indicating, if all qualifiers for each object (including qualifiers on the object and on any returned properties) shall be included as <QUALIFIER> elements in the response. Default value is False.
• IncludeClassOrigin (bool) – bool flag indicating, if the CLASSORIGIN attribute shall be present on all appropriate elements in each returned object. Default value is False.
• PropertyList (list) – if not None, the members of the array define one or more property names. Each returned object shall not include elements for any properties missing from this list. If PropertyList is an empty list, no properties are included in each returned object. If it is None, no additional filtering is defined. Default value is None.

Returns:

first associated LMIInstance

Usage: Associated Instances.

first_associator_name(**kwargs)

Returns the first associated LMIInstanceName with this object.

Parameters:

• AssocClass (string) – valid CIM association class name. It acts as a filter on the returned set of names by mandating that each returned name identify an object that shall be associated to the source object through an instance of this class or one of its subclasses. Default value is None.
• ResultClass (string) – valid CIM class name. It acts as a filter on the returned set of names by mandating that each returned name identify an object that shall be either an instance of this class (or one of its subclasses) or be this class (or one of its subclasses). Default value is None.
• Role (string) – valid property name. It acts as a filter on the returned set of names by mandating that each returned name identify an object that shall be associated to the source object through an association in which the source object plays the specified role. That is, the name of the property in the association class that refers to the source object shall match the value of this parameter. Default value is None.
• ResultRole (string) – valid property name. It acts as a filter on the returned set of names by mandating that each returned name identify an object that shall be associated to the source object through an association in which the named returned object plays the specified role. That is, the name of the property in the association class that refers to the returned object shall match the value of this parameter. Default value is None.

Returns:

first associated LMIInstanceName object

Usage: Associated Instance Names.

first_reference(**kwargs)

Returns the first association LMIInstance with this object.

Parameters:

• ResultClass (string) – valid CIM class name. It acts as a filter on the returned set of objects by mandating that each returned object shall be an instance of this class (or one of its subclasses) or this class (or one of its subclasses). Default value is None.
• Role (string) – valid property name. It acts as a filter on the returned set of objects by mandating that each returned object shall refer to the target object through a property with a name that matches the value of this parameter. Default value is None.
• IncludeQualifiers (bool) – flag indicating, if all qualifiers for each object (including qualifiers on the object and on any returned properties) shall be included as <QUALIFIER> elements in the response. Default value is False.
• IncludeClassOrigin (bool) – flag indicating, if the CLASSORIGIN attribute shall be present on all appropriate elements in each returned object. Default value is False.
• PropertyList (list) – if not None, the members of the list define one or more property names. Each returned object shall not include elements for any properties missing from this list. If PropertyList is an empty list, no properties are included in each returned object. If PropertyList is None, no additional filtering is defined. Default value is None.

Returns:

first association LMIInstance object

Usage: Association Instances.

first_reference_name(**kwargs)

Returns the first association LMIInstanceName with this object.

Parameters:

• ResultClass (string) – valid CIM class name. It acts as a filter on the returned set of object names by mandating that each returned Object Name identify an instance of this class (or one of its subclasses) or this class (or one of its subclasses). Default value is None.
• Role (string) – valid property name. It acts as a filter on the returned set of object names by mandating that each returned object name shall identify an object that refers to the target instance through a property with a name that matches the value of this parameter. Default value is None.

Returns:

first association LMIInstanceName object

Usage: Association Instance Names.

hostname

Returns:host name Return type:string

key_properties()

Returns:list of strings of key properties

Usage: Key properties.

key_properties_dict()

Returns:dictionary with key properties and corresponding values

key_property_value(prop_name)

Parameters:prop_name (string) – key property name Returns:key property value

namespace

Returns:namespace name Return type:string

print_key_properties()

Prints out the list of key properties.

Usage: Key properties.

reference_names(**kwargs)

Returns a list of association LMIInstanceName objects with this object.

Parameters:

• ResultClass (string) – valid CIM class name. It acts as a filter on the returned set of object names by mandating that each returned Object Name identify an instance of this class (or one of its subclasses) or this class (or one of its subclasses). Default value is None.
• Role (string) – valid property name. It acts as a filter on the returned set of object names by mandating that each returned object name shall identify an object that refers to the target instance through a property with a name that matches the value of this parameter. Default value is None.

Returns:

list of association LMIInstanceName objects

Usage: Association Instance Names.

references(**kwargs)

Returns a list of association LMIInstance objects with this object.

Parameters:

• ResultClass (string) – valid CIM class name. It acts as a filter on the returned set of objects by mandating that each returned object shall be an instance of this class (or one of its subclasses) or this class (or one of its subclasses). Default value is None.
• Role (string) – valid property name. It acts as a filter on the returned set of objects by mandating that each returned object shall refer to the target object through a property with a name that matches the value of this parameter. Default value is None.
• IncludeQualifiers (bool) – flag indicating, if all qualifiers for each object (including qualifiers on the object and on any returned properties) shall be included as <QUALIFIER> elements in the response. Default value is False.
• IncludeClassOrigin (bool) – flag indicating, if the CLASSORIGIN attribute shall be present on all appropriate elements in each returned object. Default value is False.
• PropertyList (list) – if not None, the members of the list define one or more property names. Each returned object shall not include elements for any properties missing from this list. If PropertyList is an empty list, no properties are included in each returned object. If PropertyList is None, no additional filtering is defined. Default value is None.

Returns:

list of association LMIInstance objects

Usage: Association Instances.

to_instance()

Creates a new LMIInstance object from LMIInstanceName.

Returns:LMIInstance object if the object was retrieved successfully; None otherwise.

Usage: Conversion to a LMIInstance.

wrapped_object

Returns:wrapped CIMInstanceName object