class Backups(object):
"""
Backups API client.
"""
URI = '/rest/backups'
def __init__(self, con):
self._client = ResourceClient(con, self.URI)
def get_all(self):
"""
Retrieves the details for any current appliance backup. Only one backup file is present on the appliance at any
time.
Returns:
list: A list of Backups.
"""
return self._client.get_collection(self.URI)
def get(self, id_or_uri):
"""
Gets the details of the specified backup.
Args:
id_or_uri: ID or URI of the backup
Returns:
dict: Details of the specified backup.
"""
return self._client.get(id_or_uri)
def create(self, timeout=-1):
"""
Starts backing up the appliance. After completion, the backup file must be downloaded and saved off-appliance.
Appliance backups can be started at any time, and do not require any special setup to prepare the appliance for
the backup.
Args:
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: Details of the created backup.
"""
return self._client.create_with_zero_body(timeout=timeout)
def download(self, id_or_uri, file_path):
"""
Downloads a backup archive previously created on the appliance. Uploaded backup files cannot be downloaded.
Args:
id_or_uri: ID or URI of the Artifact Bundle.
file_path(str): Destination file path.
Returns:
bool: Successfully downloaded.
"""
return self._client.download(id_or_uri, file_path)
def upload(self, file_path):
"""
Uploads an appliance backup file in preparation of a restore. Any existing backup on the appliance is removed.
After the backup file is uploaded and validated, its details are returned. The URI of the backup can be used to
start a restore.
Args:
file_path (str): The local backup filepath
Returns:
dict: Details of the uploaded backup.
"""
return self._client.upload(file_path, self.URI + '/archive')
def get_config(self):
"""
Retrieves the details of the backup configuration for the remote server and automatic backup schedule.
Args:
id_or_uri: ID or URI of the backup
Returns:
dict: Details of the backup configuration for the remote server and automatic backup schedule.
"""
return self._client.get('config')
def update_config(self, config, timeout=-1):
"""
Updates the remote server configuration and the automatic backup schedule for backup.
Args:
config (dict): Object to update.
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: Backup details.
"""
return self._client.update(config,
uri=self.URI + "/config",
timeout=timeout)
def update_remote_archive(self, save_uri, timeout=-1):
"""
Saves a backup of the appliance to a previously-configured remote location.
Args:
save_uri (dict): The URI for saving the backup to a previously configured location.
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: Backup details.
"""
return self._client.update_with_zero_body(uri=save_uri,
timeout=timeout)
class Users(object):
"""
Users API client.
"""
URI = '/rest/users'
DEFAULT_VALUES = {
'200': {
'type': 'UserAndRoles'
},
'300': {
'type': 'UserAndRoles'
},
'500': {
'type': 'UserAndRoles'
}
}
def __init__(self, con):
self._connection = con
self._client = ResourceClient(con, self.URI)
def get_all(self, start=0, count=-1, filter='', sort=''):
"""
Gets a paginated collection of Users. The collection is based on optional
sorting and filtering and is constrained by start and count 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.
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 Users.
"""
return self._client.get_all(start, count, filter=filter, sort=sort)
def delete(self, resource, force=False, timeout=-1):
"""
Deletes a User.
Args:
resource: dict object to delete
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: Indicates if the resource was successfully deleted.
"""
return self._client.delete(resource, force=force, timeout=timeout)
def create(self, resource, timeout=-1):
"""
Creates a User.
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,
default_values=self.DEFAULT_VALUES)
def update(self, resource, timeout=-1):
"""
Updates a User.
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, just stop waiting for its completion.
Returns:
dict: Updated resource.
"""
return self._client.update(resource,
timeout=timeout,
default_values=self.DEFAULT_VALUES,
uri=self.URI)
def get_by(self, field, value):
"""
Gets all Users that match the filter.
The search is case-insensitive.
Args:
field: Field name to filter. Accepted values: 'name', 'userName', 'role'
value: Value to filter.
Returns:
list: A list of Users.
"""
if field == 'userName' or field == 'name':
return self._client.get(self.URI + '/' + value)
elif field == 'role':
value = value.replace(" ", "%20")
return self._client.get(self.URI + '/roles/users/' +
value)['members']
else:
raise HPEOneViewException(
'Only userName, name and role can be queried for this resource.'
)
def validate_user_name(self, user_name, timeout=-1):
"""
Verifies if a userName is already in use.
Args:
user_name:
The userName to be verified.
timeout:
Timeout in seconds. Wait for task completion by default. The timeout does not abort the operation in
OneView, just stops waiting for its completion.
Returns: True if user name is in use, False if it is not.
"""
uri = self.URI + '/validateLoginName/' + user_name
return self._client.create_with_zero_body(uri=uri, timeout=timeout)
def validate_full_name(self, full_name, timeout=-1):
"""
Verifies if a fullName is already in use.
Args:
full_name:
The fullName to be verified.
timeout:
Timeout in seconds. Wait for task completion by default. The timeout does not abort the operation in
OneView, just stops waiting for its completion.
Returns: True if full name is in use, False if it is not.
"""
uri = self.URI + '/validateUserName/' + full_name
return self._client.create_with_zero_body(uri=uri, timeout=timeout)
