class GoldenImages(object):
URI = '/rest/golden-images'
def __init__(self, con):
self._client = ResourceClient(con, self.URI)
self._task_monitor = TaskMonitor(con)
self.__default_values = {
'type': 'GoldenImage',
}
def get_all(self, start=0, count=-1, filter='', sort=''):
"""
Retrieves a list of Golden Image resources as per the specified 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 Golden Images.
"""
return self._client.get_all(start, count, filter=filter, sort=sort)
def create(self, resource, timeout=-1):
"""
Creates a Golden Image resource from the deployed OS Volume as per the attributes specified.
Args:
resource (dict): Object to create.
timeout:
Timeout in seconds. Waits for task completion by default. The timeout does not abort the operation
in OneView, it just stops waiting for its completion.
Returns:
dict: Golden Image created.
"""
data = self.__default_values.copy()
data.update(resource)
return self._client.create(data, timeout=timeout)
def upload(self, file_path, golden_image_info):
"""
Adds a Golden Image resource from the file that is uploaded from a local drive. Only the .zip format file can
be used for the upload.
Args:
file_path (str): File name to upload.
golden_image_info (dict): Golden Image information.
Returns:
dict: Golden Image.
"""
uri = "{0}?name={1}&description={2}".format(
self.URI, quote(golden_image_info.get('name', '')),
quote(golden_image_info.get('description', '')))
return self._client.upload(file_path, uri)
def download_archive(self, id_or_uri, file_path):
"""
Download the details of the Golden Image capture logs, which has been archived based on the specific attribute
ID.
Args:
id_or_uri: ID or URI of the Golden Image.
file_path (str): File name to save the archive.
Returns:
bool: Success.
"""
uri = self.URI + "/archive/" + extract_id_from_uri(id_or_uri)
return self._client.download(uri, file_path)
def download(self, id_or_uri, file_path):
"""
Downloads the content of the selected Golden Image as per the specified attributes.
Args:
id_or_uri: ID or URI of the Golden Image.
file_path(str): Destination file path.
Returns:
bool: Successfully downloaded.
"""
uri = self.URI + "/download/" + extract_id_from_uri(id_or_uri)
return self._client.download(uri, file_path)
def get(self, id_or_uri):
"""
Retrieves the overview details of the selected Golden Image as per the specified attributes.
Args:
id_or_uri: ID or URI of the Golden Image.
Returns:
dict: The Golden Image.
"""
return self._client.get(id_or_uri)
def update(self, resource, timeout=-1):
"""
Updates the properties of the Golden Image.
Args:
resource (dict): Object to update.
timeout:
Timeout in seconds. Waits for task completion by default. The timeout does not abort the operation
in OneView, it just stops waiting for its completion.
Returns:
dict: Updated resource.
"""
return self._client.update(resource, timeout=timeout)
def delete(self, resource, force=False, timeout=-1):
"""
Deletes the Golden Image specified.
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. Waits 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 get_by(self, field, value):
"""
Gets all Golden Images that match the filter.
The search is case-insensitive.
Args:
field: Field name to filter.
value: Value to filter.
Returns:
list: A list of Golden Images.
"""
return self._client.get_by(field, value)
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 OsVolumes(object):
URI = '/rest/os-volumes'
def __init__(self, con):
self._client = ResourceClient(con, self.URI)
self.__default_values = {
'type': 'OeVolume',
}
def get_all(self, start=0, count=-1, filter='', sort=''):
"""
Gets a list of the OS Volume based on optional sorting and filtering, and 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 OS Volume.
"""
return self._client.get_all(start, count, filter=filter, sort=sort)
def get(self, id_or_uri):
"""
Retrieves the overview details of the selected OS Volume as per the selected attributes.
Args:
id_or_uri: ID or URI of the OS Volume.
Returns:
dict: The OS Volume.
"""
return self._client.get(id_or_uri)
def get_by(self, field, value):
"""
Gets all OS Volume that match the filter.
The search is case-insensitive.
Args:
field: Field name to filter.
value: Value to filter.
Returns:
list: A list of OS Volume.
"""
return self._client.get_by(field, value)
def get_by_name(self, name):
"""
Gets an OS Volume by name.
Args:
name: Name of the OS Volume.
Returns:
dict: The OS Volume.
"""
return self._client.get_by_name(name)
def download_archive(self, name, file_path):
"""
Download archived logs of the OS Volume.
Args:
name: Name of the OS Volume.
file_path (str): Destination file path.
Returns:
bool: Indicates if the resource was successfully downloaded.
"""
uri = self.URI + "/archive/" + name
return self._client.download(uri, file_path)
def get_storage(self, id_or_uri):
"""
Get storage details of an OS Volume.
Args:
id_or_uri: ID or URI of the OS Volume.
Returns:
dict: Storage details
"""
uri = self.URI + "/{}/storage".format(extract_id_from_uri(id_or_uri))
return self._client.get(uri)
