# -*- coding: utf-8 -*-
###
# (C) Copyright (2012-2017) Hewlett Packard Enterprise Development LP
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
###
from __future__ import absolute_import
from __future__ import division
from __future__ import print_function
from __future__ import unicode_literals
from future import standard_library
standard_library.install_aliases()
from hpOneView.resources.resource import ResourceClient
[docs]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)
[docs] 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)
[docs] 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)
[docs] 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)
[docs] 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)
[docs] 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)
[docs] 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)
[docs] 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)