class StorageSystems(object):
"""
Storage Systems API client.
"""
URI = '/rest/storage-systems'
def __init__(self, con):
self._connection = con
self._client = ResourceClient(con, self.URI)
def get_all(self, start=0, count=-1, filter='', sort=''):
"""
Gets information about all managed storage systems. Filtering and sorting are supported with the retrieval of
managed storage systems. The following storage system attributes can be used with filtering and sorting
operation: name, model, serialNumber, firmware, status, managedDomain, and state.
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 all managed storage systems.
"""
return self._client.get_all(start, count, filter=filter, sort=sort)
def add(self, resource, timeout=-1):
"""
Adds a storage system for management by the appliance. The storage system resource created will be in a
Connected state and will not yet be available for further operations. Users are required to perform a PUT API
on the storage system resource to complete the management of the storage system resource. An asynchronous task
will be created as a result of this API call to discover available domains, target ports, and storage pools.
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; it just stops waiting for its completion.
Returns:
dict: Created storage system.
"""
return self._client.create(resource, timeout=timeout)
def get_host_types(self):
"""
Gets the list of supported host types.
Returns:
list: Host types.
"""
uri = self.URI + "/host-types"
return self._client.get(uri)
def get_storage_pools(self, id_or_uri):
"""
Gets a list of Storage pools. Returns a list of storage pools belonging to the storage system referred by the
Path property {ID} parameter or URI.
Args:
id_or_uri: Can be either the storage system ID (serial number) or the storage system URI.
Returns:
dict: Host types.
"""
uri = self._client.build_uri(id_or_uri) + "/storage-pools"
return self._client.get(uri)
def get(self, id_or_uri):
"""
Gets the specified storage system resource by ID or by URI.
Args:
id_or_uri: Can be either the storage system id or the storage system uri.
Returns:
dict: The storage system.
"""
return self._client.get(id_or_uri)
def update(self, resource, timeout=-1):
"""
Updates the storage system. To complete the addition of a storage system for management by the appliance,
this must be called after create() of a storage system.
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 storage system.
"""
return self._client.update(resource, timeout=timeout)
def remove(self, resource, force=False, timeout=-1):
"""
Removes the storage system from OneView.
Args:
resource (dict):
Object to delete
force (bool):
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:
dict: Details of associated resource.
"""
headers = {'If-Match': '*'}
return self._client.delete(resource, force=force, timeout=timeout, custom_headers=headers)
def get_managed_ports(self, id_or_uri, port_id_or_uri=''):
"""
Gets all ports or a specific managed target port for the specified storage system.
Args:
id_or_uri: Can be either the storage system id or the storage system uri.
port_id_or_uri: Can be either the port id or the port uri.
Returns:
dict: Managed ports.
"""
if port_id_or_uri:
uri = self._client.build_uri(port_id_or_uri)
if "/managedPorts" not in uri:
uri = self._client.build_uri(id_or_uri) + "/managedPorts" + "/" + port_id_or_uri
else:
uri = self._client.build_uri(id_or_uri) + "/managedPorts"
return self._client.get_collection(uri)
def get_by(self, field, value):
"""
Gets all storage systems that match the filter.
The search is case-insensitive.
Args:
Field: field name to filter.
Value: value to filter.
Returns:
list: A list of storage systems.
"""
return self._client.get_by(field, value)
def get_by_name(self, name):
"""
Retrieves a resource by its name.
Args:
name: Resource name.
Returns:
dict
"""
return self._client.get_by_name(name=name)
def get_by_ip_hostname(self, ip_hostname):
"""
Retrieve a storage system by its IP.
Works only with API version <= 300.
Args:
ip_hostname: Storage system IP or hostname.
Returns:
dict
"""
resources = self._client.get_all()
resources_filtered = [x for x in resources if x['credentials']['ip_hostname'] == ip_hostname]
if resources_filtered:
return resources_filtered[0]
else:
return None
def get_by_hostname(self, hostname):
"""
Retrieve a storage system by its hostname.
Works only in API500 onwards.
Args:
hostname: Storage system hostname.
Returns:
dict
"""
resources = self._client.get_all()
resources_filtered = [x for x in resources if x['hostname'] == hostname]
if resources_filtered:
return resources_filtered[0]
else:
return None
def get_reachable_ports(self, id_or_uri, start=0, count=-1, filter='', query='', sort='', networks=[]):
"""
Gets the storage ports that are connected on the specified networks
based on the storage system port's expected network connectivity.
Returns:
list: Reachable Storage Port List.
"""
uri = self._client.build_uri(id_or_uri) + "/reachable-ports"
if networks:
elements = "\'"
for n in networks:
elements += n + ','
elements = elements[:-1] + "\'"
uri = uri + "?networks=" + elements
return self._client.get(self._client.build_query_uri(start=start, count=count, filter=filter, query=query,
sort=sort, uri=uri))
def get_templates(self, id_or_uri, start=0, count=-1, filter='', query='', sort=''):
"""
Gets a list of volume templates. Returns a list of storage templates belonging to the storage system.
Returns:
list: Storage Template List.
"""
uri = self._client.build_uri(id_or_uri) + "/templates"
return self._client.get(self._client.build_query_uri(start=start, count=count, filter=filter,
query=query, sort=sort, uri=uri))
class StorageVolumeTemplates(object):
"""
Storage Volume Templates API client.
"""
URI = '/rest/storage-volume-templates'
DEFAULT_VALUES = {
'200': {
"type": "StorageVolumeTemplateV3"
},
'300': {
"type": "StorageVolumeTemplateV3"
}
}
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 list of storage volume templates.
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 storage volume templates.
"""
return self._client.get_all(start, count, filter=filter, sort=sort)
def create(self, resource, timeout=-1):
"""
Creates a new storage volume template.
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; it just stops waiting for its completion.
Returns:
dict: Created storage volume template.
"""
custom_headers = {'Accept-Language': 'en_US'}
return self._client.create(resource,
timeout=timeout,
custom_headers=custom_headers,
default_values=self.DEFAULT_VALUES)
def get(self, id_or_uri):
"""
Gets the specified storage volume template resource by ID or by URI.
Args:
id_or_uri: Can be either the storage volume template ID or the storage volume template URI.
Returns:
dict: The storage volume template
"""
return self._client.get(id_or_uri)
def get_connectable_volume_templates(self,
start=0,
count=-1,
filter='',
query='',
sort=''):
"""
Gets the storage volume templates that are available on the specified networks based on the storage system
port's expected network connectivity. If there are no storage volume templates that meet the specified
connectivity criteria, an empty collection will be returned.
Returns:
list: Storage volume templates.
"""
uri = self.URI + "/connectable-volume-templates"
get_uri = self._client.build_query_uri(start=start,
count=count,
filter=filter,
query=query,
sort=sort,
uri=uri)
return self._client.get(get_uri)
def get_reachable_volume_templates(self,
start=0,
count=-1,
filter='',
query='',
sort='',
networks=None,
scope_uris='',
private_allowed_only=False):
"""
Gets the storage templates that are connected on the specified networks based on the storage system
port's expected network connectivity.
Returns:
list: Storage volume templates.
"""
uri = self.URI + "/reachable-volume-templates"
uri += "?networks={}&privateAllowedOnly={}".format(
networks, private_allowed_only)
get_uri = self._client.build_query_uri(start=start,
count=count,
filter=filter,
query=query,
sort=sort,
uri=uri,
scope_uris=scope_uris)
return self._client.get(get_uri)
def get_compatible_systems(self, id_or_uri):
"""
Retrieves a collection of all storage systems that is applicable to this storage volume template.
Args:
id_or_uri:
Can be either the power device id or the uri
Returns:
list: Storage systems.
"""
uri = self._client.build_uri(id_or_uri) + "/compatible-systems"
return self._client.get(uri)
def delete(self, resource, force=False, timeout=-1):
"""
Deletes the specified storage volume template.
Args:
resource (dict):
Object to remove.
force (bool):
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.
"""
custom_headers = {'Accept-Language': 'en_US', 'If-Match': '*'}
return self._client.delete(resource,
force=force,
timeout=timeout,
custom_headers=custom_headers)
def update(self, resource, timeout=-1):
"""
Updates a storage volume template.
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 storage volume system
"""
custom_headers = {'Accept-Language': 'en_US'}
return self._client.update(resource,
timeout=timeout,
custom_headers=custom_headers,
default_values=self.DEFAULT_VALUES)
def get_by(self, field, value):
"""
Gets all storage volume templates that match the filter.
The search is case-insensitive.
Args:
field: Field name to filter.
value: Value to filter.
Returns:
list: A list of storage volume templates that match the filter.
"""
return self._client.get_by(field, value)
class StoragePools(object):
"""
Storage Pools API client.
"""
URI = '/rest/storage-pools'
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 list of storage pools. Returns a list of storage pools based on optional sorting and filtering, and
constrained by start and count parameters. The following storage pool attributes can be used with filtering and
sorting operation: name, domain, deviceType, deviceSpeed, supportedRAIDLevel, status, and state.
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 storage pools.
"""
return self._client.get_all(start, count, filter=filter, sort=sort)
def add(self, resource, timeout=-1):
"""
Adds storage pool for management by the appliance.
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; it just stops waiting for its completion.
Returns:
dict: Created storage pool.
"""
return self._client.create(resource, timeout=timeout)
def get(self, id_or_uri):
"""
Gets the specified storage pool resource by ID or by URI.
Args:
id_or_uri: Can be either the storage pool id or the storage pool uri.
Returns:
dict: The storage pool.
"""
return self._client.get(id_or_uri)
def remove(self, resource, force=False, timeout=-1):
"""
Removes an imported storage pool from OneView.
Args:
resource (dict):
Object to remove.
force (bool):
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:
dict: Details of associated resource.
"""
return self._client.delete(resource, force=force, timeout=timeout)
def get_by(self, field, value):
"""
Gets all storage pools that match the filter.
The search is case-insensitive.
Args:
field: Field name to filter.
value: Value to filter.
Returns:
list: A list of storage pools.
"""
return self._client.get_by(field, value)
def get_reachable_storage_pools(self,
start=0,
count=-1,
filter='',
query='',
sort='',
networks=None,
scope_exclusions=None,
scope_uris=''):
"""
Gets the storage pools that are connected on the specified networks
based on the storage system port's expected network connectivity.
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: 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.
query: A general query string to narrow the list of resources returned.
The default is no query - all resources are returned.
networks: Specifies the comma-separated list of network URIs used by the
reachable storage pools.
scope_exclusions: Specifies the comma-separated list of storage-pools URIs
that will be excluded from the scope validation checks.
scope_uris: Specifies the comma-separated list of scope URIs used by the
reachable storage pools.
Returns:
list: Reachable Storage Pools List.
"""
uri = self.URI + "/reachable-storage-pools"
if networks:
elements = "\'"
for n in networks:
elements += n + ','
elements = elements[:-1] + "\'"
uri = uri + "?networks=" + elements
if scope_exclusions:
storage_pools_uris = ",".join(scope_exclusions)
uri = uri + "?" if "?" not in uri else uri + "&"
uri += "scopeExclusions={}".format(storage_pools_uris)
return self._client.get(
self._client.build_query_uri(start=start,
count=count,
filter=filter,
query=query,
sort=sort,
uri=uri,
scope_uris=scope_uris))
def update(self, resource, timeout=-1):
"""
Updates a storage pool.
It can be used to manage/unmanage a storage pool, update attributes or to request a refresh.
To manage or unmanage a storage pool: Set the isManaged attribute true to manage or false to unmanage.
Attempting to unmanage a StoreVirtual pool is not allowed and the attempt will return a task error.
To request a refresh set the "requestingRefresh" attribute to true. No other attribute update can be performed
while also requesting a refresh of the pool.
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 storage system.
"""
return self._client.update(resource, timeout=timeout)
