Pure1 Reference

Client

class pypureclient.pure1.Client(**kwargs)

Initialize a Pure1 Client.

Keyword Arguments

• version (str, optional) – REST API version to use. Defaults to the most recent version.

• app_id (str, optional) – The registered App ID for Pure1 to use. Defaults to the set environment variable under PURE1_APP_ID.

• id_token (str, optional) – The ID token to use. Overrides given App ID and private key. Defaults to environment variable set under PURE1_ID_TOKEN.

• private_key_file (str, optional) – The path of the private key to use. Defaults to the set environment variable under PURE1_PRIVATE_KEY_FILE.

• private_key_password (str, optional) – The password of the private key, if encrypted. Defaults to the set environment variable under PURE1_PRIVATE_KEY_FILE. Defaults to None.

• retries (int, optional) – The number of times to retry an API call if it failed for a non-blocking reason. Defaults to 5.

• timeout (float or (float, float), optional) – The timeout duration in seconds, either in total time or (connect and read) times. Defaults to 15.0 total.

Raises

PureError – If it could not create an ID or access token

Properties

Property

class pypureclient.pure1.Property(value)

A Property object models a property of a resource and allows for easy compounding, sorting, and filtering with them. It is converted to a string when calling any API and can also be replaced by a string.

__add__(other)

The + operator. Create a subproperty.

Parameters

other (Property) – The Property to be the subproperty of the given Property.

Returns

Property

Raises

PureError – If other is not of the proper type.

__eq__(other)

The == operator. Create a Filter that checks for equality.

Parameters

other (str, int, bool) – The value to compare to.

Returns

Filter

Raises

PureError – If other is not of the proper type.

__ge__(other)

The >= operator. Create a Filter that checks for greater than or equal.

Parameters

other (str, int) – The value to compare to.

Returns

Filter

Raises

PureError – If other is not of the proper type.

__getitem__(index)

The [] operator. Create a list Property with the given index.

Parameters

index (str) – The list index to use.

Returns

Property

Raises

PureError – If index is not “all” or “any”.

__gt__(other)

The > operator. Create a Filter that checks for greater than.

Parameters

other (str, int) – The value to compare to.

Returns

Filter

Raises

PureError – If other is not of the proper type.

__init__(value)

Initialize a Property.

Parameters

value (str) – The name of the property.

__le__(other)

The <= operator. Create a Filter that checks for less than or equal.

Parameters

other (str, int) – The value to compare to.

Returns

Filter

Raises

PureError – If other is not of the proper type.

__lt__(other)

The < operator. Create a Filter that checks for less than.

Parameters

other (str, int) – The value to compare to.

Returns

Filter

Raises

PureError – If other is not of the proper type.

__ne__(other)

The != operator. Create a Filter that checks for inequality.

Parameters

other (str, int, bool) – The value to compare to.

Returns

Filter

Raises

PureError – If other is not of the proper type.

__repr__()

Return the string value of the Property.

Returns

str

all()

Create a list Property indexed by “all”.

Returns

Property

any()

Create a list Property indexed by “any”.

Returns

Property

ascending()

Create a Property that can be sorted in ascending order.

Returns

Property

descending()

Create a property that can be sorted in descending order.

Returns

Property

exists()

Create a Filter that checks for existance of the given Property.

Returns

Filter

subproperty(other)

Create a subproperty.

Parameters

other (Property) – The Property to be the subproperty of the given Property.

Returns

Property

Raises

PureError – If other is not of the proper type.

Filter

class pypureclient.pure1.Filter(operation, operand1, operand2=None)

A Filter object models a filter string by keeping track of operations between Properties, values, and other Filters. It is converted to a string when calling any API and can also be replaced by a string.

__and__(other)

The & operator. Create a Filter that is the AND of two Filters.

Parameters

other (Filter) – The Filter to AND.

Returns

Filter

Raises

PureError – If other is not of the proper type.

__init__(operation, operand1, operand2=None)

Initialize a Filter. Should not be used directly. Instead, use the static methods to create Filters.

Parameters

• operation (_Operation) – The operation.

• operand1 (any) – The first operand.

• operand2 (any, optional) – The second operand, if the operation is binary. Defaults to None.

__invert__()

The ~ operator. Create a Filter that is the inverse of another Filter.

Returns

Filter

__or__(other)

The | operator. Create a Filter that is the OR of two Filters.

Parameters

other (Filter) – The Filter to OR.

Returns

Filter

Raises

PureError – If other is not of the proper type.

__repr__()

Return the string value of the Filter.

Returns

str

static and_(operand1, operand2)

Create a Filter that is the AND of two Filters.

Parameters

• operand1 (Filter) – The first Filter.

• operand2 (Filter) – The second Filter.

Returns

Filter

Raises

PureError – If either operand is not of the proper type.

static contains(operand1, operand2)

Create a Filter that checks for substring containment.

Parameters

• operand1 (Property, str) – The Property to check.

• operand2 (str) – The value to check for.

Returns

Filter

Raises

PureError – If either operand is not of the proper type.

static eq(operand1, operand2)

Create a Filter that checks for equality.

Parameters

• operand1 (Property, str) – The Property to compare.

• operand2 (str, int, bool) – The value to compare to.

Returns

Filter

Raises

PureError – If either operand is not of the proper type.

static exists(operand1)

Create a Filter that checks for existance of a Property.

Parameters

operand1 (Property, str) – The Property to check for.

Returns

Filter

Raises

PureError – If the operand is not of the proper type.

static ge(operand1, operand2)

Create a Filter that checks for greater than or equal.

Parameters

• operand1 (Property, str) – The Property to compare.

• operand2 (str, int) – The value to compare to.

Returns

Filter

Raises

PureError – If either operand is not of the proper type.

static gt(operand1, operand2)

Create a Filter that checks for greater than.

Parameters

• operand1 (Property, str) – The Property to compare.

• operand2 (str, int) – The value to compare to.

Returns

Filter

Raises

PureError – If either operand is not of the proper type.

static in_(operand1, operand2)

Create a Filter that checks if a Property is in a list of values.

Parameters

• operand1 (Property, str) – The Property to check.

• operand2 (list[str], list[int]) – The list of values.

Returns

Filter

Raises

PureError – If either operand is not of the proper type.

static le(operand1, operand2)

Create a Filter that checks for less than or equal.

Parameters

• operand1 (Property, str) – The Property to compare.

• operand2 (str, int) – The value to compare to.

Returns

Filter

Raises

PureError – If either operand is not of the proper type.

static lt(operand1, operand2)

Create a Filter that checks for less than.

Parameters

• operand1 (Property, str) – The Property to compare.

• operand2 (str, int) – The value to compare to.

Returns

Filter

Raises

PureError – If either operand is not of the proper type.

static ne(operand1, operand2)

Create a Filter that checks for inequality.

Parameters

• operand1 (Property, str) – The Property to compare.

• operand2 (str, int, bool) – The value to compare to.

Returns

Filter

Raises

PureError – If either operand is not of the proper type.

static not_(operand1)

Create a Filter that is the inverse of another Filter.

Parameters

operand1 (Filter) – The Filter to invert.

Returns

Filter

Raises

PureError – If the operand is not of the proper type.

static or_(operand1, operand2)

Create a Filter that is the OR of two Filters.

Parameters

• operand1 (Filter) – The first Filter.

• operand2 (Filter) – The second Filter.

Returns

Filter

Raises

PureError – If either operand is not of the proper type.

static tags(operand1, operand2)

Create a Filter that checks for a key-value tag.

Parameters

• operand1 (str) – The key of the tag.

• operand2 (str) – The value of the tag.

Returns

Filter

Raises

PureError – If either operand is not of the proper type.

Responses

ResponseHeaders

class pypureclient.pure1.ResponseHeaders(x_request_id, x_ratelimit_limit_second, x_ratelimit_limit_minute, x_ratelimit_remaining_second, x_ratelimit_remaining_minute)

An object that includes headers from the server response.

__init__(x_request_id, x_ratelimit_limit_second, x_ratelimit_limit_minute, x_ratelimit_remaining_second, x_ratelimit_remaining_minute)

Initialize a ResponseHeaders.

Parameters

• x_request_id (str) – The X-Request-ID from the client or generated by the server.

• x_ratelimit_limit_second (int) – The number of requests available per second.

• x_ratelimit_limit_minute (int) – The number of requests available per minute.

• x_ratelimit_remaining_second (int) – The number of requests remaining in that second.

• x_ratelimit_remaining_minute (int) – The number of requests remaining in that minute.

__repr__()

Return a pretty formatted string of the object.

Returns

str

to_dict()

Return a dictionary of the class attributes.

Returns

dict

ValidResponse

class pypureclient.pure1.ValidResponse(status_code, continuation_token, total_item_count, items, headers, total=None, more_items_remaining=None)

A response that indicates the request was successful and has the returned data.

__init__(status_code, continuation_token, total_item_count, items, headers, total=None, more_items_remaining=None)

Initialize a ValidResponse.

Parameters

• status_code (int) – The HTTP status code.

• continuation_token (str) – An opaque token to iterate over a collection of resources. May be None.

• total_item_count (int) – The total number of items available in the collection.

• items (ItemIterator) – An iterator over the items in the collection.

• headers (dict) – Response headers from the server.

__repr__()

Return a pretty formatted string of the object. Does not convert the items to a list of items by using the iterator.

Returns

str

to_dict()

Return a dictionary of the class attributes. It will convert the items to a list of items by exhausting the iterator. If any items were previously iterated, they will be missed.

Returns

dict

ApiError

class pypureclient.pure1.ApiError(context, message)

An object that models the error response from the server.

__init__(context, message)

Initialize an ApiError.

Parameters

• context (str) – The context in which the error occurred.

• message (str) – The error message.

__repr__()

Return a pretty formatted string of the object.

Returns

str

to_dict()

Return a dictionary of the class attributes.

Returns

dict

ErrorResponse

class pypureclient.pure1.ErrorResponse(status_code, errors, headers)

A response that indicates there was an error with the request and has the list of errors.

__init__(status_code, errors, headers)

Initialize an ErrorResponse.

Parameters

• status_code (int) – The HTTP status code.

• errors (list[ApiError]) – The list of errors encountered.

• headers (dict) – Response headers from the server.

__repr__()

Return a pretty formatted string of the object.

Returns

str

to_dict()

Return a dictionary of the class attributes.

Returns

dict

Models

Alert

class pypureclient.pure1.models.Alert(as_of=None, id=None, name=None, arrays=None, actual=None, category=None, closed=None, code=None, component_name=None, component_type=None, created=None, description=None, expected=None, knowledge_base_url=None, notified=None, origin=None, severity=None, state=None, summary=None, updated=None)

swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, id=None, name=None, arrays=None, actual=None, category=None, closed=None, code=None, component_name=None, component_type=None, created=None, description=None, expected=None, knowledge_base_url=None, notified=None, origin=None, severity=None, state=None, summary=None, updated=None)

Keyword Arguments

• as_of (int) – The freshness of the data (timestamp in millis since epoch).

• id (str) – A non-modifiable, globally unique ID chosen by the system.

• name (str) – A modifiable, locally unique name chosen by the user.

• arrays (list[FixedReferenceFqdn]) – The list of arrays where this resource exists. Many resources are on a single array, but some resources, such as pods, can be shared across multiple arrays.

• actual (str) – Actual condition at the time of the alert.

• category (str) – Category of the alert. Valid values are array, hardware, and software.

• closed (int) – Time when the alert was closed, in milliseconds since UNIX epoch.

• code (int) – Code associated with the alert.

• component_name (str) – Name of the component alerted about.

• component_type (str) – Type of the component alerted about.

• created (int) – Time when the alert was created, in milliseconds since UNIX epoch.

• description (str) – Short description of the alert.

• expected (str) – Expected state/threshold under normal conditions.

• knowledge_base_url (str) – URL of the relevant Knowledge Base page.

• notified (int) – Time when the user was notified of the alert, in milliseconds since UNIX epoch.

• origin (str) – Origin of the alert. Valid values are array and Pure1.

• severity (str) – Current severity level. Valid values are info, warning, critical, and hidden.

• state (str) – Current state of the alert. Valid values are open, closing, and closed.

• summary (str) – Summary of the alert.

• updated (int) – Time when the alert was last updated, in milliseconds since UNIX epoch.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Array

class pypureclient.pure1.models.Array(as_of=None, id=None, name=None, model=None, os=None, version=None, fqdn=None)

swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, id=None, name=None, model=None, os=None, version=None, fqdn=None)

Keyword Arguments

• as_of (int) – The freshness of the data (timestamp in millis since epoch).

• id (str) – A non-modifiable, globally unique ID chosen by the system.

• name (str) – A non-modifiable, locally unique name chosen by the system.

• model (str) – Model of the array.

• os (str) – Valid values are Elasticity, Purity, Purity//FA and Purity//FB.

• version (str) –

• fqdn (str) – The fully qualified domain name of the array.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Audit

class pypureclient.pure1.models.Audit(as_of=None, id=None, name=None, arrays=None, arguments=None, command=None, origin=None, subcommand=None, time=None, user=None)

swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, id=None, name=None, arrays=None, arguments=None, command=None, origin=None, subcommand=None, time=None, user=None)

Keyword Arguments

• as_of (int) – The freshness of the data (timestamp in millis since epoch).

• id (str) – A non-modifiable, globally unique ID chosen by the system.

• name (str) – A modifiable, locally unique name chosen by the user.

• arrays (list[FixedReferenceFqdn]) – The list of arrays where this resource exists. Many resources are on a single array, but some resources, such as pods, can be shared across multiple arrays.

• arguments (str) – Arguments provided to the command.

• command (str) – The command that was executed.

• origin (str) – Origin of the action. Valid values are array and Pure1.

• subcommand (str) – The subcommand that was executed.

• time (int) – Time at which the command was run in milliseconds since UNIX epoch.

• user (str) – The user who ran the command.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Bucket

class pypureclient.pure1.models.Bucket(as_of=None, id=None, name=None, arrays=None, account=None, created=None, destroyed=None, object_count=None, versioning=None)

swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, id=None, name=None, arrays=None, account=None, created=None, destroyed=None, object_count=None, versioning=None)

Keyword Arguments

• as_of (int) – The freshness of the data (timestamp in millis since epoch).

• id (str) – A non-modifiable, globally unique ID chosen by the system.

• name (str) – A modifiable, locally unique name chosen by the user.

• arrays (list[FixedReference]) – The list of arrays where this resource exists. Many resources are on a single array, but some resources, such as pods, can be shared across multiple arrays.

• account (FixedReference) –

• created (int) – Creation time of the bucket, in milliseconds since Unix epoch.

• destroyed (bool) – Returns a value of true if the bucket is destroyed, but not yet eradicated.

• object_count (int) – The number of objects contained within the bucket.

• versioning (str) – The versioning state for objects within the bucket. Valid values are none, enabled, and suspended.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

BucketReplicaLink

class pypureclient.pure1.models.BucketReplicaLink(as_of=None, id=None, lag=None, paused=None, recovery_point=None, status=None, status_details=None, members=None, sources=None, targets=None)

swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, id=None, lag=None, paused=None, recovery_point=None, status=None, status_details=None, members=None, sources=None, targets=None)

Keyword Arguments

• as_of (int) – The freshness of the data (timestamp in millis since epoch).

• id (str) – A non-modifiable, globally unique ID chosen by the system.

• lag (int) – Duration, in milliseconds, which represents how far behind the replication target is from the source.

• paused (bool) – Returns true if the replica link is paused.

• recovery_point (int) – Time when the last piece of data was replicated, in milliseconds since the UNIX epoch, and the recovery point of the bucket.

• status (str) – Status of the replica link. Values include replicating, idle, and unhealthy.

• status_details (str) – Detailed information about the status of the replica link when it is unhealthy.

• members (list[ResourceWithLocation]) – The union of source and target buckets in the replica link.

• sources (list[ResourceWithLocation]) – The source buckets in the replica link.

• targets (list[ResourceWithLocation]) – The target buckets in the replica link.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Blade

class pypureclient.pure1.models.Blade(as_of=None, id=None, name=None, arrays=None, details=None, raw_capacity=None, status=None)

swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, id=None, name=None, arrays=None, details=None, raw_capacity=None, status=None)

Keyword Arguments

• as_of (int) – The freshness of the data (timestamp in millis since epoch).

• id (str) – A non-modifiable, globally unique ID chosen by the system.

• name (str) – A non-modifiable, locally unique name chosen by the system.

• arrays (list[BladeArrayStatus]) – A list of arrays that contain this blade. Each blade should only exist on one array.

• details (str) – Extra details about the blade. Will be null if none exist.

• raw_capacity (float) – The raw storage capacity of the blade.

• status (str) – Valid values are critical, evacuated, evacuating, healthy, identifying, unclaimed, unhealthy, unknown, unrecognized.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Controller

class pypureclient.pure1.models.Controller(as_of=None, id=None, name=None, arrays=None, mode=None, model=None, status=None, type=None, version=None)

swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, id=None, name=None, arrays=None, mode=None, model=None, status=None, type=None, version=None)

Keyword Arguments

• as_of (int) – The freshness of the data (timestamp in millis since epoch).

• id (str) – A non-modifiable, globally unique ID chosen by the system.

• name (str) – A non-modifiable, locally unique name chosen by the system.

• arrays (list[FixedReferenceFqdn]) – The list of arrays where this resource exists. Many resources are on a single array, but some resources, such as pods, can be shared across multiple arrays.

• mode (str) – Mode of the controller. Values include not present, offline, primary, and secondary.

• model (str) – Model of the controller.

• status (str) – Status of the controller. Values include not ready, ready, unknown, and updating.

• type (str) – Type of the controller. Values include array_controller and shelf_controller.

• version (str) – Version of the controller.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

CurrentMetric

class pypureclient.pure1.models.CurrentMetric(data=None, metric=None, unit=None)

swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(data=None, metric=None, unit=None)

Keyword Arguments

• data (float) – The data value.

• metric (FixedReference) – A reference to the metric this data measures.

• unit (str) – The unit of the metric.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Drive

class pypureclient.pure1.models.Drive(as_of=None, id=None, name=None, arrays=None, capacity=None, details=None, protocol=None, status=None, type=None)

swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, id=None, name=None, arrays=None, capacity=None, details=None, protocol=None, status=None, type=None)

Keyword Arguments

• as_of (int) – The freshness of the data (timestamp in millis since epoch).

• id (str) – A non-modifiable, globally unique ID chosen by the system.

• name (str) – A non-modifiable, locally unique name chosen by the system.

• arrays (list[DriveArrayStatus]) – A list of arrays that contain this drive. Each drive should only exist on one array.

• capacity (float) – Physical storage capacity of the module (in bytes).

• details (str) – Details about the status of the module if status is not healthy.

• protocol (str) – Storage protocol of the module. Values include NVMe and SAS.

• status (str) – Current status of the module. Values include empty, failed, healthy, identifying, missing, recovering, unadmitted, unhealthy, unrecognized, and updating.

• type (str) – The type of the module. Values include cache, NVRAM, SSD, and virtual.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

FileSystem

class pypureclient.pure1.models.FileSystem(as_of=None, id=None, name=None, arrays=None, created=None, destroyed=None, fast_remove_directory_enabled=None, hard_limit_enabled=None, http=None, nfs=None, provisioned=None, smb=None, snapshot_directory_enabled=None)

swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, id=None, name=None, arrays=None, created=None, destroyed=None, fast_remove_directory_enabled=None, hard_limit_enabled=None, http=None, nfs=None, provisioned=None, smb=None, snapshot_directory_enabled=None)

Keyword Arguments

• as_of (int) – The freshness of the data (timestamp in millis since epoch).

• id (str) – A non-modifiable, globally unique ID chosen by the system.

• name (str) – A non-modifiable, locally unique name chosen by the system.

• arrays (list[FixedReferenceFqdn]) – The list of arrays where this resource exists. Many resources are on a single array, but some resources, such as pods, can be shared across multiple arrays.

• created (int) – Creation time in milliseconds since UNIX epoch.

• destroyed (bool) – Is the file system destroyed?

• fast_remove_directory_enabled (bool) – On a FlashBlade file system, returns the value of true if fast remove directory is enabled and false if it is not. On a FlashArray file system, the value is always null.

• hard_limit_enabled (bool) – On a FlashBlade file system, returns the value of true if the file system’s size is a hard limit quota and false if it is not. On a FlashArray file system, the value is always null.

• http (Http) – HTTP configuration. On a FlashArray file system, the value is always null.

• nfs (Nfs) – NFS configuration. On a FlashArray file system, the value is always null.

• provisioned (int) – The provisioned size of the file system in bytes. A value of 0 means unlimited. On a FlashArray file system, the value is always null.

• smb (Smb) – SMB configuration. On a FlashArray file system, the value is always null.

• snapshot_directory_enabled (bool) – On a FlashBlade file system, returns the value of true if snapshot directory is enabled and false if it is not. On a FlashArray file system, the value is always null.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

FileSystemReplicaLink

class pypureclient.pure1.models.FileSystemReplicaLink(as_of=None, id=None, lag=None, paused=None, recovery_point=None, status=None, status_details=None, members=None, sources=None, targets=None)

swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, id=None, lag=None, paused=None, recovery_point=None, status=None, status_details=None, members=None, sources=None, targets=None)

Keyword Arguments

• as_of (int) – The freshness of the data (timestamp in millis since epoch).

• id (str) – A non-modifiable, globally unique ID chosen by the system.

• lag (int) – Duration, in milliseconds, which represents how far behind the replication target is from the source.

• paused (bool) – Returns true if the replica link is paused.

• recovery_point (int) – Time when the last replicated snapshot was created, in milliseconds since the UNIX epoch. (i.e. the recovery point if the file system is promoted.)

• status (str) – Status of the replica link. Values include replicating, idle, and unhealthy.

• status_details (str) – Detailed information about the status of the replica link when it is unhealthy.

• members (list[ResourceWithLocation]) – The union of source and target file systems in the replica link.

• sources (list[ResourceWithLocation]) – The source file systems in the replica link.

• targets (list[ResourceWithLocation]) – The target file systems in the replica link.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

FileSystemSnapshot

class pypureclient.pure1.models.FileSystemSnapshot(as_of=None, id=None, name=None, arrays=None, created=None, destroyed=None, on=None, source=None, suffix=None)

swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, id=None, name=None, arrays=None, created=None, destroyed=None, on=None, source=None, suffix=None)

Keyword Arguments

• as_of (int) – The freshness of the data (timestamp in millis since epoch).

• id (str) – A non-modifiable, globally unique ID chosen by the system.

• name (str) – A non-modifiable, locally unique name chosen by the system.

• arrays (list[FixedReferenceFqdn]) – The list of arrays where this resource exists. Many resources are on a single array, but some resources, such as pods, can be shared across multiple arrays.

• created (int) – Creation time in milliseconds since UNIX epoch.

• destroyed (bool) – Indicates if this snapshot has been destroyed and is pending eradication.

• on (FixedReferenceFqdn) –

• source (FixedReference) – A reference to the file system that the snapshot was taken from.

• suffix (str) – Indicates the suffix of the snapshot.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Hardware

class pypureclient.pure1.models.Hardware(as_of=None, id=None, name=None, arrays=None, details=None, identify_enabled=None, model=None, serial=None, slot=None, speed=None, status=None, temperature=None, type=None, voltage=None)

swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, id=None, name=None, arrays=None, details=None, identify_enabled=None, model=None, serial=None, slot=None, speed=None, status=None, temperature=None, type=None, voltage=None)

Keyword Arguments

• as_of (int) – The freshness of the data (timestamp in millis since epoch).

• id (str) – A non-modifiable, globally unique ID chosen by the system.

• name (str) – A non-modifiable, locally unique name chosen by the system.

• arrays (list[FixedReferenceFqdn]) – The list of arrays where this resource exists. Many resources are on a single array, but some resources, such as pods, can be shared across multiple arrays.

• details (str) – Details about the component if status is not healthy.

• identify_enabled (bool) – If true, the ID light is lit to visually identify the component.

• model (str) – Model number of the hardware component.

• serial (str) – Serial number of the hardware component.

• slot (int) – Slot number occupied by the PCI Express card that hosts the component.

• speed (int) – Speed (in bytes per second) at which the component is operating.

• status (str) – Component status. Values include critical, healthy, identifying, unhealthy, unclaimed, unknown, unrecognized, and unused.

• temperature (int) – Temperature (in degrees Celsius) reported by the component.

• type (str) – Type of the hardware component. Values include am, chassis, controller, cooling, drive_bay, eth_port, fan, fc_port, flash_blade, ib_port, mgmt_port, nvram_bay, power_supply, sas_module, sas_port, storage_shelf, and temp_sensor.

• voltage (int) – Voltage (in Volts) reported by the component.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

HardwareConnector

class pypureclient.pure1.models.HardwareConnector(as_of=None, id=None, name=None, arrays=None, connector_type=None, lane_speed=None, port_count=None, transceiver_type=None)

swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, id=None, name=None, arrays=None, connector_type=None, lane_speed=None, port_count=None, transceiver_type=None)

Keyword Arguments

• as_of (int) – The freshness of the data (timestamp in millis since epoch).

• id (str) – A non-modifiable, globally unique ID chosen by the system.

• name (str) – A non-modifiable, locally unique name chosen by the system.

• arrays (list[FixedReferenceFqdn]) – The list of arrays where this resource exists. Many resources are on a single array, but some resources, such as pods, can be shared across multiple arrays.

• connector_type (str) – Form-factor of the interface. Values include QSFP and RJ-45.

• lane_speed (float) – Configured speed of each lane in the connector in bits per second.

• port_count (float) – Configured number of ports in the connector.

• transceiver_type (str) – Type of transceiver plugged into the connector port. If the type cannot be auto-detected and the internal user has not specified a type, the value will be Unknown. If nothing is plugged into the QSFP port, the value will be Unused. Transceiver type is not applicable for RJ-45 connectors.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Http

class pypureclient.pure1.models.Http(enabled=None)

swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(enabled=None)

Keyword Arguments

enabled (bool) – Is the protocol enabled?

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Invoice

class pypureclient.pure1.models.Invoice(amount=None, currency=None, _date=None, due_date=None, end_user_name=None, end_user_purchase_order=None, id=None, lines=None, partner_purchase_order=None, payment_terms=None, sales_representative=None, ship_date=None, status=None, subscription=None)

swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(amount=None, currency=None, _date=None, due_date=None, end_user_name=None, end_user_purchase_order=None, id=None, lines=None, partner_purchase_order=None, payment_terms=None, sales_representative=None, ship_date=None, status=None, subscription=None)

Keyword Arguments

• amount (float) – The total invoice amount, expressed in the currency defined in currency.

• currency (str) – The currency of the invoice in ISO 4217 format. This currency applies to the total invoice amount as well as all amounts in line items.

• _date (int) – The issuance date. Represented as a timestamp of 00:00 on that date in UTC, in milliseconds since UNIX epoch.

• due_date (int) – The payment due date. Represented as a timestamp of 00:00 on that date in UTC, in milliseconds since UNIX epoch.

• end_user_name (str) – The end user customer name.

• end_user_purchase_order (str) – The end user customer purchase order number.

• id (str) – The invoice number, a globally unique identifier for this invoice.

• lines (list[InvoiceLine]) – A list of invoice line items.

• partner_purchase_order (str) – The partner purchase order number.

• payment_terms (str) – The invoice payment terms.

• sales_representative (str) – The sales representative that issued the invoice.

• ship_date (int) – The invoice shipment date. Represented as a timestamp of 00:00 on that date in UTC, in milliseconds since UNIX epoch.

• status (str) – The invoice status. Values include open and paid.

• subscription (FixedReference) – A reference to which subscription this invoice belongs.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

LicenseResourceReference

class pypureclient.pure1.models.LicenseResourceReference(id=None, name=None, resource_type=None, fqdn=None, activation_time=None, usage=None)

swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(id=None, name=None, resource_type=None, fqdn=None, activation_time=None, usage=None)

Keyword Arguments

• id (str) – The opaque and unique id of this resource.

• name (str) – The name of this resource.

• resource_type (str) – The type of this resource represented by the name of its REST endpoint. For example, “arrays”, “network-interfaces”, and “metrics”. The value may be null if the resource is not represented.

• fqdn (str) – The fully qualified domain name of the appliance when resource_type is arrays, null otherwise.

• activation_time (int) – Time when the resource is activated under the license, in milliseconds since UNIX epoch.

• usage (CurrentMetric) – Current usage of the resource under the license.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

MarketplacePartner

class pypureclient.pure1.models.MarketplacePartner(name=None, reference_id=None)

swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, reference_id=None)

Keyword Arguments

• name (str) – Name or identifier of the marketplace parter who owns the reference ID.

• reference_id (str) – External ID the marketplace partner knows to refer to this license.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Metric

class pypureclient.pure1.models.Metric(as_of=None, id=None, name=None, availabilities=None, description=None, resource_types=None, unit=None)

swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, id=None, name=None, availabilities=None, description=None, resource_types=None, unit=None)

Keyword Arguments

• as_of (int) – The freshness of the data (timestamp in millis since epoch).

• id (str) – A non-modifiable, globally unique ID chosen by the system.

• name (str) – A non-modifiable, locally unique name chosen by the system.

• availabilities (list[MetricAvailability]) – The available resolutions, aggregations and retentions of this metric.

• description (str) – The additional description for the the metric.

• resource_types (list[str]) – The type of resource (as described by their endpoints) that this metric is available at. NOTE that a metric could be available for a combination of resource types, e.g. mirrored writes from “arrays” to “pods”.

• unit (str) – The unit of the metric.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

MetricAvailability

class pypureclient.pure1.models.MetricAvailability(aggregations=None, resolution=None, retention=None)

swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(aggregations=None, resolution=None, retention=None)

Keyword Arguments

• aggregations (list[str]) – Available aggregations for this metric at the given resolution, e.g. ‘avg’, ‘max’.

• resolution (int) – An available resolution of this metric in milliseconds.

• retention (int) – The retention at this given resolution in milliseconds.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

MetricHistory

class pypureclient.pure1.models.MetricHistory(as_of=None, id=None, name=None, aggregation=None, data=None, resolution=None, resources=None, unit=None)

swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, id=None, name=None, aggregation=None, data=None, resolution=None, resources=None, unit=None)

Keyword Arguments

• as_of (int) – The freshness of the data (timestamp in millis since epoch).

• id (str) – A non-modifiable, globally unique ID chosen by the system.

• name (str) – A non-modifiable, locally unique name chosen by the system.

• aggregation (str) – The aggregation of the metric data.

• data (list[list[float]]) – The data points of the metric corresponding to the time window, resolution and aggregation. The points are returned in a nested array of 2-element arrays. For each of the 2-element array, the 1st element is the UTC millisecond epoch, and the 2nd element is the value, e.g. [[1519362000000, 11], [1519362030000, 21], …].

• resolution (int) – The resolution of the metric data in milliseconds.

• resources (list[FixedReferenceFqdn]) –

• unit (str) – The unit of the metric data.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

NetworkInterface

class pypureclient.pure1.models.NetworkInterface(as_of=None, id=None, name=None, arrays=None, address=None, enabled=None, gateway=None, hwaddr=None, mtu=None, netmask=None, services=None, speed=None, subinterfaces=None)

swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, id=None, name=None, arrays=None, address=None, enabled=None, gateway=None, hwaddr=None, mtu=None, netmask=None, services=None, speed=None, subinterfaces=None)

Keyword Arguments

• as_of (int) – The freshness of the data (timestamp in millis since epoch).

• id (str) – A non-modifiable, globally unique ID chosen by the system.

• name (str) – A non-modifiable, locally unique name chosen by the system.

• arrays (list[FixedReferenceFqdn]) – The list of arrays where this resource exists. Many resources are on a single array, but some resources, such as pods, can be shared across multiple arrays.

• address (str) – IP address of this network interface.

• enabled (bool) –

• gateway (str) –

• hwaddr (str) – Hardware address.

• mtu (int) – Maximum transmission unit.

• netmask (str) –

• services (list[str]) – Services and protocols that are enabled on the interface.

• speed (int) – Speed in bytes per second.

• subinterfaces (list[str]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Nfs

class pypureclient.pure1.models.Nfs(enabled=None, rules=None)

swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(enabled=None, rules=None)

Keyword Arguments

• enabled (bool) – Is the protocol enabled?

• rules (str) – NFS rules.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ObjectStoreAccount

class pypureclient.pure1.models.ObjectStoreAccount(as_of=None, id=None, name=None, arrays=None, created=None, object_count=None)

swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, id=None, name=None, arrays=None, created=None, object_count=None)

Keyword Arguments

• as_of (int) – The freshness of the data (timestamp in millis since epoch).

• id (str) – A non-modifiable, globally unique ID chosen by the system.

• name (str) – A modifiable, locally unique name chosen by the user.

• arrays (list[FixedReference]) – The list of arrays where this resource exists. Many resources are on a single array, but some resources, such as pods, can be shared across multiple arrays.

• created (int) – Creation timestamp of the object, in milliseconds since Unix epoch.

• object_count (int) – The number of objects within the account.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Pod

class pypureclient.pure1.models.Pod(as_of=None, id=None, name=None, arrays=None, mediator=None, source=None)

swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, id=None, name=None, arrays=None, mediator=None, source=None)

Keyword Arguments

• as_of (int) – The freshness of the data (timestamp in millis since epoch).

• id (str) – A non-modifiable, globally unique ID chosen by the system.

• name (str) – A modifiable, locally unique name chosen by the user.

• arrays (list[FixedReferenceFqdn]) – The list of arrays where this resource exists. Many resources are on a single array, but some resources, such as pods, can be shared across multiple arrays.

• mediator (str) – The URL of the mediator for this pod.

• source (FixedReference) – A reference to the source pod of a pod clone.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

PodArrayStatus

class pypureclient.pure1.models.PodArrayStatus(id=None, name=None, resource_type=None, frozen_at=None, mediator_status=None, status=None)

swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(id=None, name=None, resource_type=None, frozen_at=None, mediator_status=None, status=None)

Keyword Arguments

• id (str) – The opaque and unique id of this resource.

• name (str) – The name of this resource.

• resource_type (str) – The type of this resource represented by the name of its REST endpoint. For example, “arrays”, “network-interfaces”, and “metrics”. The value may be null if the resource is not represented.

• frozen_at (int) – The Unix timestamp of when the array was last in sync with the pod (or null if the array is currently in sync).

• mediator_status (str) – The status of the mediator as assessed by this array. Valid values are flummoxed, online, unknown, and unreachable. flummoxed - The array has the wrong UUID for the mediator. This means that the array can reach a mediator, but is talking to the wrong one. Typically, this would be due to a misconfiguration in the customer environment (e.g. DNS misconfiguration). UUIDs also have a TTL. If a pod goes offline on one array, and stays like that for weeks (such that the TTL expires), it may also show this status until the peer array is reachable again. online - The array is successfully communicating with the mediator. unreachable - The array cannot reach the mediator. This could be due to a network issue or the mediator is down.

• status (str) – Status of an array in the pod. Valid values are offline, online, resyncing, and unknown. offline - There is a problem. This array cannot confirm it has the latest data for this pod. This array can not handle IO to the pod nor could it take over during an HA event. online - Everything is fine. This array has the latest data for this pod. This array can handle IO to the pod and can take over during an HA event. resyncing - There was a problem. This array is actively catching up to get the latest data for this pod. This array can handle IO to this pod’s volumes, however it could not take over during an HA event. unknown - The state of the pod on this array cannot be determined. This state is only seen on disconnected arrays. The disconnected array cannot determine if the pod on another array is online or offline.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

PodReplicaLink

class pypureclient.pure1.models.PodReplicaLink(as_of=None, id=None, lag=None, paused=None, recovery_point=None, status=None, members=None, sources=None, targets=None)

swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, id=None, lag=None, paused=None, recovery_point=None, status=None, members=None, sources=None, targets=None)

Keyword Arguments

• as_of (int) – The freshness of the data (timestamp in millis since epoch).

• id (str) – A non-modifiable, globally unique ID chosen by the system.

• lag (int) – Duration, in milliseconds, which represents how far behind the replication target is from the source.

• paused (bool) – Returns true if the replica link is paused.

• recovery_point (int) – Time when the last piece of data was replicated, in milliseconds since the UNIX epoch, and the recovery point if the target pod is promoted. If the pod is currently baselining then the value is null.

• status (str) – Status of the replica link. Values include replicating, idle, baselining, paused, quiescing, quiesced, and unhealthy.

• members (list[ResourceWithLocations]) – The union of source and target pods in the replica link.

• sources (list[ResourceWithLocations]) – The source pods in the replica link.

• targets (list[ResourceWithLocations]) – The target pods in the replica link.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Policy

class pypureclient.pure1.models.Policy(as_of=None, id=None, name=None, arrays=None, enabled=None, rules=None)

swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, id=None, name=None, arrays=None, enabled=None, rules=None)

Keyword Arguments

• as_of (int) – The freshness of the data (timestamp in millis since epoch).

• id (str) – A non-modifiable, globally unique ID chosen by the system.

• name (str) – A non-modifiable, locally unique name chosen by the system.

• arrays (list[FixedReferenceFqdn]) – The list of arrays where this resource exists. Many resources are on a single array, but some resources, such as pods, can be shared across multiple arrays.

• enabled (bool) – Returns true if this policy is enabled.

• rules (list[PolicyRule]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

PolicyMember

class pypureclient.pure1.models.PolicyMember(as_of=None, policy=None, member=None)

swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, policy=None, member=None)

Keyword Arguments

• as_of (int) – The freshness of the data (timestamp in millis since epoch).

• policy (FixedReference) –

• member (FixedReference) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

PolicyRule

class pypureclient.pure1.models.PolicyRule(at=None, every=None, keep_for=None, time_zone=None)

swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(at=None, every=None, keep_for=None, time_zone=None)

Keyword Arguments

• at (int) – Time of day to take the snapshot, in milliseconds since 00:00 in the specified time_zone. Only valid if every is set as whole days.

• every (int) – How often to take snapshots, in milliseconds.

• keep_for (int) – How long to keep snapshots, in milliseconds.

• time_zone (str) – The time zone in which the at rule is applied.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ResourceWithLocation

class pypureclient.pure1.models.ResourceWithLocation(id=None, name=None, resource_type=None, location=None)

swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(id=None, name=None, resource_type=None, location=None)

Keyword Arguments

• id (str) – The opaque and unique id of this resource.

• name (str) – The name of this resource.

• resource_type (str) – The type of this resource represented by the name of its REST endpoint. For example, “arrays”, “network-interfaces”, and “metrics”. The value may be null if the resource is not represented.

• location (FixedReferenceFqdn) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Port

class pypureclient.pure1.models.Port(as_of=None, id=None, name=None, arrays=None, iqn=None, nqn=None, wwn=None, portal=None, failover=None)

swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, id=None, name=None, arrays=None, iqn=None, nqn=None, wwn=None, portal=None, failover=None)

Keyword Arguments

• as_of (int) – The freshness of the data (timestamp in millis since epoch).

• id (str) – A non-modifiable, globally unique ID chosen by the system.

• name (str) – A non-modifiable, locally unique name chosen by the system.

• arrays (list[FixedReferenceFqdn]) – The list of arrays where this resource exists. Many resources are on a single array, but some resources, such as pods, can be shared across multiple arrays.

• iqn (str) – The iSCSI Qualified Name if the port is iSCSI, null otherwise.

• nqn (str) – The NVMe Qualified Name if the port is NVMe-oF, null otherwise.

• wwn (str) – The Fibre Channel World Wide Name if the port is Fibre Channel, null otherwise.

• portal (str) – The IP and port number if the port is iSCSI or NVMe-oF, null otherwise.

• failover (str) – If the array port has failed over, returns the name of the port to which this port has failed over.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Subscription

class pypureclient.pure1.models.Subscription(as_of=None, id=None, name=None, expiration_date=None, service=None, start_date=None, status=None, initial_name=None, last_updated_date=None, organization=None, partner_name=None, subscription_term=None)

swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, id=None, name=None, expiration_date=None, service=None, start_date=None, status=None, initial_name=None, last_updated_date=None, organization=None, partner_name=None, subscription_term=None)

Keyword Arguments

• as_of (int) – The freshness of the data (timestamp in millis since epoch).

• id (str) – A non-modifiable, globally unique ID chosen by the system.

• name (str) – A non-modifiable, locally unique name chosen by the system.

• expiration_date (int) – Date when the subscription expires. Represented as a timestamp of 00:00 on that date in UTC, in milliseconds since UNIX epoch.

• service (str) – The service type of the subscription. Values include Evergreen//One, Evergreen//Flex, FlashStack as a Service, Storage as a Service, PaaS (Block Storage Service), PaaS (File and Object Storage Service), PaaS (Data Protection Service), and Pure1 Subscription.

• start_date (int) – Date when the subscription starts. Represented as a timestamp of 00:00 on that date in UTC, in milliseconds since UNIX epoch.

• status (str) – Current status of the subscription. Values include active, terminated, poc-expired, and signed.

• initial_name (str) – A non-modifiable, locally unique name that the subscription was started with, never changes.

• last_updated_date (int) – The date of the last amendment to the current subscription. Represented as a timestamp of 00:00 on that date in UTC, in milliseconds since UNIX epoch.

• organization (FixedReference) – The Pure1 organization for the subscription.

• partner_name (str) – The partner who invoices for the subscription.

• subscription_term (int) – Length of the subscription in months.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SubscriptionLicense

class pypureclient.pure1.models.SubscriptionLicense(as_of=None, id=None, name=None, average_on_demand=None, expiration_date=None, marketplace_partner=None, reservation=None, resources=None, service_tier=None, start_date=None, subscription=None, usage=None, last_updated_date=None, pre_ratio=None, quarter_on_demand=None, site_address=None)

swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, id=None, name=None, average_on_demand=None, expiration_date=None, marketplace_partner=None, reservation=None, resources=None, service_tier=None, start_date=None, subscription=None, usage=None, last_updated_date=None, pre_ratio=None, quarter_on_demand=None, site_address=None)

Keyword Arguments

• as_of (int) – The freshness of the data (timestamp in millis since epoch).

• id (str) – A non-modifiable, globally unique ID chosen by the system.

• name (str) – A non-modifiable, locally unique name chosen by the system.

• average_on_demand (CurrentMetric) – Estimated daily on-demand usage of the license from the current calendar quarter to date.

• expiration_date (int) – Date when the license expires. Represented as a timestamp of 00:00 on that date in UTC, in milliseconds since UNIX epoch.

• marketplace_partner (MarketplacePartner) – Reference information about the marketplace partner of this license.

• reservation (CurrentMetric) – Current reservation amount of the license.

• resources (list[LicenseResourceReference]) –

• service_tier (str) – The tier of the service for the license.

• start_date (int) – Date when the license starts. Represented as a timestamp of 00:00 on that date in UTC, in milliseconds since UNIX epoch.

• subscription (FixedReference) – A reference to which subscription this license belongs.

• usage (CurrentMetric) – Usage of the license, averaged over the last day.

• last_updated_date (int) – The date of the last amendment to the current license. Represented as a timestamp of 00:00 on that date in UTC, in milliseconds since UNIX epoch.

• pre_ratio (object) – The pre-reduced & encrypted ratio calculated at license level.

• quarter_on_demand (CurrentMetric) – Estimated total on-demand usage of the license of the current calendar quarter to date.

• site_address (BaseAddress) – The license site address.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SubscriptionAsset

class pypureclient.pure1.models.SubscriptionAsset(as_of=None, id=None, name=None, activation_date=None, array=None, end_of_life_date=None, install_address=None, license=None, subscription=None)

swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, id=None, name=None, activation_date=None, array=None, end_of_life_date=None, install_address=None, license=None, subscription=None)

Keyword Arguments

• as_of (int) – The freshness of the data (timestamp in millis since epoch).

• id (str) – A non-modifiable, globally unique ID chosen by the system.

• name (str) – A non-modifiable, locally unique name chosen by the system.

• activation_date (int) – The date when the appliance is activated under the license. Represented as a timestamp of 00:00 on that date in UTC, in milliseconds since UNIX epoch.

• array (SubscriptionAssetArray) –

• end_of_life_date (int) – The date when the appliance hardware reach end of life and Pure no longer provide support. Represented as a timestamp of 00:00 on that date in UTC, in milliseconds since UNIX epoch.

• install_address (BaseAddress) – The address where the appliance is installed. This address is also where replacement parts will be shipped to.

• license (FixedReference) – A reference to which license this appliance belongs.

• subscription (FixedReference) – A reference to which subscription this appliance belongs.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SustainabilityArray

class pypureclient.pure1.models.SustainabilityArray(as_of=None, id=None, name=None, assessment=None, install_address=None, reporting_status=None)

swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, id=None, name=None, assessment=None, install_address=None, reporting_status=None)

Keyword Arguments

• as_of (int) – The freshness of the data (timestamp in millis since epoch).

• id (str) – A non-modifiable, globally unique ID chosen by the system.

• name (str) – A non-modifiable, locally unique name chosen by the system.

• assessment (SustainabilityAssessment) –

• install_address (InstallAddress) – The address where the array is installed. This address is also where replacement parts will be shipped to.

• reporting_status (str) – Enum value that describes what is the status of the latest assessment. Valid values include: not_enough_data - There was not enough data to calculate assessment level of the appliance. unsupported_purity_version - The appliance is running an unsupported version of Purity operating system. It is an old Purity version which does not provide enough data for assessing the sustainability metrics. not_phoning_home - The appliance has not phoned home for more than 7 days so the assessment level was not calculated assessment_ready - Assessment is ready and it is available under assessment field.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SustainabilityAssessment

class pypureclient.pure1.models.SustainabilityAssessment(as_of=None, interval_start=None, interval_end=None, shelves=None, chassis=None, blades=None, rack_units=None, capacity_utilization=None, array_data_reduction=None, array_total_load=None, power_typical_spec=None, power_peak_spec=None, power_average=None, heat_typical_spec=None, heat_peak_spec=None, heat_average=None, power_per_used_space=None, power_per_usable_capacity=None, assessment_level=None)

swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, interval_start=None, interval_end=None, shelves=None, chassis=None, blades=None, rack_units=None, capacity_utilization=None, array_data_reduction=None, array_total_load=None, power_typical_spec=None, power_peak_spec=None, power_average=None, heat_typical_spec=None, heat_peak_spec=None, heat_average=None, power_per_used_space=None, power_per_usable_capacity=None, assessment_level=None)

Keyword Arguments

• as_of (int) – The freshness of the data (timestamp in millis since epoch).

• interval_start (int) – The timestamp of the start of the time interval.

• interval_end (int) – The timestamp of the end of the time interval.

• shelves (int) – The number of expansion shelves of the FlashArray appliance. It is always zero for FlashBlade appliances.

• chassis (int) – The number of chassis of the appliance, always one for FlashArray appliances.

• blades (int) – The number of blades of the FlashBlade appliance, always zero for FlashArray appliances.

• rack_units (int) – The total number of rack units occupied by the appliance.

• capacity_utilization (float) – The percentage of the used capacity. Average over the assessment window.

• array_data_reduction (float) – The data reduction ratio of the appliance. Average over the assessment window.

• array_total_load (float) – The load percentage. Average over the assessment window.

• power_typical_spec (float) – The typical power consumption of the appliance in Watts. The value is derived from benchmark data and remains static for the model and configuration.

• power_peak_spec (float) – The peak power consumption of the appliance in Watts. The value is derived from benchmark data and remains static for the model and configuration.

• power_average (float) – The average of power consumption of the appliance. Average over the assessment window.

• heat_typical_spec (float) – The typical heat production of the appliance in BTU/hr. The value is derived from benchmark data and remains static for the model and configuration.

• heat_peak_spec (float) – The peak heat production of the appliance in BTU/hr. The value is derived from benchmark data and remains static for the model and configuration.

• heat_average (float) – The average of heat production of the appliance in BTU/Hr. Average over the assessment window.

• power_per_used_space (float) – The average of power consumption per TiB of used space.

• power_per_usable_capacity (float) – The average of power consumption per TiB of usable capacity.

• assessment_level (str) – The assessment level of an appliance. Valid values include: good - The assessment level of appliance is GOOD - all green. recommendation - There are some actions that can be done to bring appliance to a GOOD level. action_required - The lowest level of assessment. Some actions are required to improve the assessment level.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SustainabilityInsightArray

class pypureclient.pure1.models.SustainabilityInsightArray(as_of=None, interval_start=None, interval_end=None, additional_data=None, resource=None, severity=None, type=None)

swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, interval_start=None, interval_end=None, additional_data=None, resource=None, severity=None, type=None)

Keyword Arguments

• as_of (int) – The freshness of the data (timestamp in millis since epoch).

• interval_start (int) – The timestamp of the start of the time interval.

• interval_end (int) – The timestamp of the end of the time interval.

• additional_data (object) – The arbitrary data associated with the insight.

• resource (FixedReferenceFqdn) –

• severity (str) – The severity of the insight. Should be one of medium, high.

• type (str) – The type of the insight.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Smb

class pypureclient.pure1.models.Smb(enabled=None)

swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(enabled=None)

Keyword Arguments

enabled (bool) – Is the protocol enabled?

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Tag

class pypureclient.pure1.models.Tag(key=None, namespace=None, resource=None, tag_organization_id=None, value=None)

swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(key=None, namespace=None, resource=None, tag_organization_id=None, value=None)

Keyword Arguments

• key (str) – Key of the tag.

• namespace (str) – Namespace of the tag. Namespace identifies the category of the tag.

• resource (FixedReference) –

• tag_organization_id (int) – Org id of the tag.

• value (str) – Value of the tag.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Target

class pypureclient.pure1.models.Target(as_of=None, id=None, name=None, arrays=None, address=None, status=None, status_details=None)

swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, id=None, name=None, arrays=None, address=None, status=None, status_details=None)

Keyword Arguments

• as_of (int) – The freshness of the data (timestamp in millis since epoch).

• id (str) – A non-modifiable, globally unique ID chosen by the system.

• name (str) – A non-modifiable, locally unique name chosen by the system.

• arrays (list[FixedReferenceFqdn]) – The list of arrays where this resource exists. Many resources are on a single array, but some resources, such as pods, can be shared across multiple arrays.

• address (str) – IP address or FQDN of the target system.

• status (str) – Status of the connection. Values include connected and connecting.

• status_details (str) – Additional information describing any issues encountered when connecting, or null if the status is connected.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Volume

class pypureclient.pure1.models.Volume(as_of=None, id=None, name=None, arrays=None, created=None, destroyed=None, eradicated=None, pod=None, provisioned=None, serial=None, source=None)

swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, id=None, name=None, arrays=None, created=None, destroyed=None, eradicated=None, pod=None, provisioned=None, serial=None, source=None)

Keyword Arguments

• as_of (int) – The freshness of the data (timestamp in millis since epoch).

• id (str) – A non-modifiable, globally unique ID chosen by the system.

• name (str) – A modifiable, locally unique name chosen by the user.

• arrays (list[FixedReferenceFqdn]) – The list of arrays where this resource exists. Many resources are on a single array, but some resources, such as pods, can be shared across multiple arrays.

• created (int) – Creation time in milliseconds since UNIX epoch.

• destroyed (bool) – Whether this volume has been destroyed or not.

• eradicated (bool) – Whether this volume has been eradicated or not.

• pod (FixedReference) – A reference to the pod this volume belongs to, if applicable.

• provisioned (int) – Provisioned size of the volume in bytes.

• serial (str) – Serial number generated by Purity when the volume was created.

• source (FixedReference) – A reference to the volume this volume was cloned from, if applicable.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

VolumeSnapshot

class pypureclient.pure1.models.VolumeSnapshot(as_of=None, id=None, name=None, arrays=None, created=None, destroyed=None, pod=None, provisioned=None, on=None, serial=None, snapshot_group=None, source=None, suffix=None)

swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, id=None, name=None, arrays=None, created=None, destroyed=None, pod=None, provisioned=None, on=None, serial=None, snapshot_group=None, source=None, suffix=None)

Keyword Arguments

• as_of (int) – The freshness of the data (timestamp in millis since epoch).

• id (str) – A non-modifiable, globally unique ID chosen by the system.

• name (str) – A non-modifiable, locally unique name chosen by the system.

• arrays (list[FixedReferenceFqdn]) – The list of arrays where this resource exists. Many resources are on a single array, but some resources, such as pods, can be shared across multiple arrays.

• created (int) – Creation time in milliseconds since UNIX epoch.

• destroyed (bool) – Indicates if this snapshot has been destroyed and is pending eradication.

• pod (FixedReference) – A reference to the pod the source volume belongs to, if applicable.

• provisioned (int) – Indicates the size (in bytes) of the volume when the snapshot was taken.

• on (FixedReferenceFqdn) –

• serial (str) – Serial number generated by Purity when the snapshot was created.

• snapshot_group (FixedReference) – A reference to a consistency group snapshot that this snapshot is part of.

• source (FixedReference) – A reference to the volume that the snapshot was taken from.

• suffix (str) – Suffix added to the source volume name used to generate the volume snapshot name.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model