LMIInstanceName Package¶
- class lmi.shell.LMIInstanceName.LMIInstanceName(conn, cim_instance_name)¶
LMI wrapper class representing wbem.CIMInstanceName.
Parameters: - conn (LMIConnection) – connection object
- cim_instance_name (CIMInstanceName) – wrapped object
- associator_names(self_wr, *args, **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.
- 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).
- 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.
- 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.
Returns: list of associated LMIInstanceName objects
Raises: NOTE: If the method LMIInstanceName.delete() was called, this method will not execute its code and will return an empty list. If the shell uses exceptions, LMIDeletedObjectError will be raised.
Usage: Associated Instance Names.
- associators(self_wr, *args, **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.
- 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).
- 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.
- 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.
- 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.
- IncludeClassOrigin (bool) – bool flag indicating, if the CLASSORIGIN attribute shall be present on all appropriate elements in each returned object.
- 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.
Returns: list of associated LMIInstance objects
Raises: NOTE: If the method LMIInstanceName.delete() was called, this method will not execute its code and will return an empty list. If the shell uses exceptions, LMIDeletedObjectError will be raised.
Usage: Associated Instances.
- classname¶
Returns: class name Return type: string Raises: LMIDeletedObjectError NOTE: If the method LMIInstanceName.delete() was called, this method will not execute its code and will return an empty string. If the shell uses exceptions, LMIDeletedObjectError will be raised.
- copy()¶
Returns: copy of itself
- delete(self_wr, *args, **kwargs)¶
Deletes the instance defined by this object path from the CIMOM.
Returns: True, if the instance is deleted; False otherwise Raises: LMIDeletedObjectError NOTE: If the method LMIInstanceName.delete() was called, this method will not execute its code and will return True. If the shell uses exceptions, LMIDeletedObjectError will be raised.
Usage: Instance Names deletion.
- first_associator(self_wr, *args, **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.
- 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).
- 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.
- 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.
- 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.
- IncludeClassOrigin (bool) – bool flag indicating, if the CLASSORIGIN attribute shall be present on all appropriate elements in each returned object.
- 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.
Returns: first associated LMIInstance
Raises: NOTE: If the method LMIInstanceName.delete() was called, this method will not execute its code and will return None. If the shell uses exceptions, LMIDeletedObjectError will be raised.
Usage: Associated Instances.
- first_associator_name(self_wr, *args, **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.
- 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).
- 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.
- 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.
Returns: first associated LMIInstanceName object
Raises: NOTE: If the method LMIInstanceName.delete() was called, this method will not execute its code and will return None. If the shell uses exceptions, LMIDeletedObjectError will be raised.
Usage: Associated Instance Names.
- first_reference(self_wr, *args, **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).
- 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.
- 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.
- IncludeClassOrigin (bool) – flag indicating, if the CLASSORIGIN attribute shall be present on all appropriate elements in each returned object.
- 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.
Returns: first association LMIInstance object
Raises: NOTE: If the method LMIInstanceName.delete() was called, this method will not execute its code and will return None. If the shell uses exceptions, LMIDeletedObjectError will be raised.
Usage: Association Instances.
- first_reference_name(self_wr, *args, **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).
- 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.
Returns: first association LMIInstanceName object
Raises: NOTE: If the method LMIInstanceName.delete() was called, this method will not execute its code and will return None. If the shell uses exceptions, LMIDeletedObjectError will be raised.
Usage: Association Instance Names.
- hostname¶
Returns: host name Return type: string Raises: LMIDeletedObjectError NOTE: If the method LMIInstanceName.delete() was called, this method will not execute its code and will return an empty string. If the shell uses exceptions, LMIDeletedObjectError will be raised.
- is_deleted¶
Returns: True, if the instance was deleted from the CIMOM; False otherwise
- key_properties(self_wr, *args, **kwargs)¶
Returns: list of strings of key properties Raises: LMIDeletedObjectError NOTE: If the method LMIInstanceName.delete() was called, this method will not execute its code and will return an empty list. If the shell uses exceptions, LMIDeletedObjectError will be raised.
Usage: Key properties.
- key_properties_dict(self_wr, *args, **kwargs)¶
Returns: dictionary with key properties and corresponding values Raises: LMIDeletedObjectError NOTE: If the method LMIInstanceName.delete() was called, this method will not execute its code and will return an empty dictionary. If the shell uses exceptions, LMIDeletedObjectError will be raised.
- key_property_value(self_wr, *args, **kwargs)¶
Parameters: prop_name (string) – key property name Returns: key property value Raises: LMIDeletedObjectError NOTE: If the method LMIInstanceName.delete() was called, this method will not execute its code and will return None. If the shell uses exceptions, LMIDeletedObjectError will be raised.
- methods(self_wr, *args, **kwargs)¶
Returns a list of wbem.CIMInstance methods’ names.
Returns: list of wbem.CIMInstance methods’ names Raises: LMIDeletedObjectError NOTE: If the method LMIInstanceName.delete() was called, this method will not execute its code and will return an empty list. If the shell uses exceptions, LMIDeletedObjectError will be raised.
Usage: Instance Methods.
- namespace¶
Returns: namespace name Return type: string Raises: LMIDeletedObjectError NOTE: If the method LMIInstanceName.delete() was called, this method will not execute its code and will return an empty string. If the shell uses exceptions, LMIDeletedObjectError will be raised.
- print_key_properties(self_wr, *args, **kwargs)¶
Prints out the list of key properties.
Raises: LMIDeletedObjectError NOTE: If the method LMIInstanceName.delete() was called, this method will not execute its code and will return None. If the shell uses exceptions, LMIDeletedObjectError will be raised.
Usage: Key properties.
- print_methods(self_wr, *args, **kwargs)¶
Prints out the list of wbem.CIMInstance methods’ names.
Raises: LMIDeletedObjectError NOTE: If the method LMIInstanceName.delete() was called, this method will not execute its code and will return None. If the shell uses exceptions, LMIDeletedObjectError will be raised.
Usage: Instance Methods.
- reference_names(self_wr, *args, **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).
- 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.
Returns: list of association LMIInstanceName objects
Raises: NOTE: If the method LMIInstanceName.delete() was called, this method will not execute its code and will return an empty list. If the shell uses exceptions, LMIDeletedObjectError will be raised.
Usage: Association Instance Names.
- references(self_wr, *args, **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).
- 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.
- 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.
- IncludeClassOrigin (bool) – flag indicating, if the CLASSORIGIN attribute shall be present on all appropriate elements in each returned object.
- 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.
Returns: list of association LMIInstance objects
Raises: NOTE: If the method LMIInstanceName.delete() was called, this method will not execute its code and will return an empty list. If the shell uses exceptions, LMIDeletedObjectError will be raised.
Usage: Association Instances.
- to_instance(self_wr, *args, **kwargs)¶
Creates a new LMIInstance object from LMIInstanceName.
Returns: LMIInstance object if the object was retrieved successfully; None otherwise. Raises: LMIDeletedObjectError NOTE: If the method LMIInstanceName.delete() was called, this method will not execute its code and will return None. If the shell uses exceptions, LMIDeletedObjectError will be raised.
Usage: Conversion to a LMIInstance.
- wrapped_object¶
Returns: wrapped wbem.CIMInstanceName object Raises: LMIDeletedObjectError NOTE: If the method LMIInstanceName.delete() was called, this method will not execute its code and will return None. If the shell uses exceptions, LMIDeletedObjectError will be raised.