class ApplianceDeviceSNMPv3Users(object):
"""
ApplianceDeviceSNMPv3Users API client [Available only since API 600].
As part of SNMPv3 trap forwarding support, the appliance provides APIs for creating User-based Security Model (USM) and forwarding destinations.
The following protocols are supported while defining USM.
Authentication protocols: MD5 / SHA1 / SHA256 / SHA384 / SHA512
Privacy protocols: AES / DES
The security levels supported while defining USM are None, Authentication only and both Authentication and Privacy.
"""
URI = '/rest/appliance/snmpv3-trap-forwarding/users'
def __init__(self, con):
self._client = ResourceClient(con, self.URI)
def create(self, resource, timeout=-1):
"""
Creates a new SNMPv3 user.
This user will be used for sending the SNMPv3 trap to the associated destinations.
One user can be assigned to multiple destinations.
Args:
resource (dict): Object to create.
timeout:
Timeout in seconds. Wait for task completion by default. The timeout does not abort the operation
in OneView, just stop waiting for its completion.
Returns:
dict: Created resource.
"""
return self._client.create(resource, timeout=timeout)
def get(self, id_or_uri):
"""
Returns the SNMPv3 user with the specified ID, if it exists.
Args:
id_or_uri: ID or URI of SNMPv3 user.
Returns:
dict: Appliance SNMPv3 user.
"""
return self._client.get(id_or_uri)
def get_all(self, start=0, count=-1, filter='', sort=''):
"""
Lists all SNMPv3 Users.
Args:
start:
The first item to return, using 0-based indexing.
If not specified, the default is 0 - start with the first available item.
count:
The number of resources to return. A count of -1 requests all items.
The actual number of items in the response might differ from the requested
count if the sum of start and count exceeds the total number of items.
filter (list or str):
A general filter/query string to narrow the list of items returned. The
default is no filter; all resources are returned.
sort:
The sort order of the returned data set. By default, the sort order is based
on create time with the oldest entry first.
Returns:
list: A list of SNMPv3 Users.
"""
return self._client.get_all(start, count, filter=filter, sort=sort)
def get_by(self, field, value):
"""
Gets all SNMPv3 users that match the filter.
The search is case-insensitive.
Args:
field: field name to filter
value: value to filter
Returns:
list: A list of SNMPv3 Users.
"""
return self._client.get_by(field, value)
def delete_all(self, filter=None, timeout=-1):
"""
Delete an SNMPv3 User based on User name specified in filter. The user will be deleted only if it has no associated destinations.
Args:
username: ID or URI of SNMPv3 user.
filter: A general filter/query string to narrow the list of items returned.
The default is no filter - all resources are returned.
Returns:
bool: Indicates if the resource was successfully deleted.
"""
return self._client.delete_all(filter=filter, timeout=timeout)
def delete(self, id_or_uri, timeout=-1):
"""
Delete an SNMPv3 User based on User Id specified in {Id}.
The user will be deleted only if it has no associated destinations.
Args:
id_or_uri: dict object to delete
timeout:
Timeout in seconds. Wait for task completion by default. The timeout does not abort the operation
in OneView, just stop waiting for its completion.
Returns:
bool: Indicates if the resource was successfully deleted.
"""
return self._client.delete(id_or_uri, timeout=timeout)
def update(self, resource, timeout=-1):
"""
Updates SNMPv3 User based on User Id as specified in {Id}
Args:
resource: dict object with changes.
timeout:
Timeout in seconds. Wait for task completion by default. The timeout does not abort the operation
in OneView, just stop waiting for its completion.
Returns:
dict: Updated appliance SNMPv3 user.
"""
return self._client.update(resource, timeout=timeout)
class Datacenters(object):
"""
Datacenters API client.
"""
URI = '/rest/datacenters'
def __init__(self, con):
self._connection = con
self._client = ResourceClient(con, self.URI)
def get_all(self, start=0, count=-1, filter='', query='', sort=''):
"""
Gets a set of data center resources according to the specified parameters. Filters can be used to get a specific
set of data centers.
Args:
start:
The first item to return, using 0-based indexing.
If not specified, the default is 0 - start with the first available item.
count:
The number of resources to return. A count of -1 requests all items.
The actual number of items in the response might differ from the requested
count if the sum of start and count exceeds the total number of items.
filter (list or str):
A general filter/query string to narrow the list of items returned. The
default is no filter; all resources are returned.
query:
A general query string to narrow the list of resources returned. The default
is no query - all resources are returned.
sort:
The sort order of the returned data set. By default, the sort order is based
on create time with the oldest entry first.
Returns:
list: List of data centers.
"""
return self._client.get_all(start,
count,
filter=filter,
sort=sort,
query=query)
def get(self, id_or_uri):
"""
Gets a single data center resource based upon its ID or URI.
Args:
id_or_uri:
Can be either the data center id or the data center uri.
Returns:
dict: The data center.
"""
return self._client.get(id_or_uri)
def get_visual_content(self, id_or_uri):
"""
Gets a list of visual content objects describing each rack within the data center. The response aggregates data
center and rack data with a specified metric (peak24HourTemp) to provide simplified access to display data for
the data center.
Args:
id_or_uri: Can be either the resource ID or the resource URI.
Return:
list: List of visual content objects.
"""
uri = self._client.build_uri(id_or_uri) + "/visualContent"
return self._client.get(uri)
def get_by(self, field, value):
"""
Gets all data centers that match the filter.
The search is case-insensitive.
Args:
field: Field name to filter.
value: Value to filter.
Returns:
list: List of data centers.
"""
return self._client.get_by(field, value)
def remove(self, resource, force=False, timeout=-1):
"""
Deletes the resource specified.
Args:
resource (dict): Object to remove.
force:
If set to true, the operation completes despite any problems with network connectivity or errors on the
resource itself. The default is false.
timeout:
Timeout in seconds. Wait for task completion by default. The timeout does not abort the operation
in OneView; it just stops waiting for its completion.
Returns: Result status.
"""
return self._client.delete(resource, force=force, timeout=timeout)
def add(self, information, timeout=-1):
"""
Adds a data center resource based upon the attributes specified.
Args:
information: Data center information
timeout: Timeout in seconds. Wait for task completion by default. The timeout does not abort the operation
in OneView; it just stops waiting for its completion.
Returns:
dict: Added data center.
"""
return self._client.create(information, timeout=timeout)
def update(self, resource, timeout=-1):
"""
Updates the specified data center resource.
Args:
resource (dict): Object to update.
timeout: Timeout in seconds. Wait for task completion by default. The timeout does not abort the operation
in OneView; it just stops waiting for its completion.
Returns:
dict: Updated data center.
"""
return self._client.update(resource, timeout=timeout)
def remove_all(self, filter, force=False, timeout=-1):
"""
Deletes the set of datacenters according to the specified parameters. A filter is required to identify the set
of resources to be deleted.
Args:
filter:
A general filter/query string to narrow the list of items that will be removed.
force:
If set to true, the operation completes despite any problems with
network connectivity or errors on the resource itself. The default is false.
timeout:
Timeout in seconds. Wait for task completion by default. The timeout does not abort the operation
in OneView; it just stops waiting for its completion.
Returns:
bool: operation success
"""
return self._client.delete_all(filter=filter,
force=force,
timeout=timeout)
class UnmanagedDevices(object):
URI = '/rest/unmanaged-devices'
def __init__(self, con):
self._connection = con
self._client = ResourceClient(con, self.URI)
def get_all(self, start=0, count=-1, filter='', query='', sort=''):
"""
Gets a set of unmanaged device resources according to the specified parameters. Filters can be used to get a
specific set of unmanaged devices. With no filters specified, the API returns a potentially paginated list of
all the unmanaged device resources subject to start/count/sort parameters.
Args:
start:
The first item to return, using 0-based indexing.
If not specified, the default is 0 - start with the first available item.
count:
The number of resources to return. A count of -1 requests all items.
The actual number of items in the response might differ from the requested
count if the sum of start and count exceeds the total number of items.
filter (list or str):
A general filter/query string to narrow the list of items returned. The
default is no filter; all resources are returned.
query:
A general query string to narrow the list of resources returned. The default
is no query - all resources are returned.
sort:
The sort order of the returned data set. By default, the sort order is based
on create time with the oldest entry first.
Returns:
list: Unmanaged Devices
"""
return self._client.get_all(start, count, filter=filter, sort=sort, query=query)
def get(self, id_or_uri):
"""
Gets a single Unmanaged Device resource based upon its uri or id.
Args:
id_or_uri:
Can be either the Unmanaged Device id or the uri
Returns:
dict: The Unmanaged Device
"""
return self._client.get(id_or_uri)
def add(self, information, timeout=-1):
"""
Adds an unmanaged device resource based upon the attributes specified. Use this method to create an unmanaged
device to represent resources that consume space within a rack, or consume power from a power delivery device
but cannot otherwise be represented by the management appliance.
Args:
information:
Unmanaged Device information
timeout:
Timeout in seconds. Wait for task completion by default. The timeout does not abort the operation
in OneView; it just stops waiting for its completion.
Returns:
dict: Added Unmanaged Device
"""
return self._client.create(information, timeout=timeout)
def remove(self, resource, force=False, timeout=-1):
"""
Deletes the resource specified.
Args:
resource:
Dict object to remove
force:
If set to true, the operation completes despite any problems with
network connectivity or errors on the resource itself. The default is false.
timeout:
Timeout in seconds. Wait for task completion by default. The timeout does not abort the operation
in OneView; it just stops waiting for its completion.
Returns:
bool: operation success
"""
return self._client.delete(resource, force=force, timeout=timeout)
def remove_all(self, filter, force=False, timeout=-1):
"""
Deletes the set of unmanaged-devices according to the specified parameters. A filter is required to identify
the set of resources to be deleted.
Args:
filter:
A general filter/query string to narrow the list of items that will be removed.
force:
If set to true, the operation completes despite any problems with
network connectivity or errors on the resource itself. The default is false.
timeout:
Timeout in seconds. Wait for task completion by default. The timeout does not abort the operation
in OneView; it just stops waiting for its completion.
Returns:
bool: operation success
"""
return self._client.delete_all(filter=filter, force=force, timeout=timeout)
def update(self, resource, timeout=-1):
"""
Updates the resource for the specified. The properties that are omitted (not included as part of the the
request body) are reset to their respective default values. The id and uuid properties are required and cannot
be changed.
Args:
resource (dict): Object to update
timeout:
Timeout in seconds. Wait for task completion by default. The timeout does not abort the operation
in OneView; it just stops waiting for its completion.
Returns:
dict: Updated Unmanaged Devices
"""
return self._client.update(resource, timeout=timeout)
def get_environmental_configuration(self, id_or_uri):
"""
Returns a description of the environmental configuration (supported feature set, calibrated minimum & maximum
power, location & dimensions, ...) of the resource.
Args:
id_or_uri:
Can be either the Unmanaged Device id or the uri
Returns:
dict:
EnvironmentalConfiguration
"""
uri = self._client.build_uri(id_or_uri) + "/environmentalConfiguration"
return self._client.get(uri)
def get_by(self, field, value):
"""
Gets all Unmanaged Devices that match the filter
The search is case-insensitive
Args:
field: field name to filter
value: value to filter
Returns:
dict: Unmanaged Devices
"""
return self._client.get_by(field, value)
class Alerts(object):
URI = '/rest/alerts'
def __init__(self, con):
self._connection = con
self._client = ResourceClient(con, self.URI)
def get(self, id_or_uri):
"""
Retrieve an alert by its URI or ID.
Args:
id_or_uri: alert ID or URI.
Returns:
dict: The alert.
"""
alert = self._client.get(id_or_uri)
return alert
def get_all(self,
start=0,
count=-1,
filter='',
query='',
sort='',
view=''):
"""
Gets all the alerts based upon filters provided.
Args:
start:
The first item to return, using 0-based indexing. If not specified, the default is 0 - start with the
first available item.
count:
The number of resources to return. A count of -1 requests all items. The actual number of items in
the response may differ from the requested count if the sum of start and count exceed the total number
of items.
filter (list or str):
A general filter/query string to narrow the list of items returned. The default is no filter; all
resources are returned.
query:
A general query string to narrow the list of resources returned. The default is no query (all
resources are returned).
sort:
The sort order of the returned data set. By default, the sort order is based on create time, with the
oldest entry first.
view:
Returns a specific subset of the attributes of the resource or collection, by specifying the name of a
predefined view. The default view is expand (show all attributes of the resource and all elements of
collections of resources).
Returns:
list: A list of alerts.
"""
return self._client.get_all(start=start,
count=count,
filter=filter,
query=query,
sort=sort,
view=view)
def get_by(self, field, value):
"""
Gets all alerts that match the filter.
The search is case-insensitive.
Args:
field: Field name to filter.
value: Value to filter.
Returns:
list: List of alerts.
"""
return self._client.get_by(field, value)
def delete(self, resource):
"""
Deletes an alert.
Args:
resource: dict object to delete
Returns:
bool: Indicates if the resource was successfully deleted.
"""
return self._client.delete(resource)
def delete_all(self, filter, timeout=-1):
"""
Deletes all Alert objects from the appliance that match the provided filter.
Args:
filter (list or str):
A general filter string to narrow the list of items to delete. The default is no filter; all
resources are deleted.
timeout: Timeout in seconds. Wait for task completion by default. The timeout does not abort the operation
in OneView; it just stops waiting for its completion.
Returns:
bool: Indicates whether the alerts were successfully deleted.
"""
return self._client.delete_all(filter=filter, timeout=timeout)
def update(self, resource, id_or_uri=None, timeout=-1):
"""
Updates the specified alert resource.
Args:
resource (dict): Object to update.
timeout: Timeout in seconds. Wait for task completion by default. The timeout does not abort the operation
in OneView; it just stops waiting for its completion.
Returns:
dict: Updated alert.
"""
uri = resource.pop('uri', None)
if not uri:
if not id_or_uri:
raise ValueError("URI was not provided")
uri = self._client.build_uri(id_or_uri)
return self._client.update(resource=resource, uri=uri, timeout=timeout)
def delete_alert_change_log(self, id_or_uri):
"""
Deletes alert change log by alert ID or URI.
Args:
id_or_uri: alert ID or URI.
"""
uri = self.URI + "/AlertChangeLog/" + extract_id_from_uri(id_or_uri)
resource = {"uri": uri}
self._client.delete(resource)