simplivity.resources package

Submodules

simplivity.resources.backups module

class simplivity.resources.backups.Backup(connection, resource_client, data)

Bases: object

Implements features available for a single Backup resources.

cancel(timeout=- 1)

Cancels the specified running backup Args:

timeout: Time out for the request in seconds.

Returns:

object: Backup object.

copy(cluster=None, external_store_name=None, timeout=- 1)

Copies the specified backup to another omnistack_cluster or external store Args:

cluster: Destination OmnistackCluster object/name. external_store_name: The name of the external store. timeout: Time out for the request in seconds.

Returns:

object: Returns the new backup object.

delete(timeout=- 1)

Deletes the specified backup

get_virtual_disk_partition_files(virtual_disk, partition_number, file_path)

Retrieves the virtual hard disk files from the backup Args:

virtual_disk: The name of the virtual hard disk for the virtual machine. partition_number: The partition number of the virtual disk associated with the backup. file_path: The path in the partition that has the file information you want. e.g. for root directory use “/”.

Returns:

dict: Returns dictionary containing virtual hard disk files from the backup.

get_virtual_disk_partitions(virtual_disk)

Retrieves partition information for the virtual disk associated with the backup Args:

virtual_disk: The name of the virtual hard disk for the virtual machine.

Returns:

dict: Returns dictionary containing partition information for the virtual disk associated.

lock(timeout=- 1)

Saves the specified backup to prevent it from expiring

rename(new_name, timeout=- 1)

Renames the specified backup Args:

new_name: The new name for the backup. timeout: Time out for the request in seconds.

Returns:

object: Backup object.

restore(restore_original, virtual_machine_name=None, datastore=None, timeout=- 1)

Creates a new virtual machine or replaces the original virtual machine from the specified backup

Args:

restore_original: If True, Resets the original virtual machine to the same state it was in when the backup was created

If False, Creates a new virtual machine from the backup with the provided name, optionally to a different datastore

virtual_machine_name: The name of the new virtual machine created from this action. datastore: Destination datastore object/name. timeout: Time out for the request in seconds.

Returns:

Virtual machine object

restore_files(virtual_machine_id, paths, timeout=- 1)

Restores files from specific partition

Args:

virtual_machine_id: The identification number of the virtual machine where you want to restore the files. paths: List of path to the files in this format: virtual_machine_disk_name/partition_number/path_to_file.

Returns:

None

class simplivity.resources.backups.Backups(connection)

Bases: simplivity.resources.resource.ResourceBase

Implements features available for SimpliVity Backup resources.

delete_multiple_backups(backups, timeout=- 1)

Deletes a list of backups.

Args:

backups: list of backup objects

get_all(pagination=False, page_size=0, limit=500, offset=0, sort=None, order='descending', filters=None, fields=None, case_sensitive=True)

Gets all backups.

Args:

pagination: True if need pagination page_size: Size of the page (Required when pagination is on) limit: A positive integer that represents the maximum number of results to return offset: A positive integer that directs the service to start returning

the <offset value> instance, up to the limit.

sort: The name of the field where the sort occurs. order: The sort order preference. Valid values: ascending or descending. filters: Dictionary with filter values. Example: {‘name’: ‘name’}

id: the unique identifier (UID) of the backups to return

Accepts: Single value, comma-separated list

name: The name of the backups to return

Accepts: Single value, comma-separated list, pattern using one or more asterisk characters as a wildcard.

sent_min: The minimum sent data size (in bytes) of the remote backups to return. sent_max: The maximum sent data size (in bytes) of the remote backups to return. state: The current state of the backups to return

Accepts: Single value, comma-separated list

type: The type of backups to return.

Accepts: Single value, comma-separated list.

omnistack_cluster_id: The unique identifier (UID) of the omnistack_cluster

that is associated with the instances to return Accepts: Single value, comma-separated list

omnistack_cluster_name: The name of the omnistack_cluster that is associated

with the instances to return Accepts: Single value, comma-separated list

compute_cluster_parent_hypervisor_object_id: The unique identifier (UID) of the

hypervisor that contains the omnistack_cluster that is associated with the instances to return Accepts: Single value, comma-separated list

compute_cluster_parent_name: The name of the hypervisor that contains the

omnistack_cluster that is associated with the instances to return Accepts: Single value, comma-separated list

datastore_id: The unique identifier (UID) of the datastore that is associated

with the instances to return Accepts: Single value, comma-separated list

datastore_name: The name of the datastore that is associated with the instances to return

Accepts: Single value, comma-separated list

expires_before: The latest expiration time before the backups to return expire,

expressed in ISO-8601 form, based on Coordinated Universal Time (UTC)

expires_after: The earliest expiration time after the backups to return expire,

expressed in ISO-8601 form, based on Coordinated Universal Time (UTC)

virtual_machine_id: The unique identifier (UID) of the virtual_machine that is

associated with the instances to return Accepts: Single value, comma-separated list

virtual_machine_name: The name of the virtual_machine that is associated with

the instances to return Accepts: Single value, comma-separated list

virtual_machine_type: The type of the virtual_machine that is associated with the

instances to return Accepts: Single value, comma-separated list

size_min: The minimum size (in bytes) of the backups to return size_max: The maximum size (in bytes) of the backups to return application_consistent: The application-consistent setting of the backups to return consistency_type: The consistency type of the backups to return

Accepts: Single value, comma-separated list

created_before: The latest creation time before the backups to return were created,

expressed in ISO-8601 form, based on Coordinated Universal Time (UTC)

created_after: The earliest creation time after the backups to return were created,

expressed in ISO-8601 form, based on Coordinated Universal Time (UTC)

sent_duration_min: The minimum number of seconds that elapsed while replicating

the backups to return

sent_duration_max: The maximum number of seconds that elapsed while replicating the

backups to return

sent_completion_before: The latest time before the replication of backups to return was

completed, expressed in ISO-8601 form, based on Coordinated Universal Time (UTC)

sent_completion_after: The earliest time after the replication of backups to return was

completed, expressed in ISO-8601 form, based on Coordinated Universal Time (UTC)

Returns:

list: list of resources

get_by_data(data)

Gets Backup object from backup data.

Args:

data: Backup data

Returns:

object: Backup object.

set_retention(backups, retention, force=False, cluster_group=None, timeout=- 1)

Sets the retention time for the specified list of backups.

Args:

backups: The list of backup objects that you want to set the retention time for. retention: The number of minutes to keep backups. force: An indicator to force a retention time modification even if this action results in deleting backups.

Valid Values:

True: Sets the new retention time for the specified list of backups. This action may delete of one or more

backups.

False: Does not make the requested retention time modification if this results in deleting one or more

backups. This operation returns a list of backups that the requested modification deletes. If the requested modification does not delete the backups, the retention time modification occurs.

cluster_group: Object/name of the cluster group. timeout: Time out for the request in seconds.

Returns:

list: List of backup objects.

simplivity.resources.certificates module

class simplivity.resources.certificates.Certificate(connection, resource_client, data)

Bases: object

Implements features available for single Certificate resource.

class simplivity.resources.certificates.Certificates(connection)

Bases: simplivity.resources.resource.ResourceBase

Implements features for SimpliVity Certificates resources.

add_certificate(certificate, timeout=- 1)

Add a SSL certificate to the HPE SimpliVity trust store

Args:

certificate: Base64 encoded SSL certificate. timeout: Time out for the request in seconds.

Returns:

dict : Returns the certificate details.

get_all()

Get all SSL certificates from the HPE SimpliVity trust store

get_by_data(data)

Gets Certificate object from data.

Args:

data: Certificate data

Returns:

object: Certificate object.

get_by_id(resource_id)

Method not available on resource

get_by_name(name)

Method not available on resource

simplivity.resources.cluster_groups module

class simplivity.resources.cluster_groups.ClusterGroup(connection, resource_client, data)

Bases: object

Implements features available for single cluster group resource.

OBJECT_TYPE = 'cluster_group'

rename(name, timeout=- 1)

Rename a cluster_group.

Args:

name: The name of the cluster group. timeout: Time out for the request in seconds.

Returns: object: ClusterGroup object.

class simplivity.resources.cluster_groups.ClusterGroups(connection)

Bases: simplivity.resources.resource.ResourceBase

Implements features available for cluster group resources.

get_all(pagination=False, page_size=0, limit=500, offset=0, sort=None, order='descending', filters=None, fields=None, case_sensitive=True, show_optional_fields=False)

Gets all cluster groups.

Args:

pagination: True if need pagination page_size: Size of the page (Required when pagination is on) limit: A positive integer that represents the maximum number of results to return offset: A positive integer that directs the service to start returning

the <offset value> instance, up to the limit.

sort: The name of the field where the sort occurs. order: The sort order preference. Valid values: ascending or descending. filters: Dictionary with filter values. Example: {‘name’: ‘name’}

id: The unique identifier (UID) of the omnistack_clusters to return

Accepts: Single value, comma-separated list

name: The name of the omnistack_clusters to return

Accepts: Single value, comma-separated list, pattern using one or more asterisk characters as a wildcard

Returns:

list: list of OmnistackCluster

get_by_data(data)

Gets ClusterGroup object from data.

Args:

data: ClusterGroup data

Returns:

object: ClusterGroup object.

simplivity.resources.datastores module

class simplivity.resources.datastores.Datastore(connection, resource_client, data)

Bases: object

Implements features available for single Datastore resource.

delete(timeout=- 1)

Deletes a datastore.

resize(size, timeout=- 1)

Resizes a datastore.

Args:

size: The size in bytes. timeout: Time out for the request in seconds.

Returns:

object: Datastore object.

set_policy(policy, timeout=- 1)

Sets the backup policy for a datastore.

Args:

policy: Policy object/name timeout: Time out for the request in seconds.

Returns:

object: Datastore object.

share(host_name, timeout=- 1)

Share a datastore.

Args:

host_name: The name of the standard host that you want sharing a datastore. timeout: Time out for the request in seconds.

Returns:

object: Datastore object.

standard_hosts()

Gets the standard hosts that can share a datastore.

Returns:

list: List of standard hosts objects.

unshare(host_name, timeout=- 1)

Stop sharing a datastore.

Args:

host_name: The name of the standard host that needs to stop sharing a datastore. timeout: Time out for the request in seconds.

Returns:

object: Datastore object.

class simplivity.resources.datastores.Datastores(connection)

Bases: simplivity.resources.resource.ResourceBase

Implements features available for SimpliVity Datastore resources.

create(datastore_name, cluster, policy, size=0, timeout=- 1)

Creates a new datastore.

Args:

datastore_name: The name of the new datastore created from this action. cluster: Destination OmnistackCluster object/name. policy: Object/name of the policy to assocaited with the new datastore. size: The size in bytes of the new datastore. timeout: Time out for the request in seconds.

Returns:

object: Datastore object.

get_all(pagination=False, page_size=0, limit=500, offset=0, sort=None, order='descending', filters=None, fields=None, case_sensitive=True, show_optional_fields=False)

Gets all datastores.

Args:

pagination: True if need pagination page_size: Size of the page (Required when pagination is on) limit: A positive integer that represents the maximum number of results to return offset: A positive integer that directs the service to start returning

the <offset value> instance, up to the limit.

sort: The name of the field where the sort occurs. order: The sort order preference. Valid values: ascending or descending. filters: Dictionary with filter values. Example: {‘name’: ‘name’}

id: The unique identifier (UID) of the datastores to return

Accepts: Single value, comma-separated list

name: The name of the datastores to return

Accepts: Single value, comma-separated list, pattern using one or more asterisk characters as a wildcard

min_size: The minimum size (in bytes) of datastores to return max_size: The maximum size (in bytes) of datastores to return created_before: The latest creation time before the datastores to return were created,

expressed in ISO-8601 form, based on Coordinated Universal Time (UTC)

created_after: The earliest creation time after the datastores to return were created,

expressed in ISO-8601 form, based on Coordinated Universal Time (UTC)

omnistack_cluster_id: The unique identifier (UID) of the omnistack_cluster that is

associated with the instances to return Accepts: Single value, comma-separated list

omnistack_cluster_name: The name of the omnistack_cluster that is associated with

the instances to return Accepts: Single value, comma-separated list

compute_cluster_parent_hypervisor_object_id: The unique identifier (UID) of the hypervisor

that contains the omnistack_cluster that is associated with the instances to return Accepts: Single value, comma-separated list

compute_cluster_parent_name: The name of the hypervisor that contains the omnistack

cluster that is associated with the instances to return Accepts: Single value, comma-separated list

hypervisor_management_system_name: The name of the Hypervisor Management System (HMS)

associated with the datastore Accepts: Single value, comma-separated list, pattern using one or more asterisk characters as a wildcard

policy_id: The unique identifier (UID) of the policy that is associated with the

instances to return Accepts: Single value, comma-separated list

policy_name: The name of the policy that is associated with the instances to return

Accepts: Single value, comma-separated list

hypervisor_object_id: The unique identifier (UID) of the hypervisor-based instance

that is associated with the instances to return Accepts: Single value, comma-separated list

mount_directory: A comma-separated list of fields to include in the returned objects

Default: Returns all fields

Returns:

list: list of Datastore objects.

get_by_data(data)

Gets Datastore object from data.

Args:

data: Datastore data

Returns:

object: Datastore object.

simplivity.resources.external_stores module

class simplivity.resources.external_stores.ExternalStore(connection, resource_client, data)

Bases: object

Implements features available for a single External store resources.

unregister_external_store(cluster, timeout=- 1)

Removes the external store as a backup destination for the cluster. Backups remain on the external store,but they can no longer be managed by HPE SimpliVity. Args:

cluster: Destination OmnistackCluster object/name. timeout: Time out for the request in seconds.

Returns:

None

class simplivity.resources.external_stores.ExternalStores(connection)

Bases: simplivity.resources.resource.ResourceBase

Implements features available for SimpliVity External store resources.

get_all(pagination=False, page_size=0, limit=500, offset=0, sort=None, order='descending', filters=None, fields=None, case_sensitive=True)

Get all external stores Args:

pagination: True if need pagination page_size: Size of the page (Required when pagination is on) limit: A positive integer that represents the maximum number of results to return offset: A positive integer that directs the service to start returning

the <offset value> instance, up to the limit.

sort: The name of the field where the sort occurs order: The sort order preference. Valid values: ascending or descending. filters: Dictionary with filter values. Example: {‘name’: ‘name’}

name: The name of the external_stores to return.

Accepts: Single value, comma-separated list, pattern using one or more asterisk characters as a wildcard.

omnistack_cluster_id: The name of the omnistack_cluster that is associated with the instances to return cluster_group_id:The unique identifiers (UIDs) of the cluster_groups associated with the external stores to return

Accepts: Single value, comma-separated list

management_ip: The IP address of the external store

Accepts: Single value, comma-separated list, pattern using one or more asterisk characters as a wildcard

type: The type of external store

Default: StoreOnceOnPrem

Returns:

list: list of resources

get_by_data(data)

Gets ExternalStore object from data.

Args:

data: ExternalStore data

Returns:

object: ExternalStore object.

register_external_store(management_ip, name, cluster, username, password, management_port=9387, storage_port=9388, external_store_type='StoreOnceOnPrem', timeout=- 1)

Register the external store. Args:

management_ip: The IP address of the external store name: The name of the external_store cluster: Destination OmnistackCluster object/name. username: The client name of the external store password: The client password of the external store management_port: The management IP port of the external store. Default: 9387 storage_port: The storage IP port of the external store. Default: 9388 external_store_type: The type of external store. Default: StoreOnceOnPrem timeout: Time out for the request in seconds.

Returns:

object: External store object.

update_credentials(name, username, password, management_ip=None, timeout=- 1)

Update the IP address or credentials that HPE SimpliVity uses to access the external stores

Args:

name: The name of the external_store username: The client name of the external store password: The client password of the external store management_ip: The IP address of the external store timeout: Time out for the request in seconds.

Returns:

object: External store object.

simplivity.resources.hosts module

class simplivity.resources.hosts.Host(connection, resource_client, data)

Bases: object

Implements features available for single Host resource.

OBJECT_TYPE = 'host'

cancel_virtual_controller_shutdown(timeout=- 1)

Cancels the virtual controller shutdown.

Args:

timeout: Time out for the request in seconds.

Returns:

status: Possible values are ‘SUCCESS’, ‘FAILURE’, ‘UNKNOWN’, ‘IN_PROGRESS’.

get_capacity(fields=None, time_offset=0, range=43200, resolution='MINUTE')

Gets host capacity.

Args:

fields: Comma-separated list of fields to include in the returned objects. time_offset: A time offset in seconds (from now) or a datetime, expressed in ISO-8601 form,

based on Coordinated Universal Time (UTC).

range: A range in seconds (the duration from the specified point in time). resolution: The resolution (SECOND, MINUTE, HOUR, or DAY).

Returns:

dict: Dictionary of the capacity details.

get_hardware()

Retrieves the hardware information for the host

get_metrics(time_offset=0, range=43200, resolution='MINUTE')

Retrieves throughput, IOPS, and latency data for the host.

Args:

time_offset: A time offset in seconds (from now) or a datetime, expressed in ISO-8601 form,

based on Coordinated Universal Time (UTC).

range: A range in seconds (the duration from the specified point in time). resolution: The resolution (SECOND, MINUTE, HOUR, or DAY).

Returns:

dict: Dictionary of the metrics details.

get_virtual_controller_shutdown_status()

Retrieves the shutdown status of the Virtual Controller

remove(force=False, timeout=- 1)

Removes the specified host from the federation.

Args:

force: An indicator that specifies if the host should be removed forcefully or not.

Valid values:

True: Forces the removal of the host even if active virtual machines are

present and if the host is not HA-compliant. This may cause data loss.

False: Returns an error if there are any virtual machines on the host or if the host is not HA-compliant.

shutdown_virtual_controller(ha_wait=True, timeout=- 1)

Shuts down the Virtual Controller safely (by reaching HA compliance) or by force.

Args:

ha_wait: An indicator to show if the user wants to shut down the Virtual Controller safely or forcefully.

Valid values:

True: Virtual Controller waits for the virtual machines to reach HA compliance before shutting down. False: Virtual Controller forced to shut down without waiting for HA compliance.

timeout: Time out for the request in seconds.

Returns:

status: Possible values are ‘SUCCESS’, ‘FAILURE’, ‘UNKNOWN’, ‘IN_PROGRESS’.

class simplivity.resources.hosts.Hosts(connection)

Bases: simplivity.resources.resource.ResourceBase

Implements features available for SimpliVity Host resources.

get_all(pagination=False, page_size=0, limit=500, offset=0, sort=None, order='descending', filters=None, fields=None, case_sensitive=True, show_optional_fields=False)

Gets all hosts.

Args:

pagination: True if need pagination page_size: Size of the page (Required when pagination is on) limit: A positive integer that represents the maximum number of results to return offset: A positive integer that directs the service to start returning

the <offset value> instance, up to the limit.

sort: The name of the field where the sort occurs. order: The sort order preference. Valid values: ascending or descending. filters: Dictionary with filter values. Example: {‘name’: ‘name’}

id: The unique identifier (UID) of the host

Accepts: Single value, comma-separated list

name: The name of the host

Accepts: Single value, comma-separated list, pattern using one or more asterisk characters as a wildcard

type: The type of host

Accepts: Single value, comma-separated list, pattern using one or more asterisk characters as a wildcard

model: The model of the host

Accepts: Single value, comma-separated list, pattern using one or more asterisk characters as a wildcard

version: The version of the host

Accepts: Single value, comma-separated list, pattern using one or more asterisk characters as a wildcard

hypervisor_management_system: The IP address of the Hypervisor Management System (HMS)

associated with the host Accepts: Single value, comma-separated list, pattern using one or more asterisk characters as a wildcard

hypervisor_management_system_name: The name of the Hypervisor Management System (HMS)

associated with the host Accepts: Single value, comma-separated list, pattern using one or more asterisk characters as a wildcard

hypervisor_object_id: The unique identifier (UID) of the hypervisor associated

with the host Accepts: Single value, comma-separated list, pattern using one or more asterisk characters as a wildcard

compute_cluster_name: The name of the compute cluster associated with the host

Accepts: Single value, comma-separated list, pattern using one or more asterisk characters as a wildcard

compute_cluster_hypervisor_object_id: The unique identifier (UID)

of the Hypervisor Management System (HMS) for the associated compute cluster Accepts: Single value, comma-separated list, pattern using one or more asterisk characters as a wildcard

management_ip: The IP address of the HPE OmniStack management module that

runs on the host Accepts: Single value, comma-separated list, pattern using one or more asterisk characters as a wildcard

storage_ip: The IP address of the HPE OmniStack storage module that runs on the host

Accepts: Single value, comma-separated list, pattern using one or more asterisk characters as a wildcard

federation_ip: The IP address of the federation

Accepts: Single value, comma-separated list, pattern using one or more asterisk characters as a wildcard

virtual_controller_name: The name of the Virtual Controller that runs on the host

Accepts: Single value, comma-separated list, pattern using one or more asterisk characters as a wildcard

compute_cluster_parent_name: The name of the hypervisor that contains the omnistack

cluster that is associated with the instance Accepts: Single value, comma-separated list, pattern using one or more asterisk characters as a wildcard

compute_cluster_parent_hypervisor_object_id: The unique identifier (UID) of the

hypervisor that contains the omnistack_cluster that is associated with the instance Accepts: Single value, comma-separated list, pattern using one or more asterisk characters as a wildcard

policy_enabled: An indicator to show the status of the backup policy for the host

Valid values: True: The backup policy for the host is enabled. False: The backup policy for the host is disabled.

current_feature_level_min: The minimum current feature level of the HPE OmniStack

software running on the host

current_feature_level_max: The maximum current feature level of the HPE OmniStack

software running on the host

potential_feature_level_min: The minimum potential feature level of the HPE OmniStack

software running on the host

potential_feature_level_max: The maximum potential feature level of the HPE OmniStack

software running on the host

upgrade_state: The state of the most recent HPE OmniStack software upgrade for this

host (SUCCESS, FAIL, IN_PROGRESS, NOOP, UNKNOWN) Accepts: Single value, comma-separated list, pattern using one or more asterisk characters as a wildcard

can_rollback: An indicator to show if the current HPE OmniStack software running on

the host can roll back to the previous version Valid values: True: The current HPE OmniStack software for the host can roll back to the previous version. False: The current HPE OmniStack software for the host cannot roll back to the previous version.

Returns:

list: list of Host objects

get_by_data(data)

Gets Host object from host data.

Args:

data: host data

Returns:

object: Host object.

simplivity.resources.omnistack_clusters module

class simplivity.resources.omnistack_clusters.OmnistackCluster(connection, resource_client, data)

Bases: object

Implements features available for single OmniStack cluster resource.

OBJECT_TYPE = 'omnistack_cluster'

get_connected_clusters()

Retrieves directly connected omnistack_clusters.

Returns:

list: List of omnistack_clusters objects.

get_metrics(time_offset=0, range=43200, resolution='MINUTE')

Retrieves throughput, IOPS, and latency data for cluster.

Args:

time_offset: A time offset in seconds (from now) or a datetime,

expressed in ISO-8601 form, based on Coordinated Universal Time (UTC) Default: 0

range: A range in seconds (the duration from the specified point in time) Default: 43200 resolution: The resolution (SECOND, MINUTE, HOUR, or DAY) Default: MINUTE

Returns:

dict: Dictionary of metrics object.

get_throughput(destination_id=None, time_offset=0, range=43200)

Calculates the throughput between each pair of omnistack_clusters in the federation

Args:

destination_id : The unique identifier (UID) of the omnistack_clusters to return time_offset : A time offset in seconds (from now) or a datetime,

expressed in ISO-8601 form, based on Coordinated Universal Time (UTC) Default: 0

range : A range in seconds (the duration from the specified point in time) Default: 43200

Returns:

dict: Dictionary of cluster_throughput object.

set_time_zone(time_zone, timeout=- 1)

Sets the time zone for a cluster.

Args:

time_zone: The time zone in case-sensitive region/locale format

for example, “America/New_York”

timeout : Time out for the request in seconds.

Returns:

object: omnistack cluster object.

class simplivity.resources.omnistack_clusters.OmnistackClusters(connection)

Bases: simplivity.resources.resource.ResourceBase

Implements features available for OmniStack cluster resources.

get_all(pagination=False, page_size=0, limit=500, offset=0, sort=None, order='descending', filters=None, fields=None, case_sensitive=True, show_optional_fields=False)

Gets all omnistack clusters.

Args:

pagination: True if need pagination page_size: Size of the page (Required when pagination is on) limit: A positive integer that represents the maximum number of results to return offset: A positive integer that directs the service to start returning

the <offset value> instance, up to the limit.

sort: The name of the field where the sort occurs. order: The sort order preference. Valid values: ascending or descending. filters: Dictionary with filter values. Example: {‘name’: ‘name’}

id: The unique identifier (UID) of the omnistack_clusters to return

Accepts: Single value, comma-separated list

name: The name of the omnistack_clusters to return

Accepts: Single value, comma-separated list, pattern using one or more asterisk characters as a wildcard

hypervisor_object_id: The unique identifier (UID) of the hypervisor associated

with the objects to return Accepts: Single value, comma-separated list, pattern using one or more asterisk characters as a wildcard

hypervisor_object_parent_id: The unique identifier (UID) of the hypervisor that

contains the objects to return Accepts: Single value, comma-separated list, pattern using one or more asterisk characters as a wildcard

hypervisor_object_parent_name: The name of the hypervisor that contains the objects

to return Accepts: Single value, comma-separated list, pattern using one or more asterisk characters as a wildcard

hypervisor_management_system_name: The name of the hypervisor associated with the

omnistack_cluster Accepts: Single value, comma-separated list, pattern using one or more asterisk characters as a wildcard

type: The type of omnistack_clusters to return

Accepts: Single value, comma-separated list, pattern using one or more asterisk characters as a wildcard

arbiter_address: The address of the Arbiter connected to the objects to return

Accepts: Single value, comma-separated list, pattern using one or more asterisk characters as a wildcard

arbiter_connected: An indicator to show if the omnistack_cluster is connected to Arbiter

Valid values: True: Only returns omnistack_clusters connected to Arbiters that you identified

in arbiter_address

False: Only returns omnistack_clusters not connected to Arbiters that you identified

in arbiter_address

Returns:

list: list of OmnistackCluster

get_by_data(data)

Gets OmnistackCluster object from data.

Args:

data: OmnistackCluster data

Returns:

object: OmnistackCluster object.

get_time_zone_list()

Retrieves a list of all valid time zones

simplivity.resources.policies module

Implements operations for policies.

class simplivity.resources.policies.Policies(connection)

Bases: simplivity.resources.resource.ResourceBase

Implements features for SimpliVity Policy resources.

create(name, flags=None, timeout=- 1)

create the new policy

Args:

name : The name of the new policy created from this action. flags: Dictionary of flags. Example: {‘cluster_group_id’: ‘cluster_group_id’} timeout : Time out for the request in seconds.

Returns:

object: Policy object.

get_all(pagination=False, page_size=0, limit=500, offset=0, sort=None, order='descending', filters=None, fields=None, case_sensitive=True)

Gets all policies.

Args:

pagination: True if need pagination page_size: Size of the page (Required when pagination is on) limit: A positive integer that represents the maximum number of results to return offset: A positive integer that directs the service to start returning

the <offset value> instance, up to the limit.

sort: The name of the field where the sort occurs. order: The sort order preference. Valid values: ascending or descending. filters: Dictionary with filter values. Example: {‘name’: ‘name’}

id: The unique identifier (UID) of the policy

Accepts: Single value, comma-separated list

name:The name of the policy

Accepts: Single value, comma-separated list

Returns:

list: list of Policy objects

get_by_data(data)

Gets Policy object from data.

Args:

data: Policy data

Returns:

object: Policy object.

resume(target=None, timeout=- 1)

Resumes policy-based backups on a specific targeted object Args:

target: Target object.

Allowed object of host, omnistack_cluster, cluster_group and default is federation

timeout: Time out for the request in seconds.

Returns:

None

suspend(target=None, timeout=- 1)

Suspends policy-based backups on a specific targeted object Args:

target: Target object.

Allowed object of host, omnistack_cluster, cluster_group and default is federation

timeout: Time out for the request in seconds.

Returns:

None

class simplivity.resources.policies.Policy(connection, resource_client, data)

Bases: object

Implements features available for a single Policy resource.

OBJECT_TYPE = 'policy'

create_rules(rules, replace_all_rules=False, timeout=- 1)

Creates one or more new rules or replaces existing rules with new rules for a policy

Args:

rules: Array of rules.(below are the parameter that can be passed in the array)

[Mandatory Parameters] frequency: The number of minutes between backups retention: The number of minutes to keep backups [Optional Parameters] application_consistent: Set false for crash-consistent backups

Set true for application-consistent backups (for example, VSS or snapshot backups) Default: false

consistency_type: Set to DEFAULT for a snapshot backup

Set to VSS for a Microsoft Volume Shadow Copy Service backup Set to NONE for crash-consistent backups Default: NONE

destination_id: The unique identifier (UID) of the omnistack_cluster to store the backup

Default: local omnistack_cluster

days: The days of the week (for example, Mon,Fri), or month (for example, 1,15) to take backups or

“last” to specify the last day of each month Default: All (that is, every day)

start_time: The time to start the backups, for example, 14:30

This time is local to the time zone of the Hypervisor Management System (HMS) Default: 00:00

end_time: The time to stop backing up, for example, 14:30

This time is local to the time zone of the Hypervisor Management System (HMS) Default: 00:00

external_store_name: The name of the external_store

replace_all_rules: If set to True, replaces the existing rules with new rules

If set to False, adds the new rules to existing set of rules

timeout: Time out for the request in seconds.

Returns:

self: Returns the policy object.

delete(timeout=- 1)

Removes a policy

delete_rule(rule_id, timeout=- 1)

Removes a policy rule Args:

rule_id: Rule id to be deleted timeout: Time out for the request in seconds.

Returns:

self: Returns the policy object.

edit_rule(rule_id, rule, timeout=- 1)

Edits an existing policy rule Args:

rule_id: Rule id to be edited rule: Dictionary of fields from backup policy rule can change, except destination_name, id, number,

and max_backups.

application_consistent: Set false for crash-consistent backups

Set true for application-consistent backups (for example, VSS or snapshot backups) Default: false

consistency_type: Set to DEFAULT for a snapshot backup

Set to VSS for a Microsoft Volume Shadow Copy Service backup Set to NONE for crash-consistent backups Default: NONE

destination_id: The unique identifier (UID) of the omnistack_cluster to store the backup

Default: local omnistack_cluster

days: The days of the week (for example, Mon,Fri), or month (for example, 1,15) to take backups or

“last” to specify the last day of each month Default: All (that is, every day)

frequency: The number of minutes between backups retention: The number of minutes to keep backups start_time: The time to start the backups, for example, 14:30

This time is local to the time zone of the Hypervisor Management System (HMS) Default: 00:00

end_time: The time to stop backing up, for example, 14:30

This time is local to the time zone of the Hypervisor Management System (HMS) Default: 00:00

external_store_name: The name of the external_store

timeout: Time out for the request in seconds.

Returns:

self: Returns the policy object.

get_rule(rule_id)

Retrieves the specified policy rule Args:

rule_id : Rule id to be retrieved

Returns:

Rules object

get_vms()

Retrieves the virtual machines using this policy.

Returns:

list: List of vms.

impact_create_rules(rules, replace_all_rules=False, timeout=- 1)

Generate a backup impact reported based on proposed creation of rules for the policy

Args:

rules: Array of rules.(below are the parameter that can be passed in the array)

[Mandatory Parameters] frequency: The number of minutes between backups retention: The number of minutes to keep backups [Optional Parameters] application_consistent: Set false for crash-consistent backups

Set true for application-consistent backups (for example, VSS or snapshot backups) Default: false

consistency_type: Set to DEFAULT for a snapshot backup

Set to VSS for a Microsoft Volume Shadow Copy Service backup Set to NONE for crash-consistent backups Default: NONE

destination_id: The unique identifier (UID) of the omnistack_cluster to store the backup

Default: local omnistack_cluster

days: The days of the week (for example, Mon,Fri), or month (for example, 1,15) to take backups or

“last” to specify the last day of each month Default: All (that is, every day)

start_time: The time to start the backups, for example, 14:30

This time is local to the time zone of the Hypervisor Management System (HMS) Default: 00:00

end_time: The time to stop backing up, for example, 14:30

This time is local to the time zone of the Hypervisor Management System (HMS) Default: 00:00

external_store_name: The name of the external_store

replace_all_rules: If set to True, replaces the existing rules with new rules

If set to False, adds the new rules to existing set of rules

timeout: Time out for the request in seconds.

Returns:

dict : Returns the dictionary for impact report of created rules.

impact_edit_rules(rules, replace_all_rules=False, timeout=- 1)

Generate a backup impact reported based on proposed changes to the rules for the policy Args:

rules: Array of rules.(below are the parameter that can be passed in the array)

[Mandatory Parameters] rule_id: The unique identifier (UID) of the policy rule frequency: The number of minutes between backups retention: The number of minutes to keep backups [Optional Parameters] application_consistent: Set false for crash-consistent backups

Set true for application-consistent backups (for example, VSS or snapshot backups) Default: false

consistency_type: Set to DEFAULT for a snapshot backup

Set to VSS for a Microsoft Volume Shadow Copy Service backup Set to NONE for crash-consistent backups Default: NONE

destination_id: The unique identifier (UID) of the omnistack_cluster to store the backup

Default: local omnistack_cluster

days: The days of the week (for example, Mon,Fri), or month (for example, 1,15) to take backups or

“last” to specify the last day of each month Default: All (that is, every day)

start_time: The time to start the backups, for example, 14:30

This time is local to the time zone of the Hypervisor Management System (HMS) Default: 00:00

end_time: The time to stop backing up, for example, 14:30

This time is local to the time zone of the Hypervisor Management System (HMS) Default: 00:00

external_store_name: The name of the external_store

replace_all_rules: If set to True, replaces the existing rules with new rules

If set to False, adds the new rules to existing set of rules

timeout: Time out for the request in seconds.

Returns:

dict : Returns the dictionary for impact report of rules.

impact_report_delete_rule(rule_id, timeout=- 1)

Generate a backup impact reported based on proposed deletion of a policy rule Args:

rule_id: The unique identifier (UID) of the policy rule you want to access timeout: Time out for the request in seconds.

Returns:

dict : Returns the dictionary for impact report of rules.

policy_schedule_report(cluster_group_id=None)

Retrieves the policy schedule report

Args:

cluster_group_id: Unique identifier of cluster group

Returns:

dict: Dictionary for policy schedule report

rename(new_name, timeout=- 1)

Renames the specified policy Args:

new_name: The new name of the specified policy. timeout: Time out for the request in seconds.

Returns:

object: Policy object.

simplivity.resources.resource module

Implements helper methods for the resource classes.

class simplivity.resources.resource.Pagination(con, url, resource_obj, params, members_field, page_size)

Bases: object

Implements pagination features for get_all method.

next_page()

Gets next page.

Returns list of resources from next page.

Raises:

HPESimpliVityException: if no more pages to return.

previous_page()

Gets previous page.

Returns list of resources from previous page.

Raises:

HPESimpliVityException: if no more pages to return.

class simplivity.resources.resource.ResourceBase(connection)

Bases: object

Implements base class for resource classes.

get_by_id(resource_id)

Gets resource by id.

Args:

id: ID of the resource

Returns:

object: Resource object

Raises:

HPESimpliVityResourceNotFound: if resource doesn’t exist with the id passed.

get_by_name(name)

Gets resource by name.

Args:

name: Name of the resource

Returns:

object: object of the resource

Raises:

HPESimpliVityResourceNotFound: if resource doesn’t exist with the name passed.

class simplivity.resources.resource.ResourceClient(connection, resource_obj)

Bases: object

Implements helper methods for resource classes.

do_delete(uri, timeout, custom_headers=None)

Makes delete requests.

Args:

uri: URI of the resource timeout: Time out for the request in seconds. custom_headers: Allows to set custom http headers.

Returns:

list: Returns ids of the affected resources.

do_get(uri, filters=None)

Makes get requests

Args:

uri: URI of the resource filters: Dictionary of filters, example: {‘name’: ‘name’}

Returns:

Returns: Returns the resource data

do_post(uri, data, timeout, custom_headers=None, flags=None)

Makes post requests.

Args:

uri: URI of the resource. data: Request body of the call timeout: Time out for the request in seconds. custom_headers: Allows to add custom http headers. flags: Dictionary of filters, example: {‘name’: ‘name’}

Returns:

list: Returns ids of the affected resources.

do_put(uri, data, timeout, custom_headers=None)

Makes put requests.

Args:

uri: URI of the resource data: Request body of the call timeout: Time out for the request in seconds. custom_headers: Allows to set custom http headers.

Retuns:

list: Returns ids of the affected resources.

get_all(resource_url, members_field=None, pagination=False, page_size=0, limit=500, offset=0, sort=None, order='descending', filters=None, fields=None, case_sensitive=True, show_optional_fields=False)

Gets all resources.

Args:

resource_url: URL of the resource members_field: Name of the resource field(to fetch the resources from get call response) pagination: Default value is False, set to True if pagination is required page_size: Number of resources per page - mandatory field if pagination is on limit: A positive integer that represents the maximum number of results to return sort: The name of the field where the sort occurs order: The sort order preference, valid values: ascending or descending filters: Dictionary of filers, example: {‘name’: ‘name’} fields: A comma-separated list of fields to include in the returned objects. Default: all case_sensitive: An indicator that specifies if the filter and sort results

use a case-sensitive or insensitive manner. Default: True

show_optional_fields: An indicator to show or not show the ha_status,

ha_resynchronization_progress, hypervisor_virtual_machine_power_state, and hypervisor_is_template

Returns:

list/pagination object: Pagination object if pagination is on or list of resources

task_affected_resources(task, timeout)

Handles asynchronous calls.

Args:

task: Task data retunrned by a REST call timeout: Timeout value

Returns:

list: Returns ids of affected resources

simplivity.resources.resource.build_uri_with_query_string(base_url, kwargs)

Creates URL using base url and the parameters.

Args:

base_url: URL string. kwargs: Dictionary of parameters

Returns:

string: URL with query parameters

simplivity.resources.tasks module

Implements operations for task.

class simplivity.resources.tasks.Task(con, data)

Bases: object

Implements operations for task.

get_affected_resources()

Retrieve a resource associated with a task.

Args:

task: task dict

Returns:

list: list of resource ids

static get_current_seconds()

Returns current time.

is_task_running()

Check if a task is running according to: TASK_PENDING_STATES

Returns:

True when in TASK_PENDING_STATES; False when not.

update_status()

Retrieve a task by its uri.

Returns:

task dict

wait_for_task(timeout=- 1)

Wait for task execution and return affected resources.

Args:

timeout: timeout in seconds

Returns:

list: Affected resources when creating or updating

simplivity.resources.virtual_machines module

Implements features available for Virtual Machine resource.

class simplivity.resources.virtual_machines.VirtualMachine(connection, resource_client, data)

Bases: object

Implements features available for a single VM.

clone(new_vm_name, app_consistent=False, datastore=None, timeout=- 1)

Clones a virtual machine.

Args:

new_vm_name: The name of the virtual_machine created from this action. app_consistent: An indicator to show if the backup represents a snapshot

of a virtual machine with data that was first flushed to disk.

datastore: Object/name of the datastore.

if passed, new VM will be moved to the datastore.

timeout: Time out for the request in seconds.

Returns:

object: Object of the new VM

create_backup(backup_name, cluster=None, app_consistent=False, consistency_type=None, retention=0, timeout=- 1)

Backs up a virtual machine.

Args:

backup_name: The name of the new backup created from this action. cluster: Destination OmnistackCluster object/name. app_consistent: An indicator to show if the backup represents

a snapshot of a virtual machine with data that was first flushed to disk.

consistency_type: The consistency type of the backup. retention: The number of minutes to keep backups. timeout: Time out for the request in seconds.

Returns:

Backup object: object of the newly created backup.

get_backups()

Retrieves all backups associated with this virtual_machine.

Returns:

list: List of backup objects

get_metrics(time_offset=0, range=43200, resolution='MINUTE')

Retrieves throughput, IOPS, and latency data for the virtual machine

Args:

time_offset: A time offset in seconds (from now) or a datetime,

expressed in ISO-8601 form, based on Coordinated Universal Time (UTC) Default: 0

range: A range in seconds (the duration from the specified point in time) Default: 43200 resolution: The resolution (SECOND, MINUTE, HOUR, or DAY) Default: MINUTE

Returns:

dict: Dictionary of metrics object.

move(new_vm_name, datastore, timeout=- 1)

Moves a virtual machine to another datastore.

Args:

new_vm_name: Name of the new vm datastore: Object/name of the destination datastore timeout: Time out for the request in seconds.

Returns:

VirtualMachine object: Object of the moved VM

power_off(timeout=- 1)

Power off virtual machine.

Args:

timeout: Time out for the request in seconds.

Returns:

self: Returns the same object.

power_on(timeout=- 1)

Power on virtual machine.

Args:

timeout: Time out for the request in seconds.

Returns:

self: Returns True if successfully power on the VM else False.

set_backup_parameters(guest_username, guest_password, override_guest_validation=False, app_aware_type=None, timeout=- 1)

Set the virtual machine backup parameters used for application consistent backups.

Args:

guest_username: Username of the virtual machine. guest_password: Password of the virtual machine. override_guest_validation: Set to true to disable virtual machine validation logic. app_aware_type: Set the application aware backup type:

VSS - Application-consistentbackup using Microsoft VSS DEFAULT - Crash-consistent NONE - Application-consistent backup using a VMware snapshot

timeout: Time out for the request in seconds.

Returns:

self: Returns the same object.

set_policy(policy, timeout=- 1)

Sets the backup policy for virtual machine.

Args:

policy: Policy object/name timeout: Time out for the request in seconds.

Returns:

self: Returns the same object.

validate_backup_credentials(guest_username, guest_password, timeout=- 1)

Validates the credentials for the virtual machine want to backup.

Args:

guest_username: Username of the virtual machine. guest_password: Password of the virtual machine. timeout: Time out for the request in seconds.

Returns:

status: Possible values are ‘VALID’, ‘INVALID’.

class simplivity.resources.virtual_machines.VirtualMachines(connection)

Bases: simplivity.resources.resource.ResourceBase

Implements features for SympliVity VM resources.

get_all(pagination=False, page_size=0, limit=500, offset=0, sort=None, order='descending', filters=None, fields=None, case_sensitive=True, show_optional_fields=False)

Get all vms.

Args:

pagination: True if need pagination page_size: Size of the page (Required when pagination is on) limit: A positive integer that represents the maximum number of results to return offset: A positive integer that directs the service to start returning

the <offset value> instance, up to the limit.

sort: The name of the field where the sort occurs. order: The sort order preference. Valid values: ascending or descending. filters: Dictionary with filter values. Example: {‘name’: ‘name’}

id: The unique identifier (UID) of the virtual_machines to return

Accepts: Single value, comma-separated list

name: The name of the virtual_machines to return

Accepts: Single value, comma-separated list, pattern using one or more asterisk characters as a wildcard

omnistack_cluster_id: The unique identifier (UID) of the omnistack_cluste

that is associated with the instances to return Accepts: Single value, comma-separated list

omnistack_cluster_name: The name of the omnistack_cluster that

is associated with the instances to return. Accepts: Single value, comma-separated list.

compute_cluster_parent_hypervisor_object_id: The unique identifier (UID)

of the hypervisor that contains the omnistack_cluster that is associated with the instances to return Accepts: Single value, comma-separated list.

compute_cluster_parent_name: The name of the hypervisor that contains the

omnistack_cluster that is associated with the instances to return Accepts: Single value, comma-separated list

hypervisor_management_system: The IP address of the hypervisor associated

with the virtual machine. Accepts: Single value, comma-separated list, pattern using one or more asterisk characters as a wildcard

hypervisor_management_system_name: The name of the hypervisor associated

with the virtual machine Accepts: Single value, comma-separated list, pattern using one or more asterisk characters as a wildcard

datastore_id: The unique identifier (UID) of the datastore that is associated

with the instances to return Accepts: Single value, comma-separated list

datastore_name: The name of the datastore that is associated with the

instances to return Accepts: Single value, comma-separated list

policy_id: The unique identifier (UID) of the policy that is associated

with the instances to return Accepts: Single value, comma-separated list

policy_name: The name of the policy that is associated with the instances to return

Accepts: Single value, comma-separated list

hypervisor_object_id: The unique identifier (UID) of the hypervisor-based instance

that is associated with the instances to return Accepts: Single value, comma-separated list

created_after: The earliest creation time after the virtual machines to return were

created, expressed in ISO-8601 form, based on Coordinated Universal Time (UTC)

created_before: The latest creation time before the virtual machines to return were

created, expressed in ISO-8601 form, based on Coordinated Universal Time (UTC)

state: The state of the virtual_machine that is associated with the instances to return

Accepts: Single value, comma-separated list

app_aware_vm_status: The status of the ability of the virtual machine to take

an application-consistent backup that uses Microsoft VSS Accepts: Single value, comma-separated list

hypervisor_is_template: An indicator that shows if the virtual machine is a template. host_id: The unique identifier (UID) of the virtual_machine host.

fields: A comma-separated list of fields to include in the returned objects case_sensitive: An indicator that specifies if the filter and sort results

use a case-sensitive or insensitive manner.

show_optional_fields: An indicator to show or not show the ha_status,

ha_resynchronization_progress, hypervisor_virtual_machine_power_state, and hypervisor_is_template.

Returns:

list/pagination object: list of VirtualMachine objects/ Pagination object

get_by_data(data)

Gets VM object from VM data.

Args:

data: VM data

Returns:

object: Virtual Machine object.

policy_impact_report(policy, vms, timeout=- 1)

Generate a backup impact reported based on proposed application of a policy to one or more virtual machines.

Args:

policy: Policy object/name vms: List of vm objects timeout: Time out for the request in seconds.

Returns:

dict: Returns the dictionary for impact report of policy applied on virtual machines.

set_policy_for_multiple_vms(policy, vms, timeout=- 1)

Sets the backup policy for virtual machines.

Args:

vms: list of vm objects policy: policy object

Module contents