class WSMan(object):
"""WS-management class"""
def __init__(self, transport=Subprocess()):
"""
Constructor for the WSMan class.
@param transport: The L{transport} instance that will handle WSMan requests. (default=L{Subprocess})
@type transport: L{transport}
"""
# Store the transport
self.__transport = transport
# Provider
self.__provider = WSManProviderFactory(self.__transport).get_provider()
def identify(self, remote=None, raw=False):
"""
Identify WS-Man implementation
@param remote: Remote configuration object
@type remote: L{Remote}
@param raw: Determines if the method should return the XML output from the transport, or a L{Response} object.
If you want to do your own parsing of the XML output, then set this parameter to True. (default=False)
@type raw: bool
@return: L{Response} object or the raw XML response
@rtype: L{Response}
"""
return self.__provider.identify(remote, raw)
@cache.lru_cache(maxsize=20)
def enumerate(self, cim_class, cim_namespace, remote=None, raw=False, uri_host="http://schemas.dmtf.org"):
"""
Enumerate a CIM class.
@attention: Uses LRU Cache - set keyword argument I{cache} to "I{no}", "I{false}", or "I{off}" to bypass the cache.
@param cim_class: CIM class to be enumerated
@type cim_class: String
@param cim_namespace: Namespace of the CIM class
@type cim_namespace: String
@param remote: Remote configuration object
@type remote: L{Remote}
@param raw: Determines if the method should return the XML output from the transport, or a L{Response} object.
If you want to do your own parsing of the XML output, then set this parameter to True. (default=False)
@type raw: bool
@param uri_host: The host portion of the resource URI
@type uri_host: L{String}
@return: A list of L{Instance} objects or the raw XML response
@rtype: list or string
"""
return self.__provider.enumerate(cim_class, cim_namespace, remote, raw, uri_host)
def subscribe(self, cim_class, cim_namespace, EventSinkIP, remote=None, raw=False):
"""
Enumerate the CIM class.
@param cim_class: CIM class to be enumerated
@type cim_class: String
@param cim_namespace: Namespace of the CIM class
@type cim_namespace: String
@param remote: Remote configuration object
@type remote: L{Remote}
@return: Response object after enumeration
@rtype: List
"""
return self.__provider.subscribe(cim_class, cim_namespace, EventSinkIP, remote, raw)
@cache.lru_cache(maxsize=20)
def renew(self, cim_namespace, uuid, remote=None, raw=False):
"""
Enumerate the CIM class.
@param cim_class: CIM class to be enumerated
@type cim_class: String
@param cim_namespace: Namespace of the CIM class
@type cim_namespace: String
@param remote: Remote configuration object
@type remote: L{Remote}
@return: Response object after enumeration
@rtype: List
"""
return self.__provider.renew(cim_namespace, uuid, remote, raw)
@cache.lru_cache(maxsize=20)
def unsubscribe(self, cim_namespace, uuid, remote=None, raw=False):
"""
Enumerate the CIM class.
@param cim_class: CIM class to be enumerated
@type cim_class: String
@param cim_namespace: Namespace of the CIM class
@type cim_namespace: String
@param remote: Remote configuration object
@type remote: L{Remote}
@return: Response object after enumeration
@rtype: List
"""
return self.__provider.unsubscribe(cim_namespace, uuid, remote, raw)
@cache.lru_cache(maxsize=20)
def enumerate_keys(self, cim_class, cim_namespace, remote=None, raw=False, uri_host="http://schemas.dmtf.org"):
"""
Enumerate the keys for a CIM class.
@attention: Uses LRU Cache - set keyword argument I{cache} to "I{no}", "I{false}", or "I{off}" to bypass the cache.
@param cim_class: CIM class for key enumeration
@type cim_class: String
@param cim_namespace: Namespace of the CIM class
@type cim_namespace: String
@param remote: Remote configuration object
@type remote: L{Remote}
@param raw: Determines if the method should return the XML output from the transport, or a L{Response} object.
If you want to do your own parsing of the XML output, then set this parameter to True. (default=False)
@type raw: bool
@param uri_host: The host portion of the resource URI
@type uri_host: L{String}
@return: A list of L{Instance} objects or the raw XML response
@rtype: list or string
"""
return self.__provider.enumerate_keys(cim_class, cim_namespace, remote, raw, uri_host)
@cache.lru_cache(maxsize=20)
def associators(self, instance, cim_namespace, remote=None, raw=False, uri_host="http://schemas.dmtf.org"):
"""
Do an associators operation for the instance
@attention: Uses LRU Cache - set keyword argument I{cache} to "I{no}", "I{false}", or "I{off}" to bypass the cache.
@param instance: CIM instance response object
@type instance: L{Instance}
@param cim_namespace: Namespace of the CIM class
@type cim_namespace: String
@param remote: Remote configuration object
@type remote: L{Remote}
@param raw: Determines if the method should return the XML output from the transport, or a L{Response} object.
If you want to do your own parsing of the XML output, then set this parameter to True. (default=False)
@type raw: bool
@param uri_host: The host portion of the resource URI
@type uri_host: L{String}
@return: A list of L{Reference} objects or the raw XML response
@rtype: list or string
"""
return self.__provider.associators(instance, cim_namespace, remote, raw, uri_host)
@cache.lru_cache(maxsize=20)
def references(self, instance, cim_namespace, remote=None, raw=False, uri_host="http://schemas.dmtf.org"):
"""
Do a references operation for the instance
@attention: Uses LRU Cache - set keyword argument I{cache} to "I{no}", "I{false}", or "I{off}" to bypass the cache.
@param instance: CIM instance response object
@type instance: L{Instance}
@param cim_namespace: Namespace of the CIM class
@type cim_namespace: String
@param remote: Remote configuration object
@type remote: L{Remote}
@param raw: Determines if the method should return the XML output from the transport, or a L{Response} object.
If you want to do your own parsing of the XML output, then set this parameter to True. (default=False)
@type raw: bool
@param uri_host: The host portion of the resource URI
@type uri_host: L{String}
@return: A list of L{Reference} objects or the raw XML response
@rtype: list or string
"""
return self.__provider.references(instance, cim_namespace, remote, raw, uri_host)
def set(self, reference, cim_namespace, remote=None, properties={}, raw=False):
"""
Sets the properties of an instance using the properties argument.
@param reference: CIM reference response object
@type reference: L{Reference}
@param cim_namespace: Namespace of the CIM class
@type cim_namespace: String
@param remote: Remote configuration object
@type remote: L{Remote}
@param properties: The properties and values to set
@type properties: dict
@param raw: Determines if the method should return the XML output from the transport, or a L{Response} object.
If you want to do your own parsing of the XML output, then set this parameter to True. (default=False)
@type raw: bool
@return: L{Response} object or the raw XML response
@rtype: L{Response}
"""
return self.__provider.set(reference, cim_namespace, remote, properties, raw)
def get(self, reference, cim_namespace, remote=None, raw=False):
"""
Do a get operation for the instance
@param reference: CIM reference response object
@type reference: L{Reference}
@param cim_namespace: Namespace of the CIM class
@type cim_namespace: String
@param remote: Remote configuration object
@type remote: L{Remote}
@param raw: Determines if the method should return the XML output from the transport, or a L{Response} object.
If you want to do your own parsing of the XML output, then set this parameter to True. (default=False)
@type raw: bool
@return: L{Instance} object or the raw XML response
@rtype: L{Instance}
"""
return self.__provider.get(reference, cim_namespace, remote, raw)
def invoke(self, reference, command, arguments, remote=None, raw=False):
"""
Do a get operation for the instance
@param reference: CIM reference response object
@type reference: L{Reference}
@param command: The command to invoke
@type command: String
@param arguments: A path to a file, or a dictionary of key/value paris used in the command
@type arguments: String/dict
@param remote: Remote configuration object
@type remote: L{Remote}
@param raw: Determines if the method should return the XML output from the transport, or a L{Response} object.
If you want to do your own parsing of the XML output, then set this parameter to True. (default=False)
@type raw: bool
@return: L{Response} object or the raw XML response
@rtype: L{Response}
"""
return self.__provider.invoke(reference, command, arguments, remote, raw)
def __set_quiet(self, value):
"""
Sets the transport's verbosity
"""
self.__transport.quiet = value
# Property to control the verbosity of the transport
quiet = property(fset=__set_quiet)
