pypureclient.pure1.Pure1_1_0.models package

Submodules

pypureclient.pure1.Pure1_1_0.models.alert module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

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

Bases: object

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, name=None, id=None, arrays=None, severity=None, summary=None, actual=None, code=None, knowledge_base_url=None, created=None, notified=None, component_name=None, expected=None, origin=None, description=None, component_type=None, closed=None, state=None, category=None, updated=None)
Keyword Arguments

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

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

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

  • 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.

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

  • summary (str) – Summary of the alert.

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

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

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

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

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

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

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

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

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

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

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

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

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

  • 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

attribute_map = {'actual': 'actual', 'arrays': 'arrays', 'as_of': '_as_of', 'category': 'category', 'closed': 'closed', 'code': 'code', 'component_name': 'component_name', 'component_type': 'component_type', 'created': 'created', 'description': 'description', 'expected': 'expected', 'id': 'id', 'knowledge_base_url': 'knowledge_base_url', 'name': 'name', 'notified': 'notified', 'origin': 'origin', 'severity': 'severity', 'state': 'state', 'summary': 'summary', 'updated': 'updated'}
keys()
required_args = {}
swagger_types = {'actual': 'str', 'arrays': 'list[FixedReference]', 'as_of': 'int', 'category': 'str', 'closed': 'int', 'code': 'int', 'component_name': 'str', 'component_type': 'str', 'created': 'int', 'description': 'str', 'expected': 'str', 'id': 'str', 'knowledge_base_url': 'str', 'name': 'str', 'notified': 'int', 'origin': 'str', 'severity': 'str', 'state': 'str', 'summary': 'str', 'updated': 'int'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.alerts_get_response module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.alerts_get_response.AlertsGetResponse(continuation_token=None, total_item_count=None, items=None)

Bases: object

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__(continuation_token=None, total_item_count=None, items=None)
Keyword Arguments

  • continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

  • total_item_count (int) – Total number of items after applying filter params.

  • items (list[Alert]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
keys()
required_args = {}
swagger_types = {'continuation_token': 'str', 'items': 'list[Alert]', 'total_item_count': 'int'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.alerts_response module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.alerts_response.AlertsResponse(items=None)

Bases: object

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__(items=None)
Keyword Arguments

items (list[Alert]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'items': 'items'}
keys()
required_args = {}
swagger_types = {'items': 'list[Alert]'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.array module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

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

Bases: object

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, name=None, id=None, os=None, model=None, version=None)
Keyword Arguments

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

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

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

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

  • model (str) – Model of the array.

  • version (str) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'as_of': '_as_of', 'id': 'id', 'model': 'model', 'name': 'name', 'os': 'os', 'version': 'version'}
keys()
required_args = {}
swagger_types = {'as_of': 'int', 'id': 'str', 'model': 'str', 'name': 'str', 'os': 'str', 'version': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.array_get_response module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.array_get_response.ArrayGetResponse(continuation_token=None, total_item_count=None, items=None)

Bases: object

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__(continuation_token=None, total_item_count=None, items=None)
Keyword Arguments

  • continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

  • total_item_count (int) – Total number of items after applying filter params.

  • items (list[Array]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
keys()
required_args = {}
swagger_types = {'continuation_token': 'str', 'items': 'list[Array]', 'total_item_count': 'int'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.array_response module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.array_response.ArrayResponse(items=None)

Bases: object

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__(items=None)
Keyword Arguments

items (list[Array]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'items': 'items'}
keys()
required_args = {}
swagger_types = {'items': 'list[Array]'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.arrays module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.arrays.Arrays(arrays=None)

Bases: object

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__(arrays=None)
Keyword Arguments

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.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'arrays': 'arrays'}
keys()
required_args = {}
swagger_types = {'arrays': 'list[FixedReference]'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.arrays_built_in module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.arrays_built_in.ArraysBuiltIn(as_of=None, name=None, id=None, arrays=None)

Bases: object

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, name=None, id=None, arrays=None)
Keyword Arguments

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

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

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

  • 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.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'arrays': 'arrays', 'as_of': '_as_of', 'id': 'id', 'name': 'name'}
keys()
required_args = {}
swagger_types = {'arrays': 'list[FixedReference]', 'as_of': 'int', 'id': 'str', 'name': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.arrays_resource module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.arrays_resource.ArraysResource(as_of=None, name=None, id=None, arrays=None)

Bases: object

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, name=None, id=None, arrays=None)
Keyword Arguments

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

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

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

  • 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.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'arrays': 'arrays', 'as_of': '_as_of', 'id': 'id', 'name': 'name'}
keys()
required_args = {}
swagger_types = {'arrays': 'list[FixedReference]', 'as_of': 'int', 'id': 'str', 'name': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.audit module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

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

Bases: object

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, name=None, id=None, arrays=None, subcommand=None, origin=None, arguments=None, time=None, user=None, command=None)
Keyword Arguments

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

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

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

  • 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.

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

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

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

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

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

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'arguments': 'arguments', 'arrays': 'arrays', 'as_of': '_as_of', 'command': 'command', 'id': 'id', 'name': 'name', 'origin': 'origin', 'subcommand': 'subcommand', 'time': 'time', 'user': 'user'}
keys()
required_args = {}
swagger_types = {'arguments': 'str', 'arrays': 'list[FixedReference]', 'as_of': 'int', 'command': 'str', 'id': 'str', 'name': 'str', 'origin': 'str', 'subcommand': 'str', 'time': 'int', 'user': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.audits_get_response module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.audits_get_response.AuditsGetResponse(continuation_token=None, total_item_count=None, items=None)

Bases: object

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__(continuation_token=None, total_item_count=None, items=None)
Keyword Arguments

  • continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

  • total_item_count (int) – Total number of items after applying filter params.

  • items (list[Audit]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
keys()
required_args = {}
swagger_types = {'continuation_token': 'str', 'items': 'list[Audit]', 'total_item_count': 'int'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.audits_response module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.audits_response.AuditsResponse(items=None)

Bases: object

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__(items=None)
Keyword Arguments

items (list[Audit]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'items': 'items'}
keys()
required_args = {}
swagger_types = {'items': 'list[Audit]'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.blade module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

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

Bases: object

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, name=None, id=None, raw_capacity=None, details=None, arrays=None, status=None)
Keyword Arguments

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

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

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

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

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

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

  • 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

attribute_map = {'arrays': 'arrays', 'as_of': '_as_of', 'details': 'details', 'id': 'id', 'name': 'name', 'raw_capacity': 'raw_capacity', 'status': 'status'}
keys()
required_args = {}
swagger_types = {'arrays': 'list[BladeArrayStatus]', 'as_of': 'int', 'details': 'str', 'id': 'str', 'name': 'str', 'raw_capacity': 'float', 'status': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.blade_array_status module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.blade_array_status.BladeArrayStatus(name=None, resource_type=None, id=None, total_blades=None, used_blades=None)

Bases: object

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, resource_type=None, id=None, total_blades=None, used_blades=None)
Keyword Arguments

  • 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.

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

  • total_blades (int) – Count of total blade slots in the array.

  • used_blades (int) – Count of used blade slots in the array.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'id': 'id', 'name': 'name', 'resource_type': 'resource_type', 'total_blades': 'total_blades', 'used_blades': 'used_blades'}
keys()
required_args = {}
swagger_types = {'id': 'str', 'name': 'str', 'resource_type': 'str', 'total_blades': 'int', 'used_blades': 'int'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.blade_get_response module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.blade_get_response.BladeGetResponse(continuation_token=None, total_item_count=None, items=None)

Bases: object

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__(continuation_token=None, total_item_count=None, items=None)
Keyword Arguments

  • continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

  • total_item_count (int) – Total number of items after applying filter params.

  • items (list[Blade]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
keys()
required_args = {}
swagger_types = {'continuation_token': 'str', 'items': 'list[Blade]', 'total_item_count': 'int'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.blade_response module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.blade_response.BladeResponse(items=None)

Bases: object

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__(items=None)
Keyword Arguments

items (list[Blade]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'items': 'items'}
keys()
required_args = {}
swagger_types = {'items': 'list[Blade]'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.bucket module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

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

Bases: object

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, name=None, id=None, arrays=None, destroyed=None, versioning=None, created=None, object_count=None, account=None)
Keyword Arguments

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

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

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

  • 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.

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

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

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

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

  • account (FixedReference) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'account': 'account', 'arrays': 'arrays', 'as_of': '_as_of', 'created': 'created', 'destroyed': 'destroyed', 'id': 'id', 'name': 'name', 'object_count': 'object_count', 'versioning': 'versioning'}
keys()
required_args = {}
swagger_types = {'account': 'FixedReference', 'arrays': 'list[FixedReference]', 'as_of': 'int', 'created': 'int', 'destroyed': 'bool', 'id': 'str', 'name': 'str', 'object_count': 'int', 'versioning': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.bucket_get_response module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.bucket_get_response.BucketGetResponse(continuation_token=None, total_item_count=None, items=None)

Bases: object

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__(continuation_token=None, total_item_count=None, items=None)
Keyword Arguments

  • continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

  • total_item_count (int) – Total number of items after applying filter params.

  • items (list[Bucket]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
keys()
required_args = {}
swagger_types = {'continuation_token': 'str', 'items': 'list[Bucket]', 'total_item_count': 'int'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.bucket_response module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.bucket_response.BucketResponse(items=None)

Bases: object

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__(items=None)
Keyword Arguments

items (list[Bucket]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'items': 'items'}
keys()
required_args = {}
swagger_types = {'items': 'list[Bucket]'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.built_in_as_of module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.built_in_as_of.BuiltInAsOf(as_of=None, name=None, id=None)

Bases: object

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, name=None, id=None)
Keyword Arguments

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

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

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'as_of': '_as_of', 'id': 'id', 'name': 'name'}
keys()
required_args = {}
swagger_types = {'as_of': 'int', 'id': 'str', 'name': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.controller module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

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

Bases: object

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, name=None, id=None, arrays=None, mode=None, model=None, type=None, version=None, status=None)
Keyword Arguments

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

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

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

  • 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.

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

  • model (str) – Model of the controller.

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

  • version (str) – Version of the controller.

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'arrays': 'arrays', 'as_of': '_as_of', 'id': 'id', 'mode': 'mode', 'model': 'model', 'name': 'name', 'status': 'status', 'type': 'type', 'version': 'version'}
keys()
required_args = {}
swagger_types = {'arrays': 'list[FixedReference]', 'as_of': 'int', 'id': 'str', 'mode': 'str', 'model': 'str', 'name': 'str', 'status': 'str', 'type': 'str', 'version': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.controller_get_response module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.controller_get_response.ControllerGetResponse(continuation_token=None, total_item_count=None, items=None)

Bases: object

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__(continuation_token=None, total_item_count=None, items=None)
Keyword Arguments

  • continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

  • total_item_count (int) – Total number of items after applying filter params.

  • items (list[Controller]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
keys()
required_args = {}
swagger_types = {'continuation_token': 'str', 'items': 'list[Controller]', 'total_item_count': 'int'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.controller_response module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.controller_response.ControllerResponse(items=None)

Bases: object

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__(items=None)
Keyword Arguments

items (list[Controller]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'items': 'items'}
keys()
required_args = {}
swagger_types = {'items': 'list[Controller]'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.current_metric module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

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

Bases: object

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__(unit=None, data=None, metric=None)
Keyword Arguments

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

  • data (float) – The data value.

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'data': 'data', 'metric': 'metric', 'unit': 'unit'}
keys()
required_args = {}
swagger_types = {'data': 'float', 'metric': 'FixedReference', 'unit': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.directory module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.directory.Directory(as_of=None, name=None, id=None, arrays=None, path=None, destroyed=None, file_system=None, created=None, directory_name=None)

Bases: object

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, name=None, id=None, arrays=None, path=None, destroyed=None, file_system=None, created=None, directory_name=None)
Keyword Arguments

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

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

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

  • 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.

  • path (str) – Absolute path of the managed directory in the file system.

  • destroyed (bool) – Is the managed directory destroyed?

  • file_system (FixedReference) – The file system that this managed directory is in.

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

  • directory_name (str) – The managed directory name without the file system name prefix. A managed directory full name is constructed in the form of FILE_SYSTEM:DIR where FILE_SYSTEM is the file system name and DIR is the value of this field. On FlashArray versions below 6.0.2, the value is always null.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'arrays': 'arrays', 'as_of': '_as_of', 'created': 'created', 'destroyed': 'destroyed', 'directory_name': 'directory_name', 'file_system': 'file_system', 'id': 'id', 'name': 'name', 'path': 'path'}
keys()
required_args = {}
swagger_types = {'arrays': 'list[FixedReference]', 'as_of': 'int', 'created': 'int', 'destroyed': 'bool', 'directory_name': 'str', 'file_system': 'FixedReference', 'id': 'str', 'name': 'str', 'path': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.directory_get_response module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.directory_get_response.DirectoryGetResponse(continuation_token=None, total_item_count=None, items=None)

Bases: object

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__(continuation_token=None, total_item_count=None, items=None)
Keyword Arguments

  • continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

  • total_item_count (int) – Total number of items after applying filter params.

  • items (list[Directory]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
keys()
required_args = {}
swagger_types = {'continuation_token': 'str', 'items': 'list[Directory]', 'total_item_count': 'int'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.directory_response module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.directory_response.DirectoryResponse(items=None)

Bases: object

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__(items=None)
Keyword Arguments

items (list[Directory]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'items': 'items'}
keys()
required_args = {}
swagger_types = {'items': 'list[Directory]'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.drive module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

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

Bases: object

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, name=None, id=None, protocol=None, details=None, arrays=None, type=None, capacity=None, status=None)
Keyword Arguments

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

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

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

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

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

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

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

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

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'arrays': 'arrays', 'as_of': '_as_of', 'capacity': 'capacity', 'details': 'details', 'id': 'id', 'name': 'name', 'protocol': 'protocol', 'status': 'status', 'type': 'type'}
keys()
required_args = {}
swagger_types = {'arrays': 'list[DriveArrayStatus]', 'as_of': 'int', 'capacity': 'float', 'details': 'str', 'id': 'str', 'name': 'str', 'protocol': 'str', 'status': 'str', 'type': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.drive_array_status module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.drive_array_status.DriveArrayStatus(name=None, resource_type=None, id=None, drive_count=None, total_capacity=None)

Bases: object

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, resource_type=None, id=None, drive_count=None, total_capacity=None)
Keyword Arguments

  • 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.

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

  • drive_count (int) – Count of drives in the array.

  • total_capacity (int) – The total capacity of all drives in the array.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'drive_count': 'drive_count', 'id': 'id', 'name': 'name', 'resource_type': 'resource_type', 'total_capacity': 'total_capacity'}
keys()
required_args = {}
swagger_types = {'drive_count': 'int', 'id': 'str', 'name': 'str', 'resource_type': 'str', 'total_capacity': 'int'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.drive_get_response module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.drive_get_response.DriveGetResponse(continuation_token=None, total_item_count=None, items=None)

Bases: object

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__(continuation_token=None, total_item_count=None, items=None)
Keyword Arguments

  • continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

  • total_item_count (int) – Total number of items after applying filter params.

  • items (list[Drive]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
keys()
required_args = {}
swagger_types = {'continuation_token': 'str', 'items': 'list[Drive]', 'total_item_count': 'int'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.drive_response module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.drive_response.DriveResponse(items=None)

Bases: object

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__(items=None)
Keyword Arguments

items (list[Drive]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'items': 'items'}
keys()
required_args = {}
swagger_types = {'items': 'list[Drive]'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.error module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.error.Error(errors=None)

Bases: object

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__(errors=None)
Keyword Arguments

errors (list[ErrorErrors]) – The list of errors encountered.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'errors': 'errors'}
keys()
required_args = {}
swagger_types = {'errors': 'list[ErrorErrors]'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.error_errors module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.error_errors.ErrorErrors(context=None, message=None)

Bases: object

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__(context=None, message=None)
Keyword Arguments

  • context (str) –

  • message (str) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'context': 'context', 'message': 'message'}
keys()
required_args = {}
swagger_types = {'context': 'str', 'message': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.error_no_context module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.error_no_context.ErrorNoContext(message=None)

Bases: object

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__(message=None)
Keyword Arguments

message (str) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'message': 'message'}
keys()
required_args = {}
swagger_types = {'message': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.file_system module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

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

Bases: object

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, name=None, id=None, arrays=None, destroyed=None, hard_limit_enabled=None, provisioned=None, created=None, http=None, smb=None, nfs=None, snapshot_directory_enabled=None, fast_remove_directory_enabled=None)
Keyword Arguments

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

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

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

  • 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.

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

  • 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.

  • 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.

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

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

  • smb (Smb) – SMB 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.

  • 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.

  • 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.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'arrays': 'arrays', 'as_of': '_as_of', 'created': 'created', 'destroyed': 'destroyed', 'fast_remove_directory_enabled': 'fast_remove_directory_enabled', 'hard_limit_enabled': 'hard_limit_enabled', 'http': 'http', 'id': 'id', 'name': 'name', 'nfs': 'nfs', 'provisioned': 'provisioned', 'smb': 'smb', 'snapshot_directory_enabled': 'snapshot_directory_enabled'}
keys()
required_args = {}
swagger_types = {'arrays': 'list[FixedReference]', 'as_of': 'int', 'created': 'int', 'destroyed': 'bool', 'fast_remove_directory_enabled': 'bool', 'hard_limit_enabled': 'bool', 'http': 'Http', 'id': 'str', 'name': 'str', 'nfs': 'Nfs', 'provisioned': 'int', 'smb': 'Smb', 'snapshot_directory_enabled': 'bool'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.file_system_get_response module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.file_system_get_response.FileSystemGetResponse(continuation_token=None, total_item_count=None, items=None)

Bases: object

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__(continuation_token=None, total_item_count=None, items=None)
Keyword Arguments

  • continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

  • total_item_count (int) – Total number of items after applying filter params.

  • items (list[FileSystem]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
keys()
required_args = {}
swagger_types = {'continuation_token': 'str', 'items': 'list[FileSystem]', 'total_item_count': 'int'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.file_system_response module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.file_system_response.FileSystemResponse(items=None)

Bases: object

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__(items=None)
Keyword Arguments

items (list[FileSystem]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'items': 'items'}
keys()
required_args = {}
swagger_types = {'items': 'list[FileSystem]'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.file_system_snapshot module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

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

Bases: object

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, name=None, id=None, arrays=None, destroyed=None, created=None, source=None, suffix=None, on=None)
Keyword Arguments

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

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

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

  • 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.

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

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

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

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

  • on (FixedReference) – A reference to the array where the snapshot is stored.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'arrays': 'arrays', 'as_of': '_as_of', 'created': 'created', 'destroyed': 'destroyed', 'id': 'id', 'name': 'name', 'on': 'on', 'source': 'source', 'suffix': 'suffix'}
keys()
required_args = {}
swagger_types = {'arrays': 'list[FixedReference]', 'as_of': 'int', 'created': 'int', 'destroyed': 'bool', 'id': 'str', 'name': 'str', 'on': 'FixedReference', 'source': 'FixedReference', 'suffix': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.file_system_snapshot_get_response module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.file_system_snapshot_get_response.FileSystemSnapshotGetResponse(continuation_token=None, total_item_count=None, items=None)

Bases: object

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__(continuation_token=None, total_item_count=None, items=None)
Keyword Arguments

  • continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

  • total_item_count (int) – Total number of items after applying filter params.

  • items (list[FileSystemSnapshot]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
keys()
required_args = {}
swagger_types = {'continuation_token': 'str', 'items': 'list[FileSystemSnapshot]', 'total_item_count': 'int'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.file_system_snapshot_response module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.file_system_snapshot_response.FileSystemSnapshotResponse(items=None)

Bases: object

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__(items=None)
Keyword Arguments

items (list[FileSystemSnapshot]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'items': 'items'}
keys()
required_args = {}
swagger_types = {'items': 'list[FileSystemSnapshot]'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.fixed_reference module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.fixed_reference.FixedReference(name=None, resource_type=None, id=None)

Bases: object

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, resource_type=None, id=None)
Keyword Arguments

  • 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.

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'id': 'id', 'name': 'name', 'resource_type': 'resource_type'}
keys()
required_args = {}
swagger_types = {'id': 'str', 'name': 'str', 'resource_type': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.hardware module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

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

Bases: object

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, name=None, id=None, arrays=None, identify_enabled=None, serial=None, temperature=None, details=None, model=None, slot=None, type=None, speed=None, status=None, voltage=None)
Keyword Arguments

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

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

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

  • 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.

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

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

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

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

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

  • slot (int) – Slot number occupied by the PCI Express card that hosts 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.

  • 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.

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'arrays': 'arrays', 'as_of': '_as_of', 'details': 'details', 'id': 'id', 'identify_enabled': 'identify_enabled', 'model': 'model', 'name': 'name', 'serial': 'serial', 'slot': 'slot', 'speed': 'speed', 'status': 'status', 'temperature': 'temperature', 'type': 'type', 'voltage': 'voltage'}
keys()
required_args = {}
swagger_types = {'arrays': 'list[FixedReference]', 'as_of': 'int', 'details': 'str', 'id': 'str', 'identify_enabled': 'bool', 'model': 'str', 'name': 'str', 'serial': 'str', 'slot': 'int', 'speed': 'int', 'status': 'str', 'temperature': 'int', 'type': 'str', 'voltage': 'int'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.hardware_connector module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

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

Bases: object

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, name=None, id=None, arrays=None, lane_speed=None, transceiver_type=None, connector_type=None, port_count=None)
Keyword Arguments

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

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

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

  • 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.

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

  • 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.

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

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'arrays': 'arrays', 'as_of': '_as_of', 'connector_type': 'connector_type', 'id': 'id', 'lane_speed': 'lane_speed', 'name': 'name', 'port_count': 'port_count', 'transceiver_type': 'transceiver_type'}
keys()
required_args = {}
swagger_types = {'arrays': 'list[FixedReference]', 'as_of': 'int', 'connector_type': 'str', 'id': 'str', 'lane_speed': 'float', 'name': 'str', 'port_count': 'float', 'transceiver_type': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.hardware_connector_get_response module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.hardware_connector_get_response.HardwareConnectorGetResponse(continuation_token=None, total_item_count=None, items=None)

Bases: object

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__(continuation_token=None, total_item_count=None, items=None)
Keyword Arguments

  • continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

  • total_item_count (int) – Total number of items after applying filter params.

  • items (list[HardwareConnector]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
keys()
required_args = {}
swagger_types = {'continuation_token': 'str', 'items': 'list[HardwareConnector]', 'total_item_count': 'int'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.hardware_connector_response module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.hardware_connector_response.HardwareConnectorResponse(items=None)

Bases: object

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__(items=None)
Keyword Arguments

items (list[HardwareConnector]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'items': 'items'}
keys()
required_args = {}
swagger_types = {'items': 'list[HardwareConnector]'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.hardware_get_response module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.hardware_get_response.HardwareGetResponse(continuation_token=None, total_item_count=None, items=None)

Bases: object

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__(continuation_token=None, total_item_count=None, items=None)
Keyword Arguments

  • continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

  • total_item_count (int) – Total number of items after applying filter params.

  • items (list[Hardware]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
keys()
required_args = {}
swagger_types = {'continuation_token': 'str', 'items': 'list[Hardware]', 'total_item_count': 'int'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.hardware_response module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.hardware_response.HardwareResponse(items=None)

Bases: object

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__(items=None)
Keyword Arguments

items (list[Hardware]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'items': 'items'}
keys()
required_args = {}
swagger_types = {'items': 'list[Hardware]'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.http module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

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

Bases: object

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

attribute_map = {'enabled': 'enabled'}
keys()
required_args = {}
swagger_types = {'enabled': 'bool'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.inline_response400 module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.inline_response400.InlineResponse400(error_description=None, error=None)

Bases: object

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__(error_description=None, error=None)
Keyword Arguments

  • error_description (str) –

  • error (str) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'error': 'error', 'error_description': 'error_description'}
keys()
required_args = {}
swagger_types = {'error': 'str', 'error_description': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.inline_response401 module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.inline_response401.InlineResponse401(error_description=None, error=None)

Bases: object

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__(error_description=None, error=None)
Keyword Arguments

  • error_description (str) –

  • error (str) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'error': 'error', 'error_description': 'error_description'}
keys()
required_args = {}
swagger_types = {'error': 'str', 'error_description': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.license_resource_reference module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

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

Bases: object

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, resource_type=None, id=None, usage=None, activation_time=None)
Keyword Arguments

  • 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.

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

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

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'activation_time': 'activation_time', 'id': 'id', 'name': 'name', 'resource_type': 'resource_type', 'usage': 'usage'}
keys()
required_args = {}
swagger_types = {'activation_time': 'int', 'id': 'str', 'name': 'str', 'resource_type': 'str', 'usage': 'CurrentMetric'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.marketplace_partner module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

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

Bases: object

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__(reference_id=None, name=None)
Keyword Arguments

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

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'name': 'name', 'reference_id': 'reference_id'}
keys()
required_args = {}
swagger_types = {'name': 'str', 'reference_id': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.metric module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

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

Bases: object

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, name=None, id=None, unit=None, availabilities=None, description=None, resource_types=None)
Keyword Arguments

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

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

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

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

  • 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”.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'as_of': '_as_of', 'availabilities': 'availabilities', 'description': 'description', 'id': 'id', 'name': 'name', 'resource_types': 'resource_types', 'unit': 'unit'}
keys()
required_args = {}
swagger_types = {'as_of': 'int', 'availabilities': 'list[MetricAvailability]', 'description': 'str', 'id': 'str', 'name': 'str', 'resource_types': 'list[str]', 'unit': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.metric_availability module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

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

Bases: object

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

attribute_map = {'aggregations': 'aggregations', 'resolution': 'resolution', 'retention': 'retention'}
keys()
required_args = {}
swagger_types = {'aggregations': 'list[str]', 'resolution': 'int', 'retention': 'int'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.metric_get_response module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.metric_get_response.MetricGetResponse(continuation_token=None, total_item_count=None, items=None)

Bases: object

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__(continuation_token=None, total_item_count=None, items=None)
Keyword Arguments

  • continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

  • total_item_count (int) – Total number of items after applying filter params.

  • items (list[Metric]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
keys()
required_args = {}
swagger_types = {'continuation_token': 'str', 'items': 'list[Metric]', 'total_item_count': 'int'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.metric_history module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

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

Bases: object

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, name=None, id=None, unit=None, data=None, resources=None, aggregation=None, resolution=None)
Keyword Arguments

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

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

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

  • unit (str) – The unit 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], …].

  • resources (list[FixedReference]) – The references to the resources that the metric data is for. For example, write-iops metric for an array will have one element in this list referencing the array entity. the write-iops from an array to a pod will contain two elements in this list - first element pointing to the array, and second element pointing to the pod.

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

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'aggregation': 'aggregation', 'as_of': '_as_of', 'data': 'data', 'id': 'id', 'name': 'name', 'resolution': 'resolution', 'resources': 'resources', 'unit': 'unit'}
keys()
required_args = {}
swagger_types = {'aggregation': 'str', 'as_of': 'int', 'data': 'list[list[float]]', 'id': 'str', 'name': 'str', 'resolution': 'int', 'resources': 'list[FixedReference]', 'unit': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.metric_history_get_response module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.metric_history_get_response.MetricHistoryGetResponse(continuation_token=None, total_item_count=None, items=None)

Bases: object

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__(continuation_token=None, total_item_count=None, items=None)
Keyword Arguments

  • continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

  • total_item_count (int) – Total number of items after applying filter params.

  • items (list[MetricHistory]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
keys()
required_args = {}
swagger_types = {'continuation_token': 'str', 'items': 'list[MetricHistory]', 'total_item_count': 'int'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.metric_history_response module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.metric_history_response.MetricHistoryResponse(items=None)

Bases: object

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__(items=None)
Keyword Arguments

items (list[MetricHistory]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'items': 'items'}
keys()
required_args = {}
swagger_types = {'items': 'list[MetricHistory]'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.metric_response module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.metric_response.MetricResponse(items=None)

Bases: object

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__(items=None)
Keyword Arguments

items (list[Metric]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'items': 'items'}
keys()
required_args = {}
swagger_types = {'items': 'list[Metric]'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.network_interface module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

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

Bases: object

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, name=None, id=None, arrays=None, hwaddr=None, address=None, netmask=None, services=None, subinterfaces=None, enabled=None, gateway=None, speed=None, mtu=None)
Keyword Arguments

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

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

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

  • 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.

  • hwaddr (str) – Hardware address.

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

  • netmask (str) –

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

  • subinterfaces (list[str]) –

  • enabled (bool) –

  • gateway (str) –

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

  • mtu (int) – Maximum transmission unit.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'address': 'address', 'arrays': 'arrays', 'as_of': '_as_of', 'enabled': 'enabled', 'gateway': 'gateway', 'hwaddr': 'hwaddr', 'id': 'id', 'mtu': 'mtu', 'name': 'name', 'netmask': 'netmask', 'services': 'services', 'speed': 'speed', 'subinterfaces': 'subinterfaces'}
keys()
required_args = {}
swagger_types = {'address': 'str', 'arrays': 'list[FixedReference]', 'as_of': 'int', 'enabled': 'bool', 'gateway': 'str', 'hwaddr': 'str', 'id': 'str', 'mtu': 'int', 'name': 'str', 'netmask': 'str', 'services': 'list[str]', 'speed': 'int', 'subinterfaces': 'list[str]'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.network_interface_get_response module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.network_interface_get_response.NetworkInterfaceGetResponse(continuation_token=None, total_item_count=None, items=None)

Bases: object

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__(continuation_token=None, total_item_count=None, items=None)
Keyword Arguments

  • continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

  • total_item_count (int) – Total number of items after applying filter params.

  • items (list[NetworkInterface]) – A list of network interface objects.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
keys()
required_args = {}
swagger_types = {'continuation_token': 'str', 'items': 'list[NetworkInterface]', 'total_item_count': 'int'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.network_interface_response module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.network_interface_response.NetworkInterfaceResponse(items=None)

Bases: object

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__(items=None)
Keyword Arguments

items (list[NetworkInterface]) – A list of network interface objects.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'items': 'items'}
keys()
required_args = {}
swagger_types = {'items': 'list[NetworkInterface]'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.nfs module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

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

Bases: object

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__(rules=None, enabled=None)
Keyword Arguments

  • rules (str) – NFS rules.

  • enabled (bool) – Is the protocol enabled?

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'enabled': 'enabled', 'rules': 'rules'}
keys()
required_args = {}
swagger_types = {'enabled': 'bool', 'rules': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.oauth_token_response module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.oauth_token_response.OauthTokenResponse(access_token=None, issued_token_type=None, token_type=None, expires_in=None)

Bases: object

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__(access_token=None, issued_token_type=None, token_type=None, expires_in=None)
Keyword Arguments

  • access_token (str) – The serialized OAuth 2.0 Bearer token used to perform authenticated requests. The access token must be added to the Authorization header of all API calls.

  • issued_token_type (str) – The type of token that is issued. The Pure Storage REST API supports OAuth 2.0 access tokens.

  • token_type (str) – Indicates how the API client can use the access token issued. The Pure Storage REST API supports the Bearer token.

  • expires_in (int) – The duration after which the access token will expire. Measured in seconds. This differs from other duration fields that are expressed in milliseconds.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'access_token': 'access_token', 'expires_in': 'expires_in', 'issued_token_type': 'issued_token_type', 'token_type': 'token_type'}
keys()
required_args = {}
swagger_types = {'access_token': 'str', 'expires_in': 'int', 'issued_token_type': 'str', 'token_type': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.object_store_account module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

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

Bases: object

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, name=None, id=None, arrays=None, created=None, object_count=None)
Keyword Arguments

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

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

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

  • 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

attribute_map = {'arrays': 'arrays', 'as_of': '_as_of', 'created': 'created', 'id': 'id', 'name': 'name', 'object_count': 'object_count'}
keys()
required_args = {}
swagger_types = {'arrays': 'list[FixedReference]', 'as_of': 'int', 'created': 'int', 'id': 'str', 'name': 'str', 'object_count': 'int'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.object_store_account_get_response module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.object_store_account_get_response.ObjectStoreAccountGetResponse(continuation_token=None, total_item_count=None, items=None)

Bases: object

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__(continuation_token=None, total_item_count=None, items=None)
Keyword Arguments

  • continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

  • total_item_count (int) – Total number of items after applying filter params.

  • items (list[ObjectStoreAccount]) – A list of object store accounts.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
keys()
required_args = {}
swagger_types = {'continuation_token': 'str', 'items': 'list[ObjectStoreAccount]', 'total_item_count': 'int'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.object_store_account_response module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.object_store_account_response.ObjectStoreAccountResponse(items=None)

Bases: object

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__(items=None)
Keyword Arguments

items (list[ObjectStoreAccount]) – A list of object store accounts.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'items': 'items'}
keys()
required_args = {}
swagger_types = {'items': 'list[ObjectStoreAccount]'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.page_info module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.page_info.PageInfo(continuation_token=None, total_item_count=None)

Bases: object

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__(continuation_token=None, total_item_count=None)
Keyword Arguments

  • continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

  • total_item_count (int) – Total number of items after applying filter params.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'continuation_token': 'continuation_token', 'total_item_count': 'total_item_count'}
keys()
required_args = {}
swagger_types = {'continuation_token': 'str', 'total_item_count': 'int'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.pod module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

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

Bases: object

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, name=None, id=None, arrays=None, source=None, mediator=None)
Keyword Arguments

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

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

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

  • arrays (list[PodArrayStatus]) – A list of arrays that share this pod. If two or more arrays are specified, all data in the pod is synchronously mirrored between them.

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

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'arrays': 'arrays', 'as_of': '_as_of', 'id': 'id', 'mediator': 'mediator', 'name': 'name', 'source': 'source'}
keys()
required_args = {}
swagger_types = {'arrays': 'list[PodArrayStatus]', 'as_of': 'int', 'id': 'str', 'mediator': 'str', 'name': 'str', 'source': 'FixedReference'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.pod_array_status module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

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

Bases: object

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, resource_type=None, id=None, mediator_status=None, frozen_at=None, status=None)
Keyword Arguments

  • 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.

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

  • 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.

  • 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).

  • 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

attribute_map = {'frozen_at': 'frozen_at', 'id': 'id', 'mediator_status': 'mediator_status', 'name': 'name', 'resource_type': 'resource_type', 'status': 'status'}
keys()
required_args = {}
swagger_types = {'frozen_at': 'int', 'id': 'str', 'mediator_status': 'str', 'name': 'str', 'resource_type': 'str', 'status': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.pod_get_response module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.pod_get_response.PodGetResponse(continuation_token=None, total_item_count=None, items=None)

Bases: object

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__(continuation_token=None, total_item_count=None, items=None)
Keyword Arguments

  • continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

  • total_item_count (int) – Total number of items after applying filter params.

  • items (list[Pod]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
keys()
required_args = {}
swagger_types = {'continuation_token': 'str', 'items': 'list[Pod]', 'total_item_count': 'int'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.pod_response module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.pod_response.PodResponse(items=None)

Bases: object

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__(items=None)
Keyword Arguments

items (list[Pod]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'items': 'items'}
keys()
required_args = {}
swagger_types = {'items': 'list[Pod]'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.policy module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

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

Bases: object

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, name=None, id=None, arrays=None, rules=None, enabled=None)
Keyword Arguments

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

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

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

  • 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.

  • rules (list[PolicyRule]) –

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'arrays': 'arrays', 'as_of': '_as_of', 'enabled': 'enabled', 'id': 'id', 'name': 'name', 'rules': 'rules'}
keys()
required_args = {}
swagger_types = {'arrays': 'list[FixedReference]', 'as_of': 'int', 'enabled': 'bool', 'id': 'str', 'name': 'str', 'rules': 'list[PolicyRule]'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.policy_get_response module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.policy_get_response.PolicyGetResponse(continuation_token=None, total_item_count=None, items=None)

Bases: object

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__(continuation_token=None, total_item_count=None, items=None)
Keyword Arguments

  • continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

  • total_item_count (int) – Total number of items after applying filter params.

  • items (list[Policy]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
keys()
required_args = {}
swagger_types = {'continuation_token': 'str', 'items': 'list[Policy]', 'total_item_count': 'int'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.policy_member module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

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

Bases: object

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, member=None, policy=None)
Keyword Arguments
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'as_of': '_as_of', 'member': 'member', 'policy': 'policy'}
keys()
required_args = {}
swagger_types = {'as_of': 'int', 'member': 'FixedReference', 'policy': 'FixedReference'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.policy_members_get_response module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.policy_members_get_response.PolicyMembersGetResponse(continuation_token=None, total_item_count=None, items=None)

Bases: object

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__(continuation_token=None, total_item_count=None, items=None)
Keyword Arguments

  • continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

  • total_item_count (int) – Total number of items after applying filter params.

  • items (list[PolicyMember]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
keys()
required_args = {}
swagger_types = {'continuation_token': 'str', 'items': 'list[PolicyMember]', 'total_item_count': 'int'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.policy_members_response module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.policy_members_response.PolicyMembersResponse(items=None)

Bases: object

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__(items=None)
Keyword Arguments

items (list[PolicyMember]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'items': 'items'}
keys()
required_args = {}
swagger_types = {'items': 'list[PolicyMember]'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.policy_response module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.policy_response.PolicyResponse(items=None)

Bases: object

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__(items=None)
Keyword Arguments

items (list[Policy]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'items': 'items'}
keys()
required_args = {}
swagger_types = {'items': 'list[Policy]'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.policy_rule module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

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

Bases: object

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, keep_for=None, time_zone=None, every=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.

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

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

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'at': 'at', 'every': 'every', 'keep_for': 'keep_for', 'time_zone': 'time_zone'}
keys()
required_args = {}
swagger_types = {'at': 'int', 'every': 'int', 'keep_for': 'int', 'time_zone': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.port module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

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

Bases: object

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, name=None, id=None, arrays=None, failover=None, iqn=None, nqn=None, portal=None, wwn=None)
Keyword Arguments

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

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

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

  • 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.

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

  • 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.

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

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'arrays': 'arrays', 'as_of': '_as_of', 'failover': 'failover', 'id': 'id', 'iqn': 'iqn', 'name': 'name', 'nqn': 'nqn', 'portal': 'portal', 'wwn': 'wwn'}
keys()
required_args = {}
swagger_types = {'arrays': 'list[FixedReference]', 'as_of': 'int', 'failover': 'str', 'id': 'str', 'iqn': 'str', 'name': 'str', 'nqn': 'str', 'portal': 'str', 'wwn': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.port_get_response module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.port_get_response.PortGetResponse(continuation_token=None, total_item_count=None, items=None)

Bases: object

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__(continuation_token=None, total_item_count=None, items=None)
Keyword Arguments

  • continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

  • total_item_count (int) – Total number of items after applying filter params.

  • items (list[Port]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
keys()
required_args = {}
swagger_types = {'continuation_token': 'str', 'items': 'list[Port]', 'total_item_count': 'int'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.port_response module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.port_response.PortResponse(items=None)

Bases: object

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__(items=None)
Keyword Arguments

items (list[Port]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'items': 'items'}
keys()
required_args = {}
swagger_types = {'items': 'list[Port]'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.resource module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.resource.Resource(as_of=None, name=None, id=None)

Bases: object

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, name=None, id=None)
Keyword Arguments

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

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

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'as_of': '_as_of', 'id': 'id', 'name': 'name'}
keys()
required_args = {}
swagger_types = {'as_of': 'int', 'id': 'str', 'name': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.resource_no_name module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.resource_no_name.ResourceNoName(as_of=None, id=None)

Bases: object

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)
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.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'as_of': '_as_of', 'id': 'id'}
keys()
required_args = {}
swagger_types = {'as_of': 'int', 'id': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.resource_with_location module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

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

Bases: object

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, resource_type=None, id=None, location=None)
Keyword Arguments

  • 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.

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

  • location (FixedReference) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'id': 'id', 'location': 'location', 'name': 'name', 'resource_type': 'resource_type'}
keys()
required_args = {}
swagger_types = {'id': 'str', 'location': 'FixedReference', 'name': 'str', 'resource_type': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.resource_with_locations module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.resource_with_locations.ResourceWithLocations(name=None, resource_type=None, id=None, locations=None)

Bases: object

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, resource_type=None, id=None, locations=None)
Keyword Arguments

  • 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.

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

  • locations (list[FixedReference]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'id': 'id', 'locations': 'locations', 'name': 'name', 'resource_type': 'resource_type'}
keys()
required_args = {}
swagger_types = {'id': 'str', 'locations': 'list[FixedReference]', 'name': 'str', 'resource_type': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.smb module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

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

Bases: object

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

attribute_map = {'enabled': 'enabled'}
keys()
required_args = {}
swagger_types = {'enabled': 'bool'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.subscription module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.subscription.Subscription(as_of=None, name=None, id=None, service=None, expiration_date=None, start_date=None, status=None)

Bases: object

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, name=None, id=None, service=None, expiration_date=None, start_date=None, status=None)
Keyword Arguments

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

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

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

  • 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.

  • 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.

  • 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.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'as_of': '_as_of', 'expiration_date': 'expiration_date', 'id': 'id', 'name': 'name', 'service': 'service', 'start_date': 'start_date', 'status': 'status'}
keys()
required_args = {}
swagger_types = {'as_of': 'int', 'expiration_date': 'int', 'id': 'str', 'name': 'str', 'service': 'str', 'start_date': 'int', 'status': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.subscription_get_response module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.subscription_get_response.SubscriptionGetResponse(continuation_token=None, total_item_count=None, items=None)

Bases: object

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__(continuation_token=None, total_item_count=None, items=None)
Keyword Arguments

  • continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

  • total_item_count (int) – Total number of items after applying filter params.

  • items (list[Subscription]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
keys()
required_args = {}
swagger_types = {'continuation_token': 'str', 'items': 'list[Subscription]', 'total_item_count': 'int'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.subscription_license module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.subscription_license.SubscriptionLicense(as_of=None, name=None, id=None, average_on_demand=None, usage=None, reservation=None, resources=None, marketplace_partner=None, service_tier=None, subscription=None, expiration_date=None, start_date=None)

Bases: object

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, name=None, id=None, average_on_demand=None, usage=None, reservation=None, resources=None, marketplace_partner=None, service_tier=None, subscription=None, expiration_date=None, start_date=None)
Keyword Arguments

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

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

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

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

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

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

  • resources (list[LicenseResourceReference]) – References to the resources that operate under this license.

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

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

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

  • 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.

  • 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.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'as_of': '_as_of', 'average_on_demand': 'average_on_demand', 'expiration_date': 'expiration_date', 'id': 'id', 'marketplace_partner': 'marketplace_partner', 'name': 'name', 'reservation': 'reservation', 'resources': 'resources', 'service_tier': 'service_tier', 'start_date': 'start_date', 'subscription': 'subscription', 'usage': 'usage'}
keys()
required_args = {}
swagger_types = {'as_of': 'int', 'average_on_demand': 'CurrentMetric', 'expiration_date': 'int', 'id': 'str', 'marketplace_partner': 'MarketplacePartner', 'name': 'str', 'reservation': 'CurrentMetric', 'resources': 'list[LicenseResourceReference]', 'service_tier': 'str', 'start_date': 'int', 'subscription': 'FixedReference', 'usage': 'CurrentMetric'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.subscription_license_get_response module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.subscription_license_get_response.SubscriptionLicenseGetResponse(continuation_token=None, total_item_count=None, items=None)

Bases: object

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__(continuation_token=None, total_item_count=None, items=None)
Keyword Arguments

  • continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

  • total_item_count (int) – Total number of items after applying filter params.

  • items (list[SubscriptionLicense]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
keys()
required_args = {}
swagger_types = {'continuation_token': 'str', 'items': 'list[SubscriptionLicense]', 'total_item_count': 'int'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.subscription_license_response module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.subscription_license_response.SubscriptionLicenseResponse(items=None)

Bases: object

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__(items=None)
Keyword Arguments

items (list[SubscriptionLicense]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'items': 'items'}
keys()
required_args = {}
swagger_types = {'items': 'list[SubscriptionLicense]'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.subscription_response module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.subscription_response.SubscriptionResponse(items=None)

Bases: object

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__(items=None)
Keyword Arguments

items (list[Subscription]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'items': 'items'}
keys()
required_args = {}
swagger_types = {'items': 'list[Subscription]'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.support_contract module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.support_contract.SupportContract(end_date=None, resource=None, start_date=None)

Bases: object

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__(end_date=None, resource=None, start_date=None)
Keyword Arguments

  • end_date (int) – Date when the support contract ended. Represented as a timestamp of 00:00 on that date in UTC, in milliseconds since UNIX epoch.

  • resource (FixedReference) –

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'end_date': 'end_date', 'resource': 'resource', 'start_date': 'start_date'}
keys()
required_args = {}
swagger_types = {'end_date': 'int', 'resource': 'FixedReference', 'start_date': 'int'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.support_contract_get_response module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.support_contract_get_response.SupportContractGetResponse(continuation_token=None, total_item_count=None, items=None)

Bases: object

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__(continuation_token=None, total_item_count=None, items=None)
Keyword Arguments

  • continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

  • total_item_count (int) – Total number of items after applying filter params.

  • items (list[SupportContract]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
keys()
required_args = {}
swagger_types = {'continuation_token': 'str', 'items': 'list[SupportContract]', 'total_item_count': 'int'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.support_contract_response module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.support_contract_response.SupportContractResponse(items=None)

Bases: object

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__(items=None)
Keyword Arguments

items (list[SupportContract]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'items': 'items'}
keys()
required_args = {}
swagger_types = {'items': 'list[SupportContract]'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.tag module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

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

Bases: object

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__(resource=None, tag_organization_id=None, namespace=None, value=None, key=None)
Keyword Arguments

  • resource (FixedReference) –

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

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

  • value (str) – Value of the tag.

  • key (str) – Key of the tag.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'key': 'key', 'namespace': 'namespace', 'resource': 'resource', 'tag_organization_id': 'tag_organization_id', 'value': 'value'}
keys()
required_args = {}
swagger_types = {'key': 'str', 'namespace': 'str', 'resource': 'FixedReference', 'tag_organization_id': 'int', 'value': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.tag_batch_required module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.tag_batch_required.TagBatchRequired

Bases: object

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__()

Keyword args:

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {}
keys()
required_args = {}
swagger_types = {}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.tag_get_response module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.tag_get_response.TagGetResponse(continuation_token=None, total_item_count=None, items=None)

Bases: object

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__(continuation_token=None, total_item_count=None, items=None)
Keyword Arguments

  • continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

  • total_item_count (int) – Total number of items after applying filter params.

  • items (list[Tag]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
keys()
required_args = {}
swagger_types = {'continuation_token': 'str', 'items': 'list[Tag]', 'total_item_count': 'int'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.tag_put module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.tag_put.TagPut(value=None, key=None)

Bases: object

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__(value=None, key=None)
Keyword Arguments

  • value (str) – Value of the tag.

  • key (str) – Key of the tag.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'key': 'key', 'value': 'value'}
keys()
required_args = {}
swagger_types = {'key': 'str', 'value': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.tag_response module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.tag_response.TagResponse(items=None)

Bases: object

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__(items=None)
Keyword Arguments

items (list[Tag]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'items': 'items'}
keys()
required_args = {}
swagger_types = {'items': 'list[Tag]'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.target module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

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

Bases: object

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, name=None, id=None, arrays=None, address=None, status_details=None, status=None)
Keyword Arguments

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

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

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

  • 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.

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

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

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'address': 'address', 'arrays': 'arrays', 'as_of': '_as_of', 'id': 'id', 'name': 'name', 'status': 'status', 'status_details': 'status_details'}
keys()
required_args = {}
swagger_types = {'address': 'str', 'arrays': 'list[FixedReference]', 'as_of': 'int', 'id': 'str', 'name': 'str', 'status': 'str', 'status_details': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.target_get_response module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.target_get_response.TargetGetResponse(continuation_token=None, total_item_count=None, items=None)

Bases: object

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__(continuation_token=None, total_item_count=None, items=None)
Keyword Arguments

  • continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

  • total_item_count (int) – Total number of items after applying filter params.

  • items (list[Target]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
keys()
required_args = {}
swagger_types = {'continuation_token': 'str', 'items': 'list[Target]', 'total_item_count': 'int'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.target_response module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.target_response.TargetResponse(items=None)

Bases: object

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__(items=None)
Keyword Arguments

items (list[Target]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'items': 'items'}
keys()
required_args = {}
swagger_types = {'items': 'list[Target]'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.time_aware module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.time_aware.TimeAware(as_of=None)

Bases: object

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)
Keyword Arguments

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'as_of': '_as_of'}
keys()
required_args = {}
swagger_types = {'as_of': 'int'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.volume module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

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

Bases: object

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, name=None, id=None, arrays=None, destroyed=None, pod=None, provisioned=None, serial=None, created=None, source=None, eradicated=None)
Keyword Arguments

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

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

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

  • 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.

  • destroyed (bool) – Whether this volume has been destroyed 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.

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

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

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'arrays': 'arrays', 'as_of': '_as_of', 'created': 'created', 'destroyed': 'destroyed', 'eradicated': 'eradicated', 'id': 'id', 'name': 'name', 'pod': 'pod', 'provisioned': 'provisioned', 'serial': 'serial', 'source': 'source'}
keys()
required_args = {}
swagger_types = {'arrays': 'list[FixedReference]', 'as_of': 'int', 'created': 'int', 'destroyed': 'bool', 'eradicated': 'bool', 'id': 'str', 'name': 'str', 'pod': 'FixedReference', 'provisioned': 'int', 'serial': 'str', 'source': 'FixedReference'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.volume_get_response module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.volume_get_response.VolumeGetResponse(continuation_token=None, total_item_count=None, items=None)

Bases: object

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__(continuation_token=None, total_item_count=None, items=None)
Keyword Arguments

  • continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

  • total_item_count (int) – Total number of items after applying filter params.

  • items (list[Volume]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
keys()
required_args = {}
swagger_types = {'continuation_token': 'str', 'items': 'list[Volume]', 'total_item_count': 'int'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.volume_response module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.volume_response.VolumeResponse(items=None)

Bases: object

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__(items=None)
Keyword Arguments

items (list[Volume]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'items': 'items'}
keys()
required_args = {}
swagger_types = {'items': 'list[Volume]'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.volume_snapshot module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

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

Bases: object

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, name=None, id=None, arrays=None, destroyed=None, pod=None, provisioned=None, serial=None, created=None, source=None, suffix=None, snapshot_group=None, on=None)
Keyword Arguments

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

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

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

  • 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.

  • 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.

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

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

  • 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.

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

  • on (FixedReference) – A reference to the array or the offload where the snapshot is stored.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'arrays': 'arrays', 'as_of': '_as_of', 'created': 'created', 'destroyed': 'destroyed', 'id': 'id', 'name': 'name', 'on': 'on', 'pod': 'pod', 'provisioned': 'provisioned', 'serial': 'serial', 'snapshot_group': 'snapshot_group', 'source': 'source', 'suffix': 'suffix'}
keys()
required_args = {}
swagger_types = {'arrays': 'list[FixedReference]', 'as_of': 'int', 'created': 'int', 'destroyed': 'bool', 'id': 'str', 'name': 'str', 'on': 'FixedReference', 'pod': 'FixedReference', 'provisioned': 'int', 'serial': 'str', 'snapshot_group': 'FixedReference', 'source': 'FixedReference', 'suffix': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.volume_snapshot_get_response module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.volume_snapshot_get_response.VolumeSnapshotGetResponse(continuation_token=None, total_item_count=None, items=None)

Bases: object

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__(continuation_token=None, total_item_count=None, items=None)
Keyword Arguments

  • continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

  • total_item_count (int) – Total number of items after applying filter params.

  • items (list[VolumeSnapshot]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'continuation_token': 'continuation_token', 'items': 'items', 'total_item_count': 'total_item_count'}
keys()
required_args = {}
swagger_types = {'continuation_token': 'str', 'items': 'list[VolumeSnapshot]', 'total_item_count': 'int'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

pypureclient.pure1.Pure1_1_0.models.volume_snapshot_response module

Pure1 Public REST API

Pure1 Public REST API, developed by [Pure Storage, Inc.](https://www.purestorage.com) The Pure1 REST API 2.0 offers one single form of authentication: OAuth 2.0 via the [Token Exchange protocol](https://datatracker.ietf.org/doc/draft-ietf-oauth-token-exchange). OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications. Note that the [Authentication](#section/Authentication) section below mentions ‘API Key’ as the security scheme type. This is solely for the purpose of allowing testing this API with [Swagger UI](https://static.pure1.purestorage.com/api-swagger/index.html). [Knowledge base reference documentation](https://support.purestorage.com/Pure1/Pure1_Manage/Pure1_Manage_-_REST_API/Pure1_Manage_-_REST_API__Reference)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.pure1.Pure1_1_0.models.volume_snapshot_response.VolumeSnapshotResponse(items=None)

Bases: object

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__(items=None)
Keyword Arguments

items (list[VolumeSnapshot]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'items': 'items'}
keys()
required_args = {}
swagger_types = {'items': 'list[VolumeSnapshot]'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Module contents

class pypureclient.pure1.Pure1_1_0.models.ReferenceType

Bases: object

Class just for type annotations.

It’s used for reference arg on api function. This allows user to pass collections of Model objects to the method without transforming them to ids or names.

Should be Protocol type when the typing module will get support of it.

pypureclient.pure1.Pure1_1_0.models.quoteString(s)

Quote string according to https://wiki.purestorage.com/display/UXReviewers/Filtering

>>> quote("a")
"'a'"
>>> quote("a\\b")
"'a\\\\b'"
>>> quote("a\\b")
"'a\\\\b'"
>>> quote("a'b")
"'a\\'b'"
>>> quote(None)
None
pypureclient.pure1.Pure1_1_0.models.quoteStrings(s)