LMIInstance.
LMIInstance
(conn, lmi_class, cim_instance)[source]¶LMI wrapper class representing CIMInstance
.
Parameters: |
|
---|
associator_names
(**kwargs)[source]¶Returns a list of associated LMIInstanceName
with this object.
NOTE: If the method LMIInstance.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.
Parameters: |
|
---|---|
Returns: | list of associated |
Raises: |
Usage: Associated Instance Names.
associators
(**kwargs)[source]¶Returns a list of associated LMIInstance
objects with this instance.
NOTE: If the method LMIInstance.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.
Parameters: |
|
---|---|
Returns: | list of associated |
Raises: |
Usage: Associated Instances.
delete
()[source]¶Deletes this instance from the CIMOM.
NOTE: If the method LMIInstance.delete()
was called, this method
will not execute its code and will return None. If the shell uses exceptions,
LMIDeletedObjectError
will be raised.
Returns: | True, if the instance is deleted; False otherwise |
---|---|
Raises: | LMIDeletedObjectError |
Usage: Instance deletion.
doc
()[source]¶Prints out pretty verbose message with documentation for the instance. If the LMIShell
is run in a interactive mode, the output will be redirected to a pager set by
environment variable PAGER
. If there is not PAGER
set, less or
more will be used as a fall-back.
NOTE: If the method LMIInstance.delete()
was called, this method will
not execute its code and will return None. If the shell uses exceptions,
LMIDeletedObjectError
will be raised.
Raises: | LMIDeletedObjectError |
---|
first_associator
(**kwargs)[source]¶Returns the first associated LMIInstance
with this object.
NOTE: If the method LMIInstance.delete()
was called, this method will
not execute its code and will return None. If the shell uses exceptions,
LMIDeletedObjectError
will be raised.
Parameters: |
|
---|---|
Returns: | first associated |
Raises: |
Usage: Associated Instances.
first_associator_name
(**kwargs)[source]¶Returns the first associated LMIInstanceName
with this object.
NOTE: If the method LMIInstance.delete()
was called, this method will
not execute its code and will return None. If the shell uses exceptions,
LMIDeletedObjectError
will be raised.
Parameters: |
|
---|---|
Returns: | first associated |
Raises: |
Usage: Associated Instance Names.
first_reference
(**kwargs)[source]¶Returns the first association LMIInstance
with this object.
NOTE: If the method LMIInstance.delete()
was called, this method will
not execute its code and will return None. If the shell uses exceptions,
LMIDeletedObjectError
will be raised.
Parameters: |
|
---|---|
Returns: | first association |
Raises: |
Usage: Association Instances.
first_reference_name
(**kwargs)[source]¶Returns the first association LMIInstanceName
with this object.
NOTE: If the method LMIInstance.delete()
was called, this method will
not execute its code and will return None. If the shell uses exceptions,
LMIDeletedObjectError
will be raised.
Parameters: |
|
---|---|
Returns: | first association |
Raises: |
Usage: Association Instance Names.
methods
()[source]¶Returns a list of CIMInstance
methods’ names.
NOTE: If the method LMIInstance.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.
Returns: | list of CIMInstance methods’ names |
---|---|
Raises: | LMIDeletedObjectError |
Usage: Instance Methods.
print_methods
()[source]¶Prints out the list of CIMInstance
methods’ names.
NOTE: If the method LMIInstance.delete()
was called, this method
will not execute its code and will return None. If the shell uses exceptions,
LMIDeletedObjectError
will be raised.
Raises: | LMIDeletedObjectError |
---|
Usage: Instance Methods.
print_properties
()[source]¶Prints out the list of CIMInstance
properties.
NOTE: If the method LMIInstance.delete()
was called, this method
will not execute its code and will return None. If the shell uses exceptions,
LMIDeletedObjectError
will be raised.
Raises: | LMIDeletedObjectError |
---|
Usage: Instance Properties.
properties
()[source]¶Returns a list of CIMInstance
properties.
NOTE: If the method LMIInstance.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.
Returns: | list of CIMInstance properties |
---|---|
Return type: | list |
Raises: | LMIDeletedObjectError |
Usage: Instance Properties.
properties_dict
()[source]¶Returns dictionary containing property name and value pairs. This method may consume significant memory amount when called.
NOTE: If the method LMIInstance.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.
Returns: | dictionary of CIMInstance properties |
---|---|
Raises: | LMIDeletedObjectError |
property_value
(prop_name)[source]¶Returns a CIMInstance
property value.
NOTE: If the method LMIInstance.delete()
was called, this method
will not execute its code and will return None. If the shell uses exceptions,
LMIDeletedObjectError
will be raised.
Parameters: | prop_name (string) – CIMInstance property name |
---|---|
Raises: | LMIDeletedObjectError |
push
()[source]¶Pushes the modified object to the CIMOM.
NOTE: If the method LMIInstance.delete()
was called, this method
will not execute its code and will return LMIReturnValue
object
containing False as a return value with proper error string set. If the shell uses
exceptions, LMIDeletedObjectError
will be raised.
Returns: | LMIReturnValue object with rval set to 0, if modified;
-1 otherwise |
---|---|
Raises: | LMIDeletedObjectError |
Usage: Instance Properties.
reference_names
(**kwargs)[source]¶Returns a list of association LMIInstanceName
objects with this
object.
NOTE: If the method LMIInstance.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.
Parameters: |
|
---|---|
Returns: | list of association |
Raises: |
Usage: Association Instance Names.
references
(**kwargs)[source]¶Returns a list of association LMIInstance
objects with this object.
NOTE: If the method LMIInstance.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.
Parameters: |
|
---|---|
Returns: | list of association |
Raises: |
Usage: Association Instances.
refresh
()[source]¶Retrieves a new CIMInstance
object. Basically refreshes the object
properties. Returns LMIReturnValue with rval set to True, if the wrapped
CIMInstance
object was refreshed; otherwise rval is set to False.
NOTE: If the method LMIInstance.delete()
was called, this method
will not execute its code and will return LMIReturnValue
object
containing False as a return value with proper error string set. If the shell uses
exceptions, LMIDeletedObjectError
will be raised.
Returns: | LMIReturnValue object with rval set to True, if
refreshed; False otherwise |
---|---|
Raises: | LMIDeletedObjectError |
Usage: Instance refreshing.
tomof
()[source]¶Prints out a message with MOF representation of CIMMethod
. If
the LMIShell is run in a interactive mode, the output will be
redirected to a pager set by environment variable PAGER
. If
there is not PAGER
set, less or more will be used as a
fall-back.
NOTE: If the method LMIInstance.delete()
was called, this method
will not execute its code and will return None. If the shell uses exceptions,
LMIDeletedObjectError
will be raised.
Raises: | LMIDeletedObjectError |
---|
classname
¶Property returning a string of a class name.
NOTE: If the method LMIInstance.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.
Returns: | class name |
---|---|
Return type: | string |
Raises: | LMIDeletedObjectError |
is_deleted
¶Returns: | True, if the instance was deleted from the CIMOM; False otherwise |
---|
namespace
¶Property retuning a string of a namespace name.
NOTE: If the method LMIInstance.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.
Returns: | namespace name |
---|---|
Return type: | string |
Raises: | LMIDeletedObjectError |
path
¶Property returning a LMIInstanceName
objec5.
NOTE: If the method LMIInstance.delete()
was called, this method
will not execute its code and will return None. If the shell uses exceptions,
LMIDeletedObjectError
will be raised.
Returns: | LMIInstanceName object |
---|---|
Raises: | LMIDeletedObjectError |
wrapped_object
¶Returns: | wrapped CIMInstance object |
---|