Pure1 Reference

Client

Pure1 REST Client Factory Method

Importable as

from pypureclient.pure1 import Client

pypureclient.pure1.client.Client(**kwargs)

Initialize a Pure1 Client.

Keyword Arguments

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

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

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

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

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

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

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

• model_attribute_error_on_none (bool, optional) – Controls model instance behaviour with regard to accessing attributes with None value. raise an AttributeError if attribute value is None, otherwise returns None. Defaults to True for backward compatibility with older versions of the SDK.

Raises

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

Pure1 REST 1.0 Client

class pypureclient.pure1.Pure1_1_0.client.Client(**kwargs)

A client for making REST API calls to Pure1.

Pure1 REST 1.1 Client

class pypureclient.pure1.Pure1_1_1.client.Client(**kwargs)

A client for making REST API calls to Pure1.

Pure1 REST 1.2 Client

class pypureclient.pure1.Pure1_1_2.client.Client(**kwargs)

A client for making REST API calls to Pure1.

Pure1 REST 1.3 Client

class pypureclient.pure1.Pure1_1_3.client.Client(**kwargs)

A client for making REST API calls to Pure1.

Pure1 REST 1.4 Client

class pypureclient.pure1.Pure1_1_4.client.Client(**kwargs)

A client for making REST API calls to Pure1.

Pure1 REST 1.5 Client

class pypureclient.pure1.Pure1_1_5.client.Client(**kwargs)

A client for making REST API calls to Pure1.

__init__(**kwargs)

Initialize a Pure1 Client.

Keyword Arguments

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

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

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

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

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

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

Raises

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

delete_arrays_tags(resources: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, keys: Optional[ConstrainedListValue[StrictStr]] = None, namespaces: Optional[ConstrainedListValue[StrictStr]] = None, resource_ids: Optional[ConstrainedListValue[StrictStr]] = None, resource_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Delete array tags

Deletes array tags from Pure1.

Parameters

• resources (ReferenceType or List[ReferenceType], optional) – A list of resources to query for. Overrides resource_ids and resource_names keyword arguments.

• authorization (str) – Deprecated. Please use Client level authorization

• x_request_id (str) – Supplied by client during request or generated by server.

• keys (List[str]) – A comma-separated list of tag keys. Single quotes are required around all strings.

• namespaces (List[str]) – A comma-separated list of namespaces. Single quotes are required around all strings.

• resource_ids (List[str]) – REQUIRED: either resource_ids or resource_names. A comma-separated list of resource IDs. If there is not at least one resource that matches each resource_id element, an error is returned. Single quotes are required around all strings.

• resource_names (List[str]) – REQUIRED: either resource_ids or resource_names. A comma-separated list of resource names. If there is not at least one resource that matches each resource_name element, an error is returned. Single quotes are required around all strings.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_access_token(refresh=False)

Get the last used access token.

Parameters

refresh (bool, optional) – Whether to retrieve a new access token. Defaults to False.

Returns

str

Raises

PureError – If there was an error retrieving an access token.

get_alerts(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Get alerts

Retrieves information about alerts generated by Pure1-monitored appliances.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• authorization (str) – Deprecated. Please use Client level authorization

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.

• filter (str) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.

• ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. Single quotes are required around all strings.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each name element, an error is returned. Single quotes are required around all strings.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_arrays(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, fqdns: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Get arrays

Retrieves information about FlashArray and FlashBlade storage appliances.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• authorization (str) – Deprecated. Please use Client level authorization

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.

• filter (str) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.

• fqdns (List[str]) – A comma-separated list of resource FQDNs. If there is not at least one resource that matches each fqdn element, an error is returned. Single quotes are required around all strings.

• ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. Single quotes are required around all strings.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each name element, an error is returned. Single quotes are required around all strings.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_arrays_support_contracts(resources: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[StrictInt] = None, offset: Optional[ConstrainedIntValue] = None, resource_fqdns: Optional[ConstrainedListValue[StrictStr]] = None, resource_ids: Optional[ConstrainedListValue[StrictStr]] = None, resource_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Get array support contracts

Retrieves the support contracts associated with arrays.

Parameters

• resources (ReferenceType or List[ReferenceType], optional) – A list of resources to query for. Overrides resource_ids and resource_names keyword arguments.

• authorization (str) – Deprecated. Please use Client level authorization

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.

• filter (str) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.

• offset (int) – The offset of the first resource to return from a collection.

• resource_fqdns (List[str]) – A comma-separated list of resource FQDNs. If there is not at least one resource that matches each resource_fqdn element, an error is returned. Single quotes are required around all strings.

• resource_ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each resource_id element, an error is returned. Single quotes are required around all strings.

• resource_names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each resource_name element, an error is returned. Single quotes are required around all strings.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_arrays_tags(resources: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, keys: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, namespaces: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, resource_ids: Optional[ConstrainedListValue[StrictStr]] = None, resource_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Get array tags

Retrieves the tags associated with specified arrays.

Parameters

• resources (ReferenceType or List[ReferenceType], optional) – A list of resources to query for. Overrides resource_ids and resource_names keyword arguments.

• authorization (str) – Deprecated. Please use Client level authorization

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.

• filter (str) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.

• keys (List[str]) – A comma-separated list of tag keys. Single quotes are required around all strings.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.

• namespaces (List[str]) – A comma-separated list of namespaces. Single quotes are required around all strings.

• offset (int) – The offset of the first resource to return from a collection.

• resource_ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each resource_id element, an error is returned. Single quotes are required around all strings.

• resource_names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each resource_name element, an error is returned. Single quotes are required around all strings.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_assessment_sustainability_arrays(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, fqdns: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Get appliance sustainability information.

Retrieves information about FlashArray and FlashBlade size, power consumption, heat generation and its sustainability assessment.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• authorization (str) – Deprecated. Please use Client level authorization

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.

• filter (str) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.

• fqdns (List[str]) – A comma-separated list of resource FQDNs. If there is not at least one resource that matches each fqdn element, an error is returned. Single quotes are required around all strings.

• ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. Single quotes are required around all strings.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each name element, an error is returned. Single quotes are required around all strings.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_assessment_sustainability_insights_arrays(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[StrictInt] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Get appliance sustainability insights information.

Retrieves information about FlashArray and FlashBlade insights connected to sustainability assessment.

Parameters

• authorization (str) – Deprecated. Please use Client level authorization

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.

• filter (str) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_audits(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Get audits

Retrieves audit objects.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• authorization (str) – Deprecated. Please use Client level authorization

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.

• filter (str) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.

• ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. Single quotes are required around all strings.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each name element, an error is returned. Single quotes are required around all strings.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_blades(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Get blades

Retrieves information about FlashBlade blades.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• authorization (str) – Deprecated. Please use Client level authorization

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.

• filter (str) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.

• ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. Single quotes are required around all strings.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each name element, an error is returned. Single quotes are required around all strings.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_bucket_replica_links(targets: Optional[Union[ReferenceType, List[ReferenceType]]] = None, sources: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = None, target_ids: Optional[ConstrainedListValue[StrictStr]] = None, target_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Get bucket replica links

Retrieves information about bucket replica links.

Parameters

• targets (ReferenceType or List[ReferenceType], optional) – A list of targets to query for. Overrides target_ids and target_names keyword arguments.

• sources (ReferenceType or List[ReferenceType], optional) – A list of sources to query for. Overrides source_ids and source_names keyword arguments.

• members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids keyword argument.

• authorization (str) – Deprecated. Please use Client level authorization

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.

• filter (str) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.

• ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. Single quotes are required around all strings.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.

• member_ids (List[str]) – A list of member IDs. Member IDs separated by a + indicate that both members must be present in each element. Member IDs separated by a , indicate that at least one member must be present in each element. If there is not at least one resource that matches each member_id element, an error is returned. Single quotes are required around all strings. When using Try it Out in Swagger, a list of member IDs separated by a + must be entered in the same item cell.

• member_names (List[str]) – A list of member names. Member names separated by a + indicate that both members must be present in each element. Member names separated by a , indicate that at least one member must be present in each element. If there is not at least one resource that matches each member_name element, an error is returned. Single quotes are required around all strings. When using Try it Out in Swagger, a list of member names separated by a + must be entered in the same item cell.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.

• source_ids (List[str]) – A list of source IDs. Source IDs separated by a + indicate that both sources must be present in each element. Source IDs separated by a , indicate that at least one source must be present in each element. If there is not at least one resource that matches each source_id element, an error is returned. Single quotes are required around all strings. When using Try it Out in Swagger, a list of source IDs separated by a + must be entered in the same item cell.

• source_names (List[str]) – A list of source names. Source names separated by a + indicate that both sources must be present in each element. Source names separated by a , indicate that at least one source must be present in each element. If there is not at least one resource that matches each source_name element, an error is returned. Single quotes are required around all strings. When using Try it Out in Swagger, a list of source names separated by a + must be entered in the same item cell.

• target_ids (List[str]) – A list of target IDs. Target IDs separated by a + indicate that both targets must be present in each element. Target IDs separated by a , indicate that at least one target must be present in each element. If there is not at least one resource that matches each target_id element, an error is returned. Single quotes are required around all strings. When using Try it Out in Swagger, a list of target IDs separated by a + must be entered in the same item cell.

• target_names (List[str]) – A list of target names. Target names separated by a + indicate that both targets must be present in each element. Target names separated by a , indicate that at least one target must be present in each element. If there is not at least one resource that matches each target_name element, an error is returned. Single quotes are required around all strings. When using Try it Out in Swagger, a list of target names separated by a + must be entered in the same item cell.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_buckets(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Get buckets

Retrieves buckets.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• authorization (str) – Deprecated. Please use Client level authorization

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.

• filter (str) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.

• ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. Single quotes are required around all strings.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each name element, an error is returned. Single quotes are required around all strings.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_controllers(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Get controllers

Retrieves information about controllers.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• authorization (str) – Deprecated. Please use Client level authorization

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.

• filter (str) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.

• ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. Single quotes are required around all strings.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each name element, an error is returned. Single quotes are required around all strings.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_directories(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, file_systems: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Get managed directories

Retrieves information about FlashArray managed directory objects.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• file_systems (ReferenceType or List[ReferenceType], optional) – A list of file_systems to query for. Overrides file_system_ids and file_system_names keyword arguments.

• authorization (str) – Deprecated. Please use Client level authorization

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.

• file_system_ids (List[str]) – Performs the operation on the file system ID specified. Enter multiple file system IDs in comma-separated format. The file_system_ids and file_system_names parameters cannot be provided together. Single quotes are required around all strings.

• file_system_names (List[str]) – Performs the operation on the file system name specified. Enter multiple file system names in comma-separated format. For example, filesystem1,filesystem2. The file_system_ids and file_system_names parameters cannot be provided together. Single quotes are required around all strings.

• filter (str) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.

• ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. Single quotes are required around all strings.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each name element, an error is returned. Single quotes are required around all strings.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_drives(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Get drives

Retrieves information about FlashArray drives.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• authorization (str) – Deprecated. Please use Client level authorization

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.

• filter (str) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.

• ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. Single quotes are required around all strings.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each name element, an error is returned. Single quotes are required around all strings.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_file_system_replica_links(targets: Optional[Union[ReferenceType, List[ReferenceType]]] = None, sources: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = None, target_ids: Optional[ConstrainedListValue[StrictStr]] = None, target_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Get FlashBlade file system replica links

Retrieves information about FlashBlade file system replica links.

Parameters

• targets (ReferenceType or List[ReferenceType], optional) – A list of targets to query for. Overrides target_ids and target_names keyword arguments.

• sources (ReferenceType or List[ReferenceType], optional) – A list of sources to query for. Overrides source_ids and source_names keyword arguments.

• members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids keyword argument.

• authorization (str) – Deprecated. Please use Client level authorization

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.

• filter (str) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.

• ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. Single quotes are required around all strings.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.

• member_ids (List[str]) – A list of member IDs. Member IDs separated by a + indicate that both members must be present in each element. Member IDs separated by a , indicate that at least one member must be present in each element. If there is not at least one resource that matches each member_id element, an error is returned. Single quotes are required around all strings. When using Try it Out in Swagger, a list of member IDs separated by a + must be entered in the same item cell.

• member_names (List[str]) – A list of member names. Member names separated by a + indicate that both members must be present in each element. Member names separated by a , indicate that at least one member must be present in each element. If there is not at least one resource that matches each member_name element, an error is returned. Single quotes are required around all strings. When using Try it Out in Swagger, a list of member names separated by a + must be entered in the same item cell.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.

• source_ids (List[str]) – A list of source IDs. Source IDs separated by a + indicate that both sources must be present in each element. Source IDs separated by a , indicate that at least one source must be present in each element. If there is not at least one resource that matches each source_id element, an error is returned. Single quotes are required around all strings. When using Try it Out in Swagger, a list of source IDs separated by a + must be entered in the same item cell.

• source_names (List[str]) – A list of source names. Source names separated by a + indicate that both sources must be present in each element. Source names separated by a , indicate that at least one source must be present in each element. If there is not at least one resource that matches each source_name element, an error is returned. Single quotes are required around all strings. When using Try it Out in Swagger, a list of source names separated by a + must be entered in the same item cell.

• target_ids (List[str]) – A list of target IDs. Target IDs separated by a + indicate that both targets must be present in each element. Target IDs separated by a , indicate that at least one target must be present in each element. If there is not at least one resource that matches each target_id element, an error is returned. Single quotes are required around all strings. When using Try it Out in Swagger, a list of target IDs separated by a + must be entered in the same item cell.

• target_names (List[str]) – A list of target names. Target names separated by a + indicate that both targets must be present in each element. Target names separated by a , indicate that at least one target must be present in each element. If there is not at least one resource that matches each target_name element, an error is returned. Single quotes are required around all strings. When using Try it Out in Swagger, a list of target names separated by a + must be entered in the same item cell.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_file_system_replica_links_policies(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[StrictInt] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Get FlashBlade file system replica link / policy pairs

Retrieves pairs of FlashBlade file system replica link members and their policies.

Parameters

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

• authorization (str) – Deprecated. Please use Client level authorization

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.

• filter (str) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.

• member_ids (List[str]) – A comma-separated list of member IDs. If there is not at least one resource that matches each member_id element, an error is returned. Single quotes are required around all strings.

• member_names (List[str]) – A comma-separated list of member names. If there is not at least one resource that matches each member_name element, an error is returned. Single quotes are required around all strings.

• offset (int) – The offset of the first resource to return from a collection.

• policy_ids (List[str]) – A comma-separated list of policy IDs. If there is not at least one resource that matches each policy_id element, an error is returned. Single quotes are required around all strings.

• policy_names (List[str]) – A comma-separated list of policy names. If there is not at least one resource that matches each policy_name element, an error is returned. Single quotes are required around all strings.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_file_system_snapshots(sources: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Get FlashBlade file system snapshots

Retrieves snapshots of FlashBlade file systems.

Parameters

• sources (ReferenceType or List[ReferenceType], optional) – A list of sources to query for. Overrides source_ids and source_names keyword arguments.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• authorization (str) – Deprecated. Please use Client level authorization

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.

• filter (str) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.

• ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. Single quotes are required around all strings.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each name element, an error is returned. Single quotes are required around all strings.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.

• source_ids (List[str]) – A comma-separated list of ids for the source of the object. If there is not at least one resource that matches each source_id element, an error is returned. Single quotes are required around all strings.

• source_names (List[str]) – A comma-separated list of names for the source of the object. If there is not at least one resource that matches each source_name element, an error is returned. Single quotes are required around all strings.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_file_system_snapshots_policies(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[StrictInt] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Get FlashBlade file system snapshot / policy pairs

Retrieves pairs of FlashBlade file system snapshot members and their policies.

Parameters

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

• authorization (str) – Deprecated. Please use Client level authorization

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.

• filter (str) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.

• member_ids (List[str]) – A comma-separated list of member IDs. If there is not at least one resource that matches each member_id element, an error is returned. Single quotes are required around all strings.

• member_names (List[str]) – A comma-separated list of member names. If there is not at least one resource that matches each member_name element, an error is returned. Single quotes are required around all strings.

• offset (int) – The offset of the first resource to return from a collection.

• policy_ids (List[str]) – A comma-separated list of policy IDs. If there is not at least one resource that matches each policy_id element, an error is returned. Single quotes are required around all strings.

• policy_names (List[str]) – A comma-separated list of policy names. If there is not at least one resource that matches each policy_name element, an error is returned. Single quotes are required around all strings.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_file_systems(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Get FlashArray and FlashBlade file systems

Retrieves information about FlashArray and FlashBlade file system objects.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• authorization (str) – Deprecated. Please use Client level authorization

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.

• filter (str) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.

• ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. Single quotes are required around all strings.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each name element, an error is returned. Single quotes are required around all strings.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_file_systems_policies(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[StrictInt] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Get FlashBlade file system / policy pairs

Retrieves pairs of FlashBlade file system members and their policies.

Parameters

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

• authorization (str) – Deprecated. Please use Client level authorization

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.

• filter (str) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.

• member_ids (List[str]) – A comma-separated list of member IDs. If there is not at least one resource that matches each member_id element, an error is returned. Single quotes are required around all strings.

• member_names (List[str]) – A comma-separated list of member names. If there is not at least one resource that matches each member_name element, an error is returned. Single quotes are required around all strings.

• offset (int) – The offset of the first resource to return from a collection.

• policy_ids (List[str]) – A comma-separated list of policy IDs. If there is not at least one resource that matches each policy_id element, an error is returned. Single quotes are required around all strings.

• policy_names (List[str]) – A comma-separated list of policy names. If there is not at least one resource that matches each policy_name element, an error is returned. Single quotes are required around all strings.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_hardware(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Get hardware

Retrieves information about hardware components.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• authorization (str) – Deprecated. Please use Client level authorization

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.

• filter (str) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.

• ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. Single quotes are required around all strings.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each name element, an error is returned. Single quotes are required around all strings.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_hardware_connectors(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Get hardware connectors

Retrieves information about FlashBlade hardware connectors.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• authorization (str) – Deprecated. Please use Client level authorization

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.

• filter (str) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.

• ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. Single quotes are required around all strings.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each name element, an error is returned. Single quotes are required around all strings.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_invoices(subscriptions: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, offset: Optional[ConstrainedIntValue] = None, partner_purchase_orders: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, subscription_ids: Optional[ConstrainedListValue[StrictStr]] = None, subscription_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Get invoices

Retrieves information about Pure1 subscription invoices.

Parameters

• subscriptions (ReferenceType or List[ReferenceType], optional) – A list of subscriptions to query for. Overrides subscription_ids and subscription_names keyword arguments.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids keyword argument.

• authorization (str) – Deprecated. Please use Client level authorization

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.

• filter (str) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.

• ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. Single quotes are required around all strings.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.

• offset (int) – The offset of the first resource to return from a collection.

• partner_purchase_orders (List[str]) – A comma-separated list of partner purchase order numbers. If there is not at least one resource that matches each partner_purchase_order element, an error is returned. Single quotes are required around all strings.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.

• subscription_ids (List[str]) – A comma-separated list of subscription IDs. If there is not at least one resource that matches each subscription.id element, an error is returned. Single quotes are required around all strings.

• subscription_names (List[str]) – A comma-separated list of subscription names. If there is not at least one resource that matches each subscription.name element, an error is returned. Single quotes are required around all strings.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_metrics(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, resource_types: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Get metrics

Retrieves information about metrics that can be queried for.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• authorization (str) – Deprecated. Please use Client level authorization

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.

• filter (str) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.

• ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. Single quotes are required around all strings.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each name element, an error is returned. Single quotes are required around all strings.

• offset (int) – The offset of the first resource to return from a collection.

• resource_types (List[str]) – The resource types to list the available metrics. Valid values are arrays, buckets, directories, file-systems, pods, subscription-licenses and volumes. A metric can belong to a combination of resources, e.g., write-iops from array to pod. In that case, query by [‘arrays’, ‘pods’]. Single quotes are required around all strings.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_metrics_history(aggregation: StrictStr, end_time: StrictInt, resolution: StrictInt, start_time: StrictInt, resources: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, resource_ids: Optional[ConstrainedListValue[StrictStr]] = None, resource_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Get metrics history

Retrieves historical metric data for resources. This endpoint supports batching: Up to 32 time series can be retrieved in one call. It can be multiple metrics for one resource, (e.g., load and bandwidth for one array - 2 time series), one metric for multiple resource (e.g., load for arrayA and arrayB - 2 time series), or a combination of both, multiple metrics for multiple resources, (e.g., load and bandwidth for arrayA and arrayB - 4 time series).

Parameters

• aggregation (str) – Aggregation needed on the metric data. Valid values are avg and max. Single quotes are required around all strings. Latency metrics averages are weighted by the IOPS. (required)

• end_time (int) – Timestamp of when the time window ends. Measured in milliseconds since the UNIX epoch. (required)

• resolution (int) – The duration of time between individual data points, in milliseconds. (required)

• start_time (int) – Timestamp of when the time window starts. Measured in milliseconds since the UNIX epoch. (required)

• resources (ReferenceType or List[ReferenceType], optional) – A list of resources to query for. Overrides resource_ids and resource_names keyword arguments.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• authorization (str) – Deprecated. Please use Client level authorization

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – REQUIRED: either ids or names. A comma-separated list of object IDs. If there is not at least one resource that matches each id element, an error is returned. Single quotes are required around all strings.

• names (List[str]) – REQUIRED: either names or ids. A comma-separated list of resource names. If there is not at least one resource that matches each name element, an error is returned. Single quotes are required around all strings.

• resource_ids (List[str]) – REQUIRED: either resource_ids or resource_names. A comma-separated list of resource IDs. If there is not at least one resource that matches each resource_id element, an error is returned. Single quotes are required around all strings.

• resource_names (List[str]) – REQUIRED: either resource_ids or resource_names. A comma-separated list of resource names. If there is not at least one resource that matches each resource_name element, an error is returned. Single quotes are required around all strings.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_network_interfaces(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Get network interfaces

Retrieves information about physical and virtual network interface objects.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• authorization (str) – Deprecated. Please use Client level authorization

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.

• filter (str) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.

• ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. Single quotes are required around all strings.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each name element, an error is returned. Single quotes are required around all strings.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_object_store_accounts(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Get object store accounts

Retrieves object store accounts.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• authorization (str) – Deprecated. Please use Client level authorization

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.

• filter (str) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.

• ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. Single quotes are required around all strings.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each name element, an error is returned. Single quotes are required around all strings.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_pod_replica_links(targets: Optional[Union[ReferenceType, List[ReferenceType]]] = None, sources: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = None, target_ids: Optional[ConstrainedListValue[StrictStr]] = None, target_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Get pod replica links

Retrieves information about pod replica links.

Parameters

• targets (ReferenceType or List[ReferenceType], optional) – A list of targets to query for. Overrides target_ids and target_names keyword arguments.

• sources (ReferenceType or List[ReferenceType], optional) – A list of sources to query for. Overrides source_ids and source_names keyword arguments.

• members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids keyword argument.

• authorization (str) – Deprecated. Please use Client level authorization

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.

• filter (str) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.

• ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. Single quotes are required around all strings.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.

• member_ids (List[str]) – A list of member IDs. Member IDs separated by a + indicate that both members must be present in each element. Member IDs separated by a , indicate that at least one member must be present in each element. If there is not at least one resource that matches each member_id element, an error is returned. Single quotes are required around all strings. When using Try it Out in Swagger, a list of member IDs separated by a + must be entered in the same item cell.

• member_names (List[str]) – A list of member names. Member names separated by a + indicate that both members must be present in each element. Member names separated by a , indicate that at least one member must be present in each element. If there is not at least one resource that matches each member_name element, an error is returned. Single quotes are required around all strings. When using Try it Out in Swagger, a list of member names separated by a + must be entered in the same item cell.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.

• source_ids (List[str]) – A list of source IDs. Source IDs separated by a + indicate that both sources must be present in each element. Source IDs separated by a , indicate that at least one source must be present in each element. If there is not at least one resource that matches each source_id element, an error is returned. Single quotes are required around all strings. When using Try it Out in Swagger, a list of source IDs separated by a + must be entered in the same item cell.

• source_names (List[str]) – A list of source names. Source names separated by a + indicate that both sources must be present in each element. Source names separated by a , indicate that at least one source must be present in each element. If there is not at least one resource that matches each source_name element, an error is returned. Single quotes are required around all strings. When using Try it Out in Swagger, a list of source names separated by a + must be entered in the same item cell.

• target_ids (List[str]) – A list of target IDs. Target IDs separated by a + indicate that both targets must be present in each element. Target IDs separated by a , indicate that at least one target must be present in each element. If there is not at least one resource that matches each target_id element, an error is returned. Single quotes are required around all strings. When using Try it Out in Swagger, a list of target IDs separated by a + must be entered in the same item cell.

• target_names (List[str]) – A list of target names. Target names separated by a + indicate that both targets must be present in each element. Target names separated by a , indicate that at least one target must be present in each element. If there is not at least one resource that matches each target_name element, an error is returned. Single quotes are required around all strings. When using Try it Out in Swagger, a list of target names separated by a + must be entered in the same item cell.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_pods(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Get pods

Retrieves information about pod objects.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• authorization (str) – Deprecated. Please use Client level authorization

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.

• filter (str) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.

• ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. Single quotes are required around all strings.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each name element, an error is returned. Single quotes are required around all strings.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_policies(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Get policies

Retrieves policies and their rules.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• authorization (str) – Deprecated. Please use Client level authorization

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.

• filter (str) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.

• ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. Single quotes are required around all strings.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each name element, an error is returned. Single quotes are required around all strings.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_policies_file_system_replica_links(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[StrictInt] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Get policy / FlashBlade file system replica link pairs

Retrieves pairs of policy references and their FlashBlade file system replica link members.

Parameters

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

• authorization (str) – Deprecated. Please use Client level authorization

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.

• filter (str) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.

• member_ids (List[str]) – A comma-separated list of member IDs. If there is not at least one resource that matches each member_id element, an error is returned. Single quotes are required around all strings.

• member_names (List[str]) – A comma-separated list of member names. If there is not at least one resource that matches each member_name element, an error is returned. Single quotes are required around all strings.

• offset (int) – The offset of the first resource to return from a collection.

• policy_ids (List[str]) – A comma-separated list of policy IDs. If there is not at least one resource that matches each policy_id element, an error is returned. Single quotes are required around all strings.

• policy_names (List[str]) – A comma-separated list of policy names. If there is not at least one resource that matches each policy_name element, an error is returned. Single quotes are required around all strings.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_policies_file_system_snapshots(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[StrictInt] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Get policy / FlashBlade file system snapshot pairs

Retrieves pairs of policy references and their FlashBlade file system snapshot members.

Parameters

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

• authorization (str) – Deprecated. Please use Client level authorization

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.

• filter (str) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.

• member_ids (List[str]) – A comma-separated list of member IDs. If there is not at least one resource that matches each member_id element, an error is returned. Single quotes are required around all strings.

• member_names (List[str]) – A comma-separated list of member names. If there is not at least one resource that matches each member_name element, an error is returned. Single quotes are required around all strings.

• offset (int) – The offset of the first resource to return from a collection.

• policy_ids (List[str]) – A comma-separated list of policy IDs. If there is not at least one resource that matches each policy_id element, an error is returned. Single quotes are required around all strings.

• policy_names (List[str]) – A comma-separated list of policy names. If there is not at least one resource that matches each policy_name element, an error is returned. Single quotes are required around all strings.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_policies_file_systems(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[StrictInt] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Get policy / FlashBlade file system pairs

Retrieves pairs of policy references and their FlashBlade file system members.

Parameters

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

• authorization (str) – Deprecated. Please use Client level authorization

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.

• filter (str) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.

• member_ids (List[str]) – A comma-separated list of member IDs. If there is not at least one resource that matches each member_id element, an error is returned. Single quotes are required around all strings.

• member_names (List[str]) – A comma-separated list of member names. If there is not at least one resource that matches each member_name element, an error is returned. Single quotes are required around all strings.

• offset (int) – The offset of the first resource to return from a collection.

• policy_ids (List[str]) – A comma-separated list of policy IDs. If there is not at least one resource that matches each policy_id element, an error is returned. Single quotes are required around all strings.

• policy_names (List[str]) – A comma-separated list of policy names. If there is not at least one resource that matches each policy_name element, an error is returned. Single quotes are required around all strings.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_policies_members(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[StrictInt] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Get policy / member pairs

Retrieves pairs of policy references and their members.

Parameters

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

• authorization (str) – Deprecated. Please use Client level authorization

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.

• filter (str) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.

• member_ids (List[str]) – A comma-separated list of member IDs. If there is not at least one resource that matches each member_id element, an error is returned. Single quotes are required around all strings.

• member_names (List[str]) – A comma-separated list of member names. If there is not at least one resource that matches each member_name element, an error is returned. Single quotes are required around all strings.

• offset (int) – The offset of the first resource to return from a collection.

• policy_ids (List[str]) – A comma-separated list of policy IDs. If there is not at least one resource that matches each policy_id element, an error is returned. Single quotes are required around all strings.

• policy_names (List[str]) – A comma-separated list of policy names. If there is not at least one resource that matches each policy_name element, an error is returned. Single quotes are required around all strings.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_ports(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Get ports

Retrieves information about FlashArray ports.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• authorization (str) – Deprecated. Please use Client level authorization

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.

• filter (str) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.

• ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. Single quotes are required around all strings.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each name element, an error is returned. Single quotes are required around all strings.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_subscription_assets(subscriptions: Optional[Union[ReferenceType, List[ReferenceType]]] = None, licenses: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, advanced_space: Optional[StrictBool] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, license_ids: Optional[ConstrainedListValue[StrictStr]] = None, license_names: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, subscription_ids: Optional[ConstrainedListValue[StrictStr]] = None, subscription_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Get subscription assets

Retrieves information about Pure1 subscription assets.

Parameters

• subscriptions (ReferenceType or List[ReferenceType], optional) – A list of subscriptions to query for. Overrides subscription_ids and subscription_names keyword arguments.

• licenses (ReferenceType or List[ReferenceType], optional) – A list of licenses to query for. Overrides license_ids and license_names keyword arguments.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• authorization (str) – Deprecated. Please use Client level authorization

• x_request_id (str) – Supplied by client during request or generated by server.

• advanced_space (bool) – If true, returns the advanced_space field containing physical and effective space information.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.

• filter (str) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.

• ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. Single quotes are required around all strings.

• license_ids (List[str]) – A comma-separated list of subscriptionLicense IDs. If there is not at least one resource that matches each license.id element, an error is returned. Single quotes are required around all strings.

• license_names (List[str]) – A comma-separated list of subscriptionLicense names. If there is not at least one resource that matches each license.name element, an error is returned. Single quotes are required around all strings.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each name element, an error is returned. Single quotes are required around all strings.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.

• subscription_ids (List[str]) – A comma-separated list of subscription IDs. If there is not at least one resource that matches each subscription.id element, an error is returned. Single quotes are required around all strings.

• subscription_names (List[str]) – A comma-separated list of subscription names. If there is not at least one resource that matches each subscription.name element, an error is returned. Single quotes are required around all strings.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_subscription_licenses(subscriptions: Optional[Union[ReferenceType, List[ReferenceType]]] = None, marketplace_partner_references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, marketplace_partner_reference_ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, subscription_ids: Optional[ConstrainedListValue[StrictStr]] = None, subscription_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Get subscription licenses

Retrieves information about Pure1 subscription licenses.

Parameters

• subscriptions (ReferenceType or List[ReferenceType], optional) – A list of subscriptions to query for. Overrides subscription_ids and subscription_names keyword arguments.

• marketplace_partner_references (ReferenceType or List[ReferenceType], optional) – A list of marketplace_partner_references to query for. Overrides marketplace_partner_reference_ids keyword argument.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• authorization (str) – Deprecated. Please use Client level authorization

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.

• filter (str) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.

• ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. Single quotes are required around all strings.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.

• marketplace_partner_reference_ids (List[str]) – A comma-separated list of marketplace partner reference IDs. If there is not at least one resource that matches each marketplace_partner.reference_id element, an error is returned. Single quotes are required around all strings.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each name element, an error is returned. Single quotes are required around all strings.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.

• subscription_ids (List[str]) – A comma-separated list of subscription IDs. If there is not at least one resource that matches each subscription.id element, an error is returned. Single quotes are required around all strings.

• subscription_names (List[str]) – A comma-separated list of subscription names. If there is not at least one resource that matches each subscription.name element, an error is returned. Single quotes are required around all strings.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_subscriptions(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Get subscriptions

Retrieves information about Pure1 subscriptions.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• authorization (str) – Deprecated. Please use Client level authorization

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.

• filter (str) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.

• ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. Single quotes are required around all strings.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each name element, an error is returned. Single quotes are required around all strings.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_targets(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Get targets

Retrieves information about targets.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• authorization (str) – Deprecated. Please use Client level authorization

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.

• filter (str) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.

• ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. Single quotes are required around all strings.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each name element, an error is returned. Single quotes are required around all strings.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_volume_snapshots(sources: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Get volume snapshots

Retrieves information about snapshots of volumes.

Parameters

• sources (ReferenceType or List[ReferenceType], optional) – A list of sources to query for. Overrides source_ids and source_names keyword arguments.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• authorization (str) – Deprecated. Please use Client level authorization

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.

• filter (str) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.

• ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. Single quotes are required around all strings.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each name element, an error is returned. Single quotes are required around all strings.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.

• source_ids (List[str]) – A comma-separated list of ids for the source of the object. If there is not at least one resource that matches each source_id element, an error is returned. Single quotes are required around all strings.

• source_names (List[str]) – A comma-separated list of names for the source of the object. If there is not at least one resource that matches each source_name element, an error is returned. Single quotes are required around all strings.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_volumes(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[StrictInt] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Get volumes

Retrieves information about FlashArray volume objects.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• authorization (str) – Deprecated. Please use Client level authorization

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result. Single quotes are required around all strings.

• filter (str) – Exclude resources that don’t match the specified criteria. Single quotes are required around all strings inside the filters.

• ids (List[str]) – A comma-separated list of resource IDs. If there is not at least one resource that matches each id element, an error is returned. Single quotes are required around all strings.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request. If not specified, defaults to 1000.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each name element, an error is returned. Single quotes are required around all strings.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). If you provide a sort you will not get a continuation token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

put_arrays_tags(tag_put: ConstrainedListValue[models.TagPut], resources: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, namespaces: Optional[ConstrainedListValue[StrictStr]] = None, resource_ids: Optional[ConstrainedListValue[StrictStr]] = None, resource_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Create or update array tags

Creates or updates array tags contextual to Pure1 only.

Parameters

• tag_put (List[TagPut]) – (required)

• resources (ReferenceType or List[ReferenceType], optional) – A list of resources to query for. Overrides resource_ids and resource_names keyword arguments.

• authorization (str) – Deprecated. Please use Client level authorization

• x_request_id (str) – Supplied by client during request or generated by server.

• namespaces (List[str]) – A comma-separated list of namespaces. Single quotes are required around all strings.

• resource_ids (List[str]) – REQUIRED: either resource_ids or resource_names. A comma-separated list of resource IDs. If there is not at least one resource that matches each resource_id element, an error is returned. Single quotes are required around all strings.

• resource_names (List[str]) – REQUIRED: either resource_ids or resource_names. A comma-separated list of resource names. If there is not at least one resource that matches each resource_name element, an error is returned. Single quotes are required around all strings.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

Properties

Property

class pypureclient.pure1.Property(value)

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

__add__(other)

The + operator. Create a subproperty.

Parameters

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

Returns

Property

Raises

PureError – If other is not of the proper type.

__eq__(other)

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

Parameters

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

Returns

Filter

Raises

PureError – If other is not of the proper type.

__ge__(other)

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

Parameters

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

Returns

Filter

Raises

PureError – If other is not of the proper type.

__getitem__(index)

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

Parameters

index (str) – The list index to use.

Returns

Property

Raises

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

__gt__(other)

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

Parameters

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

Returns

Filter

Raises

PureError – If other is not of the proper type.

__init__(value)

Initialize a Property.

Parameters

value (str) – The name of the property.

__le__(other)

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

Parameters

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

Returns

Filter

Raises

PureError – If other is not of the proper type.

__lt__(other)

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

Parameters

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

Returns

Filter

Raises

PureError – If other is not of the proper type.

__ne__(other)

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

Parameters

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

Returns

Filter

Raises

PureError – If other is not of the proper type.

__repr__()

Return the string value of the Property.

Returns

str

all()

Create a list Property indexed by “all”.

Returns

Property

any()

Create a list Property indexed by “any”.

Returns

Property

ascending()

Create a Property that can be sorted in ascending order.

Returns

Property

descending()

Create a property that can be sorted in descending order.

Returns

Property

exists()

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

Returns

Filter

subproperty(other)

Create a subproperty.

Parameters

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

Returns

Property

Raises

PureError – If other is not of the proper type.

Filter

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

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

__and__(other)

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

Parameters

other (Filter) – The Filter to AND.

Returns

Filter

Raises

PureError – If other is not of the proper type.

__init__(operation, operand1, operand2=None)

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

Parameters

• operation (_Operation) – The operation.

• operand1 (any) – The first operand.

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

__invert__()

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

Returns

Filter

__or__(other)

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

Parameters

other (Filter) – The Filter to OR.

Returns

Filter

Raises

PureError – If other is not of the proper type.

__repr__()

Return the string value of the Filter.

Returns

str

static and_(operand1, operand2)

Create a Filter that is the AND of two Filters.

Parameters

• operand1 (Filter) – The first Filter.

• operand2 (Filter) – The second Filter.

Returns

Filter

Raises

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

static contains(operand1, operand2)

Create a Filter that checks for substring containment.

Parameters

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

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

Returns

Filter

Raises

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

static eq(operand1, operand2)

Create a Filter that checks for equality.

Parameters

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

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

Returns

Filter

Raises

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

static exists(operand1)

Create a Filter that checks for existance of a Property.

Parameters

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

Returns

Filter

Raises

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

static ge(operand1, operand2)

Create a Filter that checks for greater than or equal.

Parameters

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

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

Returns

Filter

Raises

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

static gt(operand1, operand2)

Create a Filter that checks for greater than.

Parameters

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

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

Returns

Filter

Raises

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

static in_(operand1, operand2)

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

Parameters

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

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

Returns

Filter

Raises

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

static le(operand1, operand2)

Create a Filter that checks for less than or equal.

Parameters

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

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

Returns

Filter

Raises

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

static lt(operand1, operand2)

Create a Filter that checks for less than.

Parameters

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

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

Returns

Filter

Raises

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

static ne(operand1, operand2)

Create a Filter that checks for inequality.

Parameters

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

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

Returns

Filter

Raises

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

static not_(operand1)

Create a Filter that is the inverse of another Filter.

Parameters

operand1 (Filter) – The Filter to invert.

Returns

Filter

Raises

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

static or_(operand1, operand2)

Create a Filter that is the OR of two Filters.

Parameters

• operand1 (Filter) – The first Filter.

• operand2 (Filter) – The second Filter.

Returns

Filter

Raises

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

static tags(operand1, operand2)

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

Parameters

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

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

Returns

Filter

Raises

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

Responses

ResponseHeaders

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

An object that includes headers from the server response.

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

Initialize a ResponseHeaders.

Parameters

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

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

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

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

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

__repr__()

Return a pretty formatted string of the object.

Returns

str

to_dict()

Return a dictionary of the class attributes.

Returns

dict

ValidResponse

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

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

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

Initialize a ValidResponse.

Parameters

• status_code (int) – The HTTP status code.

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

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

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

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

__repr__()

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

Returns

str

to_dict()

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

Returns

dict

ApiError

class pypureclient.pure1.ApiError(context, message, location_context=None)

An object that models the error response from the server.

__init__(context, message, location_context=None)

Initialize an ApiError.

Parameters

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

• message (str) – The error message.

• location_context (str) – The execution context where the error occurred.

__repr__()

Return a pretty formatted string of the object.

Returns

str

to_dict()

Return a dictionary of the class attributes.

Returns

dict

ErrorResponse

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

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

__init__(status_code, errors, headers)

Initialize an ErrorResponse.

Parameters

• status_code (int) – The HTTP status code.

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

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

__repr__()

Return a pretty formatted string of the object.

Returns

str

to_dict()

Return a dictionary of the class attributes.

Returns

dict

Models

ReferenceType

pydantic model pypureclient.pure1.ReferenceType(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None)

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.

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified.

field name: Optional[StrictStr] = None

The resource name, such as volume name, pod name, snapshot name, and so on.

Alert

pydantic model pypureclient.pure1.Alert(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None, actual: Optional[StrictStr] = None, category: Optional[StrictStr] = None, closed: Optional[StrictInt] = None, code: Optional[StrictInt] = None, component_name: Optional[StrictStr] = None, component_type: Optional[StrictStr] = None, created: Optional[StrictInt] = None, description: Optional[StrictStr] = None, expected: Optional[StrictStr] = None, knowledge_base_url: Optional[StrictStr] = None, notified: Optional[StrictInt] = None, origin: Optional[StrictStr] = None, severity: Optional[StrictStr] = None, state: Optional[StrictStr] = None, summary: Optional[StrictStr] = None, updated: Optional[StrictInt] = None)

field actual: Optional[StrictStr] = None

Actual condition at the time of the alert.

field arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None

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.

field as_of: Optional[StrictInt] = None (alias '_as_of')

The freshness of the data (timestamp in millis since epoch).

field category: Optional[StrictStr] = None

Category of the alert. Valid values are array, hardware, and software.

field closed: Optional[StrictInt] = None

Time when the alert was closed, in milliseconds since UNIX epoch.

field code: Optional[StrictInt] = None

Code associated with the alert.

field component_name: Optional[StrictStr] = None

Name of the component alerted about.

field component_type: Optional[StrictStr] = None

Type of the component alerted about.

field created: Optional[StrictInt] = None

Time when the alert was created, in milliseconds since UNIX epoch.

field description: Optional[StrictStr] = None

Short description of the alert.

field expected: Optional[StrictStr] = None

Expected state/threshold under normal conditions.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field knowledge_base_url: Optional[StrictStr] = None

URL of the relevant Knowledge Base page.

field name: Optional[StrictStr] = None

A modifiable, locally unique name chosen by the user.

field notified: Optional[StrictInt] = None

Time when the user was notified of the alert, in milliseconds since UNIX epoch.

field origin: Optional[StrictStr] = None

Origin of the alert. Valid values are array and Pure1.

field severity: Optional[StrictStr] = None

Current severity level. Valid values are info, warning, critical, and hidden.

field state: Optional[StrictStr] = None

Current state of the alert. Valid values are open, closing, and closed.

field summary: Optional[StrictStr] = None

Summary of the alert.

field updated: Optional[StrictInt] = None

Time when the alert was last updated, in milliseconds since UNIX epoch.

AlertsGetResponse

pydantic model pypureclient.pure1.AlertsGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Alert]] = None)

field continuation_token: Optional[StrictStr] = None

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

field items: Optional[ConstrainedListValue[Alert]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

AlertsResponse

pydantic model pypureclient.pure1.AlertsResponse(*, items: Optional[ConstrainedListValue[Alert]] = None)

field items: Optional[ConstrainedListValue[Alert]] = None

Array

pydantic model pypureclient.pure1.Array(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, fqdn: Optional[StrictStr] = None, model: Optional[StrictStr] = None, os: Optional[StrictStr] = None, version: Optional[StrictStr] = None)

field as_of: Optional[StrictInt] = None (alias '_as_of')

The freshness of the data (timestamp in millis since epoch).

field fqdn: Optional[StrictStr] = None

The fully qualified domain name of the array.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field model: Optional[StrictStr] = None

Model of the array.

field name: Optional[StrictStr] = None

A non-modifiable, locally unique name chosen by the system.

field os: Optional[StrictStr] = None

Valid values are Elasticity, Purity, Purity//FA and Purity//FB.

field version: Optional[StrictStr] = None

ArrayGetResponse

pydantic model pypureclient.pure1.ArrayGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Array]] = None)

field continuation_token: Optional[StrictStr] = None

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

field items: Optional[ConstrainedListValue[Array]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

ArrayResponse

pydantic model pypureclient.pure1.ArrayResponse(*, items: Optional[ConstrainedListValue[Array]] = None)

field items: Optional[ConstrainedListValue[Array]] = None

Arrays

pydantic model pypureclient.pure1.Arrays(*, arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None)

field arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None

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.

ArraysBuiltIn

pydantic model pypureclient.pure1.ArraysBuiltIn(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None)

A built-in resource that exists on one or multiple arrays.

field arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None

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.

field as_of: Optional[StrictInt] = None (alias '_as_of')

The freshness of the data (timestamp in millis since epoch).

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

A non-modifiable, locally unique name chosen by the system.

ArraysResource

pydantic model pypureclient.pure1.ArraysResource(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None)

A built-in resource that exists on one or multiple arrays.

field arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None

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.

field as_of: Optional[StrictInt] = None (alias '_as_of')

The freshness of the data (timestamp in millis since epoch).

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

A modifiable, locally unique name chosen by the user.

AssetAddress

pydantic model pypureclient.pure1.AssetAddress(*, city: Optional[StrictStr] = None, country: Optional[StrictStr] = None, state: Optional[StrictStr] = None, street_address: Optional[StrictStr] = None)

field city: Optional[StrictStr] = None

field country: Optional[StrictStr] = None

field state: Optional[StrictStr] = None

The state or province.

field street_address: Optional[StrictStr] = None

AssetOrg

pydantic model pypureclient.pure1.AssetOrg(*, name: Optional[StrictStr] = None)

field name: Optional[StrictStr] = None

This field has been deprecated. Use the customer_name field instead. The organization name for the asset.

AssetSpace

pydantic model pypureclient.pure1.AssetSpace(*, capacity: Optional[CurrentMetric] = None, total_used: Optional[CurrentMetric] = None, total_used_ratio: Optional[AssetSpaceTotalUsedRatio] = None)

field capacity: Optional[CurrentMetric] = None

The usable capacity of the appliance.

field total_used: Optional[CurrentMetric] = None

The total space contributed by customer data.

field total_used_ratio: Optional[AssetSpaceTotalUsedRatio] = None

AssetSpaceTotalUsedRatio

pydantic model pypureclient.pure1.AssetSpaceTotalUsedRatio(*, data: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, metric: Optional[FixedReference] = None, unit: Optional[StrictStr] = None)

The ratio of total_used to the capacity. This represents how full the appliance is.

field data: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

field metric: Optional[FixedReference] = None

A reference to the metric this data measures.

field unit: Optional[StrictStr] = None

The unit of the metric.

AssetUpgradeDetails

pydantic model pypureclient.pure1.AssetUpgradeDetails(*, action_needed: Optional[StrictStr] = None, commitment_date: Optional[StrictInt] = None, upgrade_eligibility_date: Optional[StrictInt] = None)

field action_needed: Optional[StrictStr] = None

The action required to obtain the next free upgrade under your Evergreen//Forever subscription.

field commitment_date: Optional[StrictInt] = None

The date until which you need to commit to an Evergreen//Forever subscription to be eligible for the next Ever Modern Upgrade.

field upgrade_eligibility_date: Optional[StrictInt] = None

The date on which controllers/blades will be eligible for an Ever Modern Upgrade if you renew your Evergreen//Forever subscription to the required Forever (FVR) Commitment date.

Audit

pydantic model pypureclient.pure1.Audit(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None, arguments: Optional[StrictStr] = None, command: Optional[StrictStr] = None, origin: Optional[StrictStr] = None, subcommand: Optional[StrictStr] = None, time: Optional[StrictInt] = None, user: Optional[StrictStr] = None)

field arguments: Optional[StrictStr] = None

Arguments provided to the command.

field arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None

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.

field as_of: Optional[StrictInt] = None (alias '_as_of')

The freshness of the data (timestamp in millis since epoch).

field command: Optional[StrictStr] = None

The command that was executed.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

A modifiable, locally unique name chosen by the user.

field origin: Optional[StrictStr] = None

Origin of the action. Valid values are array and Pure1.

field subcommand: Optional[StrictStr] = None

The subcommand that was executed.

field time: Optional[StrictInt] = None

Time at which the command was run in milliseconds since UNIX epoch.

field user: Optional[StrictStr] = None

The user who ran the command.

AuditsGetResponse

pydantic model pypureclient.pure1.AuditsGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Audit]] = None)

field continuation_token: Optional[StrictStr] = None

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

field items: Optional[ConstrainedListValue[Audit]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

AuditsResponse

pydantic model pypureclient.pure1.AuditsResponse(*, items: Optional[ConstrainedListValue[Audit]] = None)

field items: Optional[ConstrainedListValue[Audit]] = None

BaseAddress

pydantic model pypureclient.pure1.BaseAddress(*, city: Optional[StrictStr] = None, country: Optional[StrictStr] = None, state: Optional[StrictStr] = None)

field city: Optional[StrictStr] = None

field country: Optional[StrictStr] = None

field state: Optional[StrictStr] = None

The state or province.

Blade

pydantic model pypureclient.pure1.Blade(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, arrays: Optional[ConstrainedListValue[BladeArrayStatus]] = None, details: Optional[StrictStr] = None, raw_capacity: Optional[Union[StrictFloat, StrictInt]] = None, status: Optional[StrictStr] = None)

field arrays: Optional[ConstrainedListValue[BladeArrayStatus]] = None

A list of arrays that contain this blade. Each blade should only exist on one array.

Constraints

• minItems = 1

field as_of: Optional[StrictInt] = None (alias '_as_of')

The freshness of the data (timestamp in millis since epoch).

field details: Optional[StrictStr] = None

Extra details about the blade. Will be null if none exist.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

A non-modifiable, locally unique name chosen by the system.

field raw_capacity: Optional[Union[StrictFloat, StrictInt]] = None

The raw storage capacity of the blade.

field status: Optional[StrictStr] = None

Valid values are critical, evacuated, evacuating, healthy, identifying, unclaimed, unhealthy, unknown, unrecognized.

BladeArrayStatus

pydantic model pypureclient.pure1.BladeArrayStatus(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, resource_type: Optional[StrictStr] = None, fqdn: Optional[StrictStr] = None, total_blades: Optional[StrictInt] = None, used_blades: Optional[StrictInt] = None)

field fqdn: Optional[StrictStr] = None

The fully qualified domain name of the appliance when resource_type is arrays, null otherwise.

field id: Optional[StrictStr] = None

The opaque and unique id of this resource.

field name: Optional[StrictStr] = None

The name of this resource.

field resource_type: Optional[StrictStr] = None

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.

field total_blades: Optional[StrictInt] = None

Count of total blade slots in the array.

field used_blades: Optional[StrictInt] = None

Count of used blade slots in the array.

BladeGetResponse

pydantic model pypureclient.pure1.BladeGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Blade]] = None)

field continuation_token: Optional[StrictStr] = None

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

field items: Optional[ConstrainedListValue[Blade]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

BladeResponse

pydantic model pypureclient.pure1.BladeResponse(*, items: Optional[ConstrainedListValue[Blade]] = None)

field items: Optional[ConstrainedListValue[Blade]] = None

Bucket

pydantic model pypureclient.pure1.Bucket(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None, account: Optional[FixedReference] = None, created: Optional[StrictInt] = None, destroyed: Optional[StrictBool] = None, object_count: Optional[StrictInt] = None, versioning: Optional[StrictStr] = None)

field account: Optional[FixedReference] = None

field arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None

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.

field as_of: Optional[StrictInt] = None (alias '_as_of')

The freshness of the data (timestamp in millis since epoch).

field created: Optional[StrictInt] = None

Creation time of the bucket, in milliseconds since Unix epoch.

field destroyed: Optional[StrictBool] = None

Returns a value of true if the bucket is destroyed, but not yet eradicated.

Constraints

• type = boolean

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

A modifiable, locally unique name chosen by the user.

field object_count: Optional[StrictInt] = None

The number of objects contained within the bucket.

field versioning: Optional[StrictStr] = None

The versioning state for objects within the bucket. Valid values are none, enabled, and suspended.

BucketGetResponse

pydantic model pypureclient.pure1.BucketGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Bucket]] = None)

field continuation_token: Optional[StrictStr] = None

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

field items: Optional[ConstrainedListValue[Bucket]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

BucketReplicaLink

pydantic model pypureclient.pure1.BucketReplicaLink(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, lag: Optional[StrictInt] = None, paused: Optional[StrictBool] = None, recovery_point: Optional[StrictInt] = None, status: Optional[StrictStr] = None, members: Optional[ConstrainedListValue[ResourceWithLocation]] = None, sources: Optional[ConstrainedListValue[ResourceWithLocation]] = None, status_details: Optional[StrictStr] = None, targets: Optional[ConstrainedListValue[ResourceWithLocation]] = None)

A replica link between two buckets.

field as_of: Optional[StrictInt] = None (alias '_as_of')

The freshness of the data (timestamp in millis since epoch).

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field lag: Optional[StrictInt] = None

Duration, in milliseconds, which represents how far behind the replication target is from the source.

field members: Optional[ConstrainedListValue[ResourceWithLocation]] = None

The union of source and target buckets in the replica link.

field paused: Optional[StrictBool] = None

Returns true if the replica link is paused.

Constraints

• type = boolean

field recovery_point: Optional[StrictInt] = None

Time when the last piece of data was replicated, in milliseconds since the UNIX epoch, and the recovery point of the bucket.

field sources: Optional[ConstrainedListValue[ResourceWithLocation]] = None

The source buckets in the replica link.

field status: Optional[StrictStr] = None

Status of the replica link. Values include replicating, idle, and unhealthy.

field status_details: Optional[StrictStr] = None

Detailed information about the status of the replica link when it is unhealthy.

field targets: Optional[ConstrainedListValue[ResourceWithLocation]] = None

The target buckets in the replica link.

BucketReplicaLinkGetResponse

pydantic model pypureclient.pure1.BucketReplicaLinkGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[BucketReplicaLink]] = None)

field continuation_token: Optional[StrictStr] = None

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

field items: Optional[ConstrainedListValue[BucketReplicaLink]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

BucketReplicaLinkResponse

pydantic model pypureclient.pure1.BucketReplicaLinkResponse(*, items: Optional[ConstrainedListValue[BucketReplicaLink]] = None)

field items: Optional[ConstrainedListValue[BucketReplicaLink]] = None

BucketResponse

pydantic model pypureclient.pure1.BucketResponse(*, items: Optional[ConstrainedListValue[Bucket]] = None)

field items: Optional[ConstrainedListValue[Bucket]] = None

BuiltInAsOf

pydantic model pypureclient.pure1.BuiltInAsOf(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None)

A built-in resource. Many are singletons predefined by Purity (e.g., support settings). Some correspond to a piece of software, like an app, or hardware, like a controller. Others are created by the system in response to some event (e.g., alerts, audit records). Typically, a user can’t create, delete or rename a built-in resource. A few can be created or deleted, but not renamed because the names are meaningful to Purity (e.g., VIFs).

field as_of: Optional[StrictInt] = None (alias '_as_of')

The freshness of the data (timestamp in millis since epoch).

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

A non-modifiable, locally unique name chosen by the system.

Controller

pydantic model pypureclient.pure1.Controller(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None, mode: Optional[StrictStr] = None, model: Optional[StrictStr] = None, status: Optional[StrictStr] = None, type: Optional[StrictStr] = None, version: Optional[StrictStr] = None)

field arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None

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.

field as_of: Optional[StrictInt] = None (alias '_as_of')

The freshness of the data (timestamp in millis since epoch).

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field mode: Optional[StrictStr] = None

Mode of the controller. Values include not present, offline, primary, and secondary.

field model: Optional[StrictStr] = None

Model of the controller.

field name: Optional[StrictStr] = None

A non-modifiable, locally unique name chosen by the system.

field status: Optional[StrictStr] = None

Status of the controller. Values include not ready, ready, unknown, and updating.

field type: Optional[StrictStr] = None

Type of the controller. Values include array_controller and shelf_controller.

field version: Optional[StrictStr] = None

Version of the controller.

ControllerGetResponse

pydantic model pypureclient.pure1.ControllerGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Controller]] = None)

field continuation_token: Optional[StrictStr] = None

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

field items: Optional[ConstrainedListValue[Controller]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

ControllerResponse

pydantic model pypureclient.pure1.ControllerResponse(*, items: Optional[ConstrainedListValue[Controller]] = None)

field items: Optional[ConstrainedListValue[Controller]] = None

CurrentMetric

pydantic model pypureclient.pure1.CurrentMetric(*, data: Optional[Union[StrictFloat, StrictInt]] = None, metric: Optional[FixedReference] = None, unit: Optional[StrictStr] = None)

field data: Optional[Union[StrictFloat, StrictInt]] = None

The data value.

field metric: Optional[FixedReference] = None

A reference to the metric this data measures.

field unit: Optional[StrictStr] = None

The unit of the metric.

Directory

pydantic model pypureclient.pure1.Directory(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None, created: Optional[StrictInt] = None, destroyed: Optional[StrictBool] = None, directory_name: Optional[StrictStr] = None, file_system: Optional[FixedReference] = None, path: Optional[StrictStr] = None)

field arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None

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.

field as_of: Optional[StrictInt] = None (alias '_as_of')

The freshness of the data (timestamp in millis since epoch).

field created: Optional[StrictInt] = None

Creation time in milliseconds since UNIX epoch.

field destroyed: Optional[StrictBool] = None

Is the managed directory destroyed?

Constraints

• type = boolean

field directory_name: Optional[StrictStr] = None

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.

field file_system: Optional[FixedReference] = None

The file system that this managed directory is in.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

A non-modifiable, locally unique name chosen by the system.

field path: Optional[StrictStr] = None

Absolute path of the managed directory in the file system.

DirectoryGetResponse

pydantic model pypureclient.pure1.DirectoryGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Directory]] = None)

field continuation_token: Optional[StrictStr] = None

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

field items: Optional[ConstrainedListValue[Directory]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

DirectoryResponse

pydantic model pypureclient.pure1.DirectoryResponse(*, items: Optional[ConstrainedListValue[Directory]] = None)

field items: Optional[ConstrainedListValue[Directory]] = None

Drive

pydantic model pypureclient.pure1.Drive(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, arrays: Optional[ConstrainedListValue[DriveArrayStatus]] = None, capacity: Optional[Union[StrictFloat, StrictInt]] = None, details: Optional[StrictStr] = None, protocol: Optional[StrictStr] = None, status: Optional[StrictStr] = None, type: Optional[StrictStr] = None)

field arrays: Optional[ConstrainedListValue[DriveArrayStatus]] = None

A list of arrays that contain this drive. Each drive should only exist on one array.

Constraints

• minItems = 1

field as_of: Optional[StrictInt] = None (alias '_as_of')

The freshness of the data (timestamp in millis since epoch).

field capacity: Optional[Union[StrictFloat, StrictInt]] = None

Physical storage capacity of the module (in bytes).

field details: Optional[StrictStr] = None

Details about the status of the module if status is not healthy.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

A non-modifiable, locally unique name chosen by the system.

field protocol: Optional[StrictStr] = None

Storage protocol of the module. Values include NVMe and SAS.

field status: Optional[StrictStr] = None

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

field type: Optional[StrictStr] = None

The type of the module. Values include cache, NVRAM, SSD, and virtual.

DriveArrayStatus

pydantic model pypureclient.pure1.DriveArrayStatus(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, resource_type: Optional[StrictStr] = None, drive_count: Optional[StrictInt] = None, fqdn: Optional[StrictStr] = None, total_capacity: Optional[StrictInt] = None)

field drive_count: Optional[StrictInt] = None

Count of drives in the array.

field fqdn: Optional[StrictStr] = None

The fully qualified domain name of the appliance when resource_type is arrays, null otherwise.

field id: Optional[StrictStr] = None

The opaque and unique id of this resource.

field name: Optional[StrictStr] = None

The name of this resource.

field resource_type: Optional[StrictStr] = None

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.

field total_capacity: Optional[StrictInt] = None

The total capacity of all drives in the array.

DriveGetResponse

pydantic model pypureclient.pure1.DriveGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Drive]] = None)

field continuation_token: Optional[StrictStr] = None

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

field items: Optional[ConstrainedListValue[Drive]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

DriveResponse

pydantic model pypureclient.pure1.DriveResponse(*, items: Optional[ConstrainedListValue[Drive]] = None)

field items: Optional[ConstrainedListValue[Drive]] = None

Error

pydantic model pypureclient.pure1.Error(*, errors: Optional[ConstrainedListValue[ErrorErrors]] = None)

field errors: Optional[ConstrainedListValue[ErrorErrors]] = None

The list of errors encountered.

ErrorErrors

pydantic model pypureclient.pure1.ErrorErrors(*, context: Optional[StrictStr] = None, message: Optional[StrictStr] = None)

field context: Optional[StrictStr] = None

field message: Optional[StrictStr] = None

ErrorNoContext

pydantic model pypureclient.pure1.ErrorNoContext(*, message: Optional[StrictStr] = None)

field message: Optional[StrictStr] = None

EvergreenForeverAndFoundationDetails

pydantic model pypureclient.pure1.EvergreenForeverAndFoundationDetails(*, service_sla: Optional[StrictStr] = None, service_tier: Optional[StrictStr] = None)

field service_sla: Optional[StrictStr] = None

The associated Service Level Agreements (SLAs) for the service tier.

field service_tier: Optional[StrictStr] = None

A non-modifiable, locally unique name that the subscription was started with, never changes.

FileSystem

pydantic model pypureclient.pure1.FileSystem(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None, created: Optional[StrictInt] = None, destroyed: Optional[StrictBool] = None, fast_remove_directory_enabled: Optional[StrictBool] = None, hard_limit_enabled: Optional[StrictBool] = None, http: Optional[Http] = None, nfs: Optional[Nfs] = None, provisioned: Optional[StrictInt] = None, smb: Optional[Smb] = None, snapshot_directory_enabled: Optional[StrictBool] = None)

field arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None

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.

field as_of: Optional[StrictInt] = None (alias '_as_of')

The freshness of the data (timestamp in millis since epoch).

field created: Optional[StrictInt] = None

Creation time in milliseconds since UNIX epoch.

field destroyed: Optional[StrictBool] = None

Is the file system destroyed?

Constraints

• type = boolean

field fast_remove_directory_enabled: Optional[StrictBool] = None

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.

Constraints

• type = boolean

field hard_limit_enabled: Optional[StrictBool] = None

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.

Constraints

• type = boolean

field http: Optional[Http] = None

HTTP configuration. On a FlashArray file system, the value is always null.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

A non-modifiable, locally unique name chosen by the system.

field nfs: Optional[Nfs] = None

NFS configuration. On a FlashArray file system, the value is always null.

field provisioned: Optional[StrictInt] = None

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.

field smb: Optional[Smb] = None

SMB configuration. On a FlashArray file system, the value is always null.

field snapshot_directory_enabled: Optional[StrictBool] = None

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.

Constraints

• type = boolean

FileSystemGetResponse

pydantic model pypureclient.pure1.FileSystemGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[FileSystem]] = None)

field continuation_token: Optional[StrictStr] = None

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

field items: Optional[ConstrainedListValue[FileSystem]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

FileSystemReplicaLink

pydantic model pypureclient.pure1.FileSystemReplicaLink(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, lag: Optional[StrictInt] = None, paused: Optional[StrictBool] = None, recovery_point: Optional[StrictInt] = None, status: Optional[StrictStr] = None, members: Optional[ConstrainedListValue[ResourceWithLocation]] = None, sources: Optional[ConstrainedListValue[ResourceWithLocation]] = None, status_details: Optional[StrictStr] = None, targets: Optional[ConstrainedListValue[ResourceWithLocation]] = None)

A replica link between two FlashBlade file systems.

field as_of: Optional[StrictInt] = None (alias '_as_of')

The freshness of the data (timestamp in millis since epoch).

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field lag: Optional[StrictInt] = None

Duration, in milliseconds, which represents how far behind the replication target is from the source.

field members: Optional[ConstrainedListValue[ResourceWithLocation]] = None

The union of source and target file systems in the replica link.

field paused: Optional[StrictBool] = None

Returns true if the replica link is paused.

Constraints

• type = boolean

field recovery_point: Optional[StrictInt] = None

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

field sources: Optional[ConstrainedListValue[ResourceWithLocation]] = None

The source file systems in the replica link.

field status: Optional[StrictStr] = None

Status of the replica link. Values include replicating, idle, and unhealthy.

field status_details: Optional[StrictStr] = None

Detailed information about the status of the replica link when it is unhealthy.

field targets: Optional[ConstrainedListValue[ResourceWithLocation]] = None

The target file systems in the replica link.

FileSystemReplicaLinkGetResponse

pydantic model pypureclient.pure1.FileSystemReplicaLinkGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[FileSystemReplicaLink]] = None)

field continuation_token: Optional[StrictStr] = None

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

field items: Optional[ConstrainedListValue[FileSystemReplicaLink]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

FileSystemReplicaLinkResponse

pydantic model pypureclient.pure1.FileSystemReplicaLinkResponse(*, items: Optional[ConstrainedListValue[FileSystemReplicaLink]] = None)

field items: Optional[ConstrainedListValue[FileSystemReplicaLink]] = None

FileSystemResponse

pydantic model pypureclient.pure1.FileSystemResponse(*, items: Optional[ConstrainedListValue[FileSystem]] = None)

field items: Optional[ConstrainedListValue[FileSystem]] = None

FileSystemSnapshot

pydantic model pypureclient.pure1.FileSystemSnapshot(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None, created: Optional[StrictInt] = None, destroyed: Optional[StrictBool] = None, on: Optional[FixedReferenceFqdn] = None, source: Optional[FixedReference] = None, suffix: Optional[StrictStr] = None)

A point-in-time image of the contents of a FlashBlade file system.

field arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None

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.

field as_of: Optional[StrictInt] = None (alias '_as_of')

The freshness of the data (timestamp in millis since epoch).

field created: Optional[StrictInt] = None

Creation time in milliseconds since UNIX epoch.

field destroyed: Optional[StrictBool] = None

Indicates if this snapshot has been destroyed and is pending eradication.

Constraints

• type = boolean

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

A non-modifiable, locally unique name chosen by the system.

field on: Optional[FixedReferenceFqdn] = None

field source: Optional[FixedReference] = None

A reference to the file system that the snapshot was taken from.

field suffix: Optional[StrictStr] = None

Indicates the suffix of the snapshot.

FileSystemSnapshotGetResponse

pydantic model pypureclient.pure1.FileSystemSnapshotGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[FileSystemSnapshot]] = None)

field continuation_token: Optional[StrictStr] = None

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

field items: Optional[ConstrainedListValue[FileSystemSnapshot]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

FileSystemSnapshotResponse

pydantic model pypureclient.pure1.FileSystemSnapshotResponse(*, items: Optional[ConstrainedListValue[FileSystemSnapshot]] = None)

field items: Optional[ConstrainedListValue[FileSystemSnapshot]] = None

FixedReference

pydantic model pypureclient.pure1.FixedReference(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, resource_type: Optional[StrictStr] = None)

field id: Optional[StrictStr] = None

The opaque and unique id of this resource.

field name: Optional[StrictStr] = None

The name of this resource.

field resource_type: Optional[StrictStr] = None

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.

FixedReferenceFqdn

pydantic model pypureclient.pure1.FixedReferenceFqdn(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, resource_type: Optional[StrictStr] = None, fqdn: Optional[StrictStr] = None)

field fqdn: Optional[StrictStr] = None

The fully qualified domain name of the appliance when resource_type is arrays, null otherwise.

field id: Optional[StrictStr] = None

The opaque and unique id of this resource.

field name: Optional[StrictStr] = None

The name of this resource.

field resource_type: Optional[StrictStr] = None

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.

Geolocation

pydantic model pypureclient.pure1.Geolocation(*, latitude: Optional[Union[StrictFloat, StrictInt]] = None, longitude: Optional[Union[StrictFloat, StrictInt]] = None)

field latitude: Optional[Union[StrictFloat, StrictInt]] = None

The latitude of the address.

field longitude: Optional[Union[StrictFloat, StrictInt]] = None

The longitude of the address.

Hardware

pydantic model pypureclient.pure1.Hardware(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None, details: Optional[StrictStr] = None, identify_enabled: Optional[StrictBool] = None, model: Optional[StrictStr] = None, serial: Optional[StrictStr] = None, slot: Optional[StrictInt] = None, speed: Optional[StrictInt] = None, status: Optional[StrictStr] = None, temperature: Optional[StrictInt] = None, type: Optional[StrictStr] = None, voltage: Optional[StrictInt] = None)

field arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None

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.

field as_of: Optional[StrictInt] = None (alias '_as_of')

The freshness of the data (timestamp in millis since epoch).

field details: Optional[StrictStr] = None

Details about the component if status is not healthy.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field identify_enabled: Optional[StrictBool] = None

If true, the ID light is lit to visually identify the component.

Constraints

• type = boolean

field model: Optional[StrictStr] = None

Model number of the hardware component.

field name: Optional[StrictStr] = None

A non-modifiable, locally unique name chosen by the system.

field serial: Optional[StrictStr] = None

Serial number of the hardware component.

field slot: Optional[StrictInt] = None

Slot number occupied by the PCI Express card that hosts the component.

field speed: Optional[StrictInt] = None

Speed (in bytes per second) at which the component is operating.

field status: Optional[StrictStr] = None

Component status. Values include critical, healthy, identifying, unhealthy, unclaimed, unknown, unrecognized, and unused.

field temperature: Optional[StrictInt] = None

Temperature (in degrees Celsius) reported by the component.

field type: Optional[StrictStr] = None

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.

field voltage: Optional[StrictInt] = None

Voltage (in Volts) reported by the component.

HardwareConnector

pydantic model pypureclient.pure1.HardwareConnector(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None, connector_type: Optional[StrictStr] = None, lane_speed: Optional[Union[StrictFloat, StrictInt]] = None, port_count: Optional[Union[StrictFloat, StrictInt]] = None, transceiver_type: Optional[StrictStr] = None)

field arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None

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.

field as_of: Optional[StrictInt] = None (alias '_as_of')

The freshness of the data (timestamp in millis since epoch).

field connector_type: Optional[StrictStr] = None

Form-factor of the interface. Values include QSFP and RJ-45.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field lane_speed: Optional[Union[StrictFloat, StrictInt]] = None

Configured speed of each lane in the connector in bits per second.

field name: Optional[StrictStr] = None

A non-modifiable, locally unique name chosen by the system.

field port_count: Optional[Union[StrictFloat, StrictInt]] = None

Configured number of ports in the connector.

field transceiver_type: Optional[StrictStr] = None

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.

HardwareConnectorGetResponse

pydantic model pypureclient.pure1.HardwareConnectorGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[HardwareConnector]] = None)

field continuation_token: Optional[StrictStr] = None

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

field items: Optional[ConstrainedListValue[HardwareConnector]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

HardwareConnectorResponse

pydantic model pypureclient.pure1.HardwareConnectorResponse(*, items: Optional[ConstrainedListValue[HardwareConnector]] = None)

field items: Optional[ConstrainedListValue[HardwareConnector]] = None

HardwareGetResponse

pydantic model pypureclient.pure1.HardwareGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Hardware]] = None)

field continuation_token: Optional[StrictStr] = None

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

field items: Optional[ConstrainedListValue[Hardware]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

HardwareResponse

pydantic model pypureclient.pure1.HardwareResponse(*, items: Optional[ConstrainedListValue[Hardware]] = None)

field items: Optional[ConstrainedListValue[Hardware]] = None

Http

pydantic model pypureclient.pure1.Http(*, enabled: Optional[StrictBool] = None)

field enabled: Optional[StrictBool] = None

Is the protocol enabled?

Constraints

• type = boolean

InstallAddress

pydantic model pypureclient.pure1.InstallAddress(*, geolocation: Optional[Geolocation] = None, street_address: Optional[StrictStr] = None, updated: Optional[StrictInt] = None)

field geolocation: Optional[Geolocation] = None

The geolocation that contains the latitude and the longitude of the address.

field street_address: Optional[StrictStr] = None

The 1-line format street address of the array install address.

field updated: Optional[StrictInt] = None

The epoch timestamp, in milliseconds, that denotes when the address was updated.

Invoice

pydantic model pypureclient.pure1.Invoice(*, amount: Optional[Union[StrictFloat, StrictInt]] = None, currency: Optional[StrictStr] = None, date: Optional[StrictInt] = None, due_date: Optional[StrictInt] = None, end_user_name: Optional[StrictStr] = None, end_user_purchase_order: Optional[StrictStr] = None, id: Optional[StrictStr] = None, lines: Optional[ConstrainedListValue[InvoiceLine]] = None, partner_purchase_order: Optional[StrictStr] = None, payment_terms: Optional[StrictStr] = None, sales_representative: Optional[StrictStr] = None, ship_date: Optional[StrictInt] = None, status: Optional[StrictStr] = None, subscription: Optional[FixedReference] = None)

field amount: Optional[Union[StrictFloat, StrictInt]] = None

The total invoice amount, expressed in the currency defined in currency.

field currency: Optional[StrictStr] = None

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

field due_date: Optional[StrictInt] = None

The payment due date. Represented as a timestamp of 00:00 on that date in UTC, in milliseconds since UNIX epoch.

field end_user_name: Optional[StrictStr] = None

The end user customer name.

field end_user_purchase_order: Optional[StrictStr] = None

The end user customer purchase order number.

field id: Optional[StrictStr] = None

The invoice number, a globally unique identifier for this invoice.

field lines: Optional[ConstrainedListValue[InvoiceLine]] = None

A list of invoice line items.

field partner_purchase_order: Optional[StrictStr] = None

The partner purchase order number.

field payment_terms: Optional[StrictStr] = None

The invoice payment terms.

field sales_representative: Optional[StrictStr] = None

The sales representative that issued the invoice.

field ship_date: Optional[StrictInt] = None

The invoice shipment date. Represented as a timestamp of 00:00 on that date in UTC, in milliseconds since UNIX epoch.

field status: Optional[StrictStr] = None

The invoice status. Values include open and paid.

field subscription: Optional[FixedReference] = None

A reference to which subscription this invoice belongs.

field var_date: Optional[StrictInt] = None (alias 'date')

The issuance date. Represented as a timestamp of 00:00 on that date in UTC, in milliseconds since UNIX epoch.

InvoiceGetResponse

pydantic model pypureclient.pure1.InvoiceGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Invoice]] = None)

field continuation_token: Optional[StrictStr] = None

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

field items: Optional[ConstrainedListValue[Invoice]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

InvoiceLine

pydantic model pypureclient.pure1.InvoiceLine(*, amount: Optional[Union[StrictFloat, StrictInt]] = None, components: Optional[ConstrainedListValue[InvoiceLineComponent]] = None, description: Optional[StrictStr] = None, end_date: Optional[StrictInt] = None, item: Optional[StrictStr] = None, quantity: Optional[ConstrainedIntValue] = None, start_date: Optional[StrictInt] = None, tax: Optional[Tax] = None, unit_price: Optional[Union[StrictFloat, StrictInt]] = None)

field amount: Optional[Union[StrictFloat, StrictInt]] = None

The total price of current invoice item, currency is specified in invoice currency.

field components: Optional[ConstrainedListValue[InvoiceLineComponent]] = None

The sub-components of current invoice item.

field description: Optional[StrictStr] = None

field end_date: Optional[StrictInt] = None

The invoice item end date. Represented as a timestamp of 00:00 on that date in UTC, in milliseconds since UNIX epoch.

field item: Optional[StrictStr] = None

The name of invoice item.

field quantity: Optional[ConstrainedIntValue] = None

The quantity of current invoice item.

Constraints

• minimum = 0

field start_date: Optional[StrictInt] = None

The invoice item start date. Represented as a timestamp of 00:00 on that date in UTC, in milliseconds since UNIX epoch.

field tax: Optional[Tax] = None

field unit_price: Optional[Union[StrictFloat, StrictInt]] = None

The unit price of current invoice item, currency is specified in invoice currency.

InvoiceLineComponent

pydantic model pypureclient.pure1.InvoiceLineComponent(*, description: Optional[StrictStr] = None, item: Optional[StrictStr] = None, quantity: Optional[ConstrainedIntValue] = None)

field description: Optional[StrictStr] = None

field item: Optional[StrictStr] = None

The name of invoice component.

field quantity: Optional[ConstrainedIntValue] = None

The quantity of current invoice component.

Constraints

• minimum = 0

InvoiceResponse

pydantic model pypureclient.pure1.InvoiceResponse(*, items: Optional[ConstrainedListValue[Invoice]] = None)

field items: Optional[ConstrainedListValue[Invoice]] = None

LicenseResourceReference

pydantic model pypureclient.pure1.LicenseResourceReference(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, resource_type: Optional[StrictStr] = None, fqdn: Optional[StrictStr] = None, activation_time: Optional[StrictInt] = None, usage: Optional[CurrentMetric] = None)

field activation_time: Optional[StrictInt] = None

Time when the resource is activated under the license, in milliseconds since UNIX epoch.

field fqdn: Optional[StrictStr] = None

The fully qualified domain name of the appliance when resource_type is arrays, null otherwise.

field id: Optional[StrictStr] = None

The opaque and unique id of this resource.

field name: Optional[StrictStr] = None

The name of this resource.

field resource_type: Optional[StrictStr] = None

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.

field usage: Optional[CurrentMetric] = None

Current usage of the resource under the license.

MarketplacePartner

pydantic model pypureclient.pure1.MarketplacePartner(*, name: Optional[StrictStr] = None, reference_id: Optional[StrictStr] = None)

field name: Optional[StrictStr] = None

Name or identifier of the marketplace parter who owns the reference ID.

field reference_id: Optional[StrictStr] = None

External ID the marketplace partner knows to refer to this license.

Metric

pydantic model pypureclient.pure1.Metric(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, availabilities: Optional[ConstrainedListValue[MetricAvailability]] = None, description: Optional[StrictStr] = None, resource_types: Optional[ConstrainedListValue[StrictStr]] = None, unit: Optional[StrictStr] = None)

A type of measurement recorded on a resource.

field as_of: Optional[StrictInt] = None (alias '_as_of')

The freshness of the data (timestamp in millis since epoch).

field availabilities: Optional[ConstrainedListValue[MetricAvailability]] = None

The available resolutions, aggregations and retentions of this metric.

field description: Optional[StrictStr] = None

The additional description for the the metric.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

A non-modifiable, locally unique name chosen by the system.

field resource_types: Optional[ConstrainedListValue[StrictStr]] = None

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

field unit: Optional[StrictStr] = None

The unit of the metric.

MetricAvailability

pydantic model pypureclient.pure1.MetricAvailability(*, aggregations: Optional[ConstrainedListValue[StrictStr]] = None, resolution: Optional[StrictInt] = None, retention: Optional[StrictInt] = None)

field aggregations: Optional[ConstrainedListValue[StrictStr]] = None

Available aggregations for this metric at the given resolution, e.g. ‘avg’, ‘max’.

field resolution: Optional[StrictInt] = None

An available resolution of this metric in milliseconds.

field retention: Optional[StrictInt] = None

The retention at this given resolution in milliseconds.

MetricGetResponse

pydantic model pypureclient.pure1.MetricGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Metric]] = None)

field continuation_token: Optional[StrictStr] = None

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

field items: Optional[ConstrainedListValue[Metric]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

MetricHistory

pydantic model pypureclient.pure1.MetricHistory(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, aggregation: Optional[StrictStr] = None, data: Optional[ConstrainedListValue[ConstrainedListValue[Union[StrictFloat, StrictInt]]]] = None, resolution: Optional[StrictInt] = None, resources: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None, unit: Optional[StrictStr] = None)

field aggregation: Optional[StrictStr] = None

The aggregation of the metric data.

field as_of: Optional[StrictInt] = None (alias '_as_of')

The freshness of the data (timestamp in millis since epoch).

field data: Optional[ConstrainedListValue[ConstrainedListValue[Union[StrictFloat, StrictInt]]]] = None

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], …].

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

A non-modifiable, locally unique name chosen by the system.

field resolution: Optional[StrictInt] = None

The resolution of the metric data in milliseconds.

field resources: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None

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.

field unit: Optional[StrictStr] = None

The unit of the metric data.

MetricHistoryGetResponse

pydantic model pypureclient.pure1.MetricHistoryGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[MetricHistory]] = None)

field continuation_token: Optional[StrictStr] = None

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

field items: Optional[ConstrainedListValue[MetricHistory]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

MetricHistoryResponse

pydantic model pypureclient.pure1.MetricHistoryResponse(*, items: Optional[ConstrainedListValue[MetricHistory]] = None)

field items: Optional[ConstrainedListValue[MetricHistory]] = None

MetricResponse

pydantic model pypureclient.pure1.MetricResponse(*, items: Optional[ConstrainedListValue[Metric]] = None)

field items: Optional[ConstrainedListValue[Metric]] = None

NetworkInterface

pydantic model pypureclient.pure1.NetworkInterface(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None, address: Optional[StrictStr] = None, enabled: Optional[StrictBool] = None, gateway: Optional[StrictStr] = None, hwaddr: Optional[StrictStr] = None, mtu: Optional[StrictInt] = None, netmask: Optional[StrictStr] = None, services: Optional[ConstrainedListValue[StrictStr]] = None, speed: Optional[StrictInt] = None, subinterfaces: Optional[ConstrainedListValue[StrictStr]] = None)

field address: Optional[StrictStr] = None

IP address of this network interface.

field arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None

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.

field as_of: Optional[StrictInt] = None (alias '_as_of')

The freshness of the data (timestamp in millis since epoch).

field enabled: Optional[StrictBool] = None

Constraints

• type = boolean

field gateway: Optional[StrictStr] = None

field hwaddr: Optional[StrictStr] = None

Hardware address.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field mtu: Optional[StrictInt] = None

Maximum transmission unit.

field name: Optional[StrictStr] = None

A non-modifiable, locally unique name chosen by the system.

field netmask: Optional[StrictStr] = None

field services: Optional[ConstrainedListValue[StrictStr]] = None

Services and protocols that are enabled on the interface.

field speed: Optional[StrictInt] = None

Speed in bytes per second.

field subinterfaces: Optional[ConstrainedListValue[StrictStr]] = None

NetworkInterfaceGetResponse

pydantic model pypureclient.pure1.NetworkInterfaceGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[NetworkInterface]] = None)

field continuation_token: Optional[StrictStr] = None

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

field items: Optional[ConstrainedListValue[NetworkInterface]] = None

A list of network interface objects.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

NetworkInterfaceResponse

pydantic model pypureclient.pure1.NetworkInterfaceResponse(*, items: Optional[ConstrainedListValue[NetworkInterface]] = None)

field items: Optional[ConstrainedListValue[NetworkInterface]] = None

A list of network interface objects.

Nfs

pydantic model pypureclient.pure1.Nfs(*, enabled: Optional[StrictBool] = None, rules: Optional[StrictStr] = None)

field enabled: Optional[StrictBool] = None

Is the protocol enabled?

Constraints

• type = boolean

field rules: Optional[StrictStr] = None

NFS rules.

Oauth210TokenPost400Response

pydantic model pypureclient.pure1.Oauth210TokenPost400Response(*, error: Optional[StrictStr] = None, error_description: Optional[StrictStr] = None)

field error: Optional[StrictStr] = None

field error_description: Optional[StrictStr] = None

Oauth210TokenPost401Response

pydantic model pypureclient.pure1.Oauth210TokenPost401Response(*, error: Optional[StrictStr] = None, error_description: Optional[StrictStr] = None)

field error: Optional[StrictStr] = None

field error_description: Optional[StrictStr] = None

OauthTokenResponse

pydantic model pypureclient.pure1.OauthTokenResponse(*, access_token: Optional[StrictStr] = None, expires_in: Optional[StrictInt] = None, issued_token_type: Optional[StrictStr] = None, token_type: Optional[StrictStr] = None)

field access_token: Optional[StrictStr] = None

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.

field expires_in: Optional[StrictInt] = None

The duration after which the access token will expire. Measured in seconds. This differs from other duration fields that are expressed in milliseconds.

field issued_token_type: Optional[StrictStr] = None

The type of token that is issued. The Pure Storage REST API supports OAuth 2.0 access tokens.

field token_type: Optional[StrictStr] = None

Indicates how the API client can use the access token issued. The Pure Storage REST API supports the Bearer token.

ObjectStoreAccount

pydantic model pypureclient.pure1.ObjectStoreAccount(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None, created: Optional[StrictInt] = None, object_count: Optional[StrictInt] = None)

field arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None

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.

field as_of: Optional[StrictInt] = None (alias '_as_of')

The freshness of the data (timestamp in millis since epoch).

field created: Optional[StrictInt] = None

Creation timestamp of the object, in milliseconds since Unix epoch.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

A modifiable, locally unique name chosen by the user.

field object_count: Optional[StrictInt] = None

The number of objects within the account.

ObjectStoreAccountGetResponse

pydantic model pypureclient.pure1.ObjectStoreAccountGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[ObjectStoreAccount]] = None)

field continuation_token: Optional[StrictStr] = None

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

field items: Optional[ConstrainedListValue[ObjectStoreAccount]] = None

A list of object store accounts.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

ObjectStoreAccountResponse

pydantic model pypureclient.pure1.ObjectStoreAccountResponse(*, items: Optional[ConstrainedListValue[ObjectStoreAccount]] = None)

field items: Optional[ConstrainedListValue[ObjectStoreAccount]] = None

A list of object store accounts.

PageInfo

pydantic model pypureclient.pure1.PageInfo(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None)

field continuation_token: Optional[StrictStr] = None

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

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

Pod

pydantic model pypureclient.pure1.Pod(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None, mediator: Optional[StrictStr] = None, source: Optional[FixedReference] = None)

An administrative domain, a data container, and a namespace for volumes and protection groups.

field arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None

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.

field as_of: Optional[StrictInt] = None (alias '_as_of')

The freshness of the data (timestamp in millis since epoch).

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field mediator: Optional[StrictStr] = None

The URL of the mediator for this pod.

field name: Optional[StrictStr] = None

A modifiable, locally unique name chosen by the user.

field source: Optional[FixedReference] = None

A reference to the source pod of a pod clone.

PodGetResponse

pydantic model pypureclient.pure1.PodGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Pod]] = None)

field continuation_token: Optional[StrictStr] = None

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

field items: Optional[ConstrainedListValue[Pod]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

PodReplicaLink

pydantic model pypureclient.pure1.PodReplicaLink(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, lag: Optional[StrictInt] = None, paused: Optional[StrictBool] = None, recovery_point: Optional[StrictInt] = None, status: Optional[StrictStr] = None, members: Optional[ConstrainedListValue[ResourceWithLocations]] = None, sources: Optional[ConstrainedListValue[ResourceWithLocations]] = None, targets: Optional[ConstrainedListValue[ResourceWithLocations]] = None)

A replica link between two pods.

field as_of: Optional[StrictInt] = None (alias '_as_of')

The freshness of the data (timestamp in millis since epoch).

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field lag: Optional[StrictInt] = None

Duration, in milliseconds, which represents how far behind the replication target is from the source.

field members: Optional[ConstrainedListValue[ResourceWithLocations]] = None

The union of source and target pods in the replica link.

field paused: Optional[StrictBool] = None

Returns true if the replica link is paused.

Constraints

• type = boolean

field recovery_point: Optional[StrictInt] = None

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

field sources: Optional[ConstrainedListValue[ResourceWithLocations]] = None

The source pods in the replica link.

field status: Optional[StrictStr] = None

Status of the replica link. Values include replicating, idle, baselining, paused, quiescing, quiesced, and unhealthy.

field targets: Optional[ConstrainedListValue[ResourceWithLocations]] = None

The target pods in the replica link.

PodReplicaLinkGetResponse

pydantic model pypureclient.pure1.PodReplicaLinkGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[PodReplicaLink]] = None)

field continuation_token: Optional[StrictStr] = None

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

field items: Optional[ConstrainedListValue[PodReplicaLink]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

PodReplicaLinkResponse

pydantic model pypureclient.pure1.PodReplicaLinkResponse(*, items: Optional[ConstrainedListValue[PodReplicaLink]] = None)

field items: Optional[ConstrainedListValue[PodReplicaLink]] = None

PodResponse

pydantic model pypureclient.pure1.PodResponse(*, items: Optional[ConstrainedListValue[Pod]] = None)

field items: Optional[ConstrainedListValue[Pod]] = None

Policy

pydantic model pypureclient.pure1.Policy(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None, enabled: Optional[StrictBool] = None, rules: Optional[ConstrainedListValue[PolicyRule]] = None)

field arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None

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.

field as_of: Optional[StrictInt] = None (alias '_as_of')

The freshness of the data (timestamp in millis since epoch).

field enabled: Optional[StrictBool] = None

Returns true if this policy is enabled.

Constraints

• type = boolean

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

A non-modifiable, locally unique name chosen by the system.

field rules: Optional[ConstrainedListValue[PolicyRule]] = None

PolicyGetResponse

pydantic model pypureclient.pure1.PolicyGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Policy]] = None)

field continuation_token: Optional[StrictStr] = None

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

field items: Optional[ConstrainedListValue[Policy]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

PolicyMember

pydantic model pypureclient.pure1.PolicyMember(*, _as_of: Optional[StrictInt] = None, member: Optional[FixedReference] = None, policy: Optional[FixedReference] = None)

An association between a policy and a member.

field as_of: Optional[StrictInt] = None (alias '_as_of')

The freshness of the data (timestamp in millis since epoch).

field member: Optional[FixedReference] = None

field policy: Optional[FixedReference] = None

PolicyMembersGetResponse

pydantic model pypureclient.pure1.PolicyMembersGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[PolicyMember]] = None)

field continuation_token: Optional[StrictStr] = None

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

field items: Optional[ConstrainedListValue[PolicyMember]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

PolicyMembersResponse

pydantic model pypureclient.pure1.PolicyMembersResponse(*, items: Optional[ConstrainedListValue[PolicyMember]] = None)

field items: Optional[ConstrainedListValue[PolicyMember]] = None

PolicyResponse

pydantic model pypureclient.pure1.PolicyResponse(*, items: Optional[ConstrainedListValue[Policy]] = None)

field items: Optional[ConstrainedListValue[Policy]] = None

PolicyRule

pydantic model pypureclient.pure1.PolicyRule(*, at: Optional[StrictInt] = None, every: Optional[StrictInt] = None, keep_for: Optional[StrictInt] = None, time_zone: Optional[StrictStr] = None)

A rule that can be added to a policy.

field at: Optional[StrictInt] = None

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.

field every: Optional[StrictInt] = None

How often to take snapshots, in milliseconds.

field keep_for: Optional[StrictInt] = None

How long to keep snapshots, in milliseconds.

field time_zone: Optional[StrictStr] = None

The time zone in which the at rule is applied.

Port

pydantic model pypureclient.pure1.Port(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None, failover: Optional[StrictStr] = None, iqn: Optional[StrictStr] = None, nqn: Optional[StrictStr] = None, portal: Optional[StrictStr] = None, wwn: Optional[StrictStr] = None)

field arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None

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.

field as_of: Optional[StrictInt] = None (alias '_as_of')

The freshness of the data (timestamp in millis since epoch).

field failover: Optional[StrictStr] = None

If the array port has failed over, returns the name of the port to which this port has failed over.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field iqn: Optional[StrictStr] = None

The iSCSI Qualified Name if the port is iSCSI, null otherwise.

field name: Optional[StrictStr] = None

A non-modifiable, locally unique name chosen by the system.

field nqn: Optional[StrictStr] = None

The NVMe Qualified Name if the port is NVMe-oF, null otherwise.

field portal: Optional[StrictStr] = None

The IP and port number if the port is iSCSI or NVMe-oF, null otherwise.

field wwn: Optional[StrictStr] = None

The Fibre Channel World Wide Name if the port is Fibre Channel, null otherwise.

PortGetResponse

pydantic model pypureclient.pure1.PortGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Port]] = None)

field continuation_token: Optional[StrictStr] = None

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

field items: Optional[ConstrainedListValue[Port]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

PortResponse

pydantic model pypureclient.pure1.PortResponse(*, items: Optional[ConstrainedListValue[Port]] = None)

field items: Optional[ConstrainedListValue[Port]] = None

ReplicaLink

pydantic model pypureclient.pure1.ReplicaLink(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, lag: Optional[StrictInt] = None, paused: Optional[StrictBool] = None, recovery_point: Optional[StrictInt] = None, status: Optional[StrictStr] = None)

field as_of: Optional[StrictInt] = None (alias '_as_of')

The freshness of the data (timestamp in millis since epoch).

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field lag: Optional[StrictInt] = None

Duration, in milliseconds, which represents how far behind the replication target is from the source.

field paused: Optional[StrictBool] = None

Returns true if the replica link is paused.

Constraints

• type = boolean

field recovery_point: Optional[StrictInt] = None

Time when the last piece of data was replicated, measured in milliseconds since the UNIX epoch, and the recovery point of the resource.

field status: Optional[StrictStr] = None

Status of the replica link. Values include replicating, idle, and unhealthy.

Resource

pydantic model pypureclient.pure1.Resource(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None)

An ordinary (as opposed to built-in) resource that can be created, named, renamed, or deleted by the user. This might be a virtual resource (e.g., a volume), or correspond to something in the physical environment, like a host or a server.

field as_of: Optional[StrictInt] = None (alias '_as_of')

The freshness of the data (timestamp in millis since epoch).

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

A modifiable, locally unique name chosen by the user.

ResourceNoName

pydantic model pypureclient.pure1.ResourceNoName(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None)

An ordinary (as opposed to built-in) resource that can be created or deleted by the user. This might be a virtual resource (e.g., a volume), or correspond to something in the physical environment, like a host or a server.

field as_of: Optional[StrictInt] = None (alias '_as_of')

The freshness of the data (timestamp in millis since epoch).

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

ResourceWithLocation

pydantic model pypureclient.pure1.ResourceWithLocation(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, resource_type: Optional[StrictStr] = None, location: Optional[FixedReferenceFqdn] = None)

An ordinary resource that exists in one location.

field id: Optional[StrictStr] = None

The opaque and unique id of this resource.

field location: Optional[FixedReferenceFqdn] = None

field name: Optional[StrictStr] = None

The name of this resource.

field resource_type: Optional[StrictStr] = None

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.

ResourceWithLocations

pydantic model pypureclient.pure1.ResourceWithLocations(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, resource_type: Optional[StrictStr] = None, locations: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None)

A resource that may relate to multiple locations.

field id: Optional[StrictStr] = None

The opaque and unique id of this resource.

field locations: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None

field name: Optional[StrictStr] = None

The name of this resource.

field resource_type: Optional[StrictStr] = None

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.

Smb

pydantic model pypureclient.pure1.Smb(*, enabled: Optional[StrictBool] = None)

field enabled: Optional[StrictBool] = None

Is the protocol enabled?

Constraints

• type = boolean

Subscription

pydantic model pypureclient.pure1.Subscription(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, customer_name: Optional[StrictStr] = None, expiration_date: Optional[StrictInt] = None, initial_name: Optional[StrictStr] = None, last_updated_date: Optional[StrictInt] = None, organization: Optional[FixedReference] = None, partner_name: Optional[StrictStr] = None, service: Optional[StrictStr] = None, service_details: Optional[SubscriptionAllOfServiceDetails] = None, start_date: Optional[StrictInt] = None, status: Optional[StrictStr] = None, subscription_term: Optional[StrictInt] = None)

field as_of: Optional[StrictInt] = None (alias '_as_of')

The freshness of the data (timestamp in millis since epoch).

field customer_name: Optional[StrictStr] = None

The name of the end customer of the asset.

field expiration_date: Optional[StrictInt] = None

Date when the subscription expires. Represented as a timestamp of 00:00 on that date in UTC, in milliseconds since UNIX epoch.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field initial_name: Optional[StrictStr] = None

A non-modifiable, locally unique name that the subscription was started with, never changes.

field last_updated_date: Optional[StrictInt] = None

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

field name: Optional[StrictStr] = None

A non-modifiable, locally unique name chosen by the system.

field organization: Optional[FixedReference] = None

This field has been deprecated. Please use customer_name instead. The Pure1 organization for the asset.

field partner_name: Optional[StrictStr] = None

The partner who invoices for the subscription.

field service: Optional[StrictStr] = None

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.

field service_details: Optional[SubscriptionAllOfServiceDetails] = None

field start_date: Optional[StrictInt] = None

Date when the subscription starts. Represented as a timestamp of 00:00 on that date in UTC, in milliseconds since UNIX epoch.

field status: Optional[StrictStr] = None

Current status of the subscription. Values include active, terminated, poc-expired, and signed.

field subscription_term: Optional[StrictInt] = None

Length of the subscription in months.

SubscriptionAllOfServiceDetails

pydantic model pypureclient.pure1.SubscriptionAllOfServiceDetails(*args, oneof_schema_1_validator: Optional[EvergreenForeverAndFoundationDetails] = None, oneof_schema_2_validator: Optional[Dict[str, Any]] = None, actual_instance: Any = None, one_of_schemas: List[str] = ['EvergreenForeverAndFoundationDetails', 'object'])

Additional details for the given service.

Validators

• actual_instance_must_validate_oneof » actual_instance

field actual_instance: Any = None

Validated by

• actual_instance_must_validate_oneof

field one_of_schemas: List[str] = ['EvergreenForeverAndFoundationDetails', 'object']

Constraints

• const = [‘EvergreenForeverAndFoundationDetails’, ‘object’]

field oneof_schema_1_validator: Optional[EvergreenForeverAndFoundationDetails] = None

field oneof_schema_2_validator: Optional[Dict[str, Any]] = None

validator actual_instance_must_validate_oneof  »  actual_instance

SubscriptionAsset

pydantic model pypureclient.pure1.SubscriptionAsset(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, activation_date: Optional[StrictInt] = None, array: Optional[SubscriptionAssetArray] = None, customer_name: Optional[StrictStr] = None, end_of_life_date: Optional[StrictInt] = None, install_address: Optional[AssetAddress] = None, license: Optional[FixedReference] = None, organization: Optional[AssetOrg] = None, subscription: Optional[FixedReference] = None, upgrade_details: Optional[AssetUpgradeDetails] = None)

field activation_date: Optional[StrictInt] = None

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

field array: Optional[SubscriptionAssetArray] = None

The specific fields for assets that are arrays.

field as_of: Optional[StrictInt] = None (alias '_as_of')

The freshness of the data (timestamp in millis since epoch).

field customer_name: Optional[StrictStr] = None

The name of the end customer of the asset.

field end_of_life_date: Optional[StrictInt] = None

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

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field install_address: Optional[AssetAddress] = None

The address where the appliance is installed. This address is also where replacement parts will be shipped to.

field license: Optional[FixedReference] = None

A reference to which license this appliance belongs.

field name: Optional[StrictStr] = None

A non-modifiable, locally unique name chosen by the system.

field organization: Optional[AssetOrg] = None

This field has been deprecated. Please use customer_name instead. The Pure1 organization for the asset.

field subscription: Optional[FixedReference] = None

A reference to which subscription this appliance belongs.

field upgrade_details: Optional[AssetUpgradeDetails] = None

The address where the appliance is installed. This address is also where replacement parts will be shipped to.

SubscriptionAssetArray

pydantic model pypureclient.pure1.SubscriptionAssetArray(*, advanced_space: Optional[SubscriptionAssetArrayAdvancedSpace] = None, chassis_serial_number: Optional[StrictStr] = None, model: Optional[StrictStr] = None, space: Optional[AssetSpace] = None, version: Optional[StrictStr] = None)

field advanced_space: Optional[SubscriptionAssetArrayAdvancedSpace] = None

The physical and effective space information. Only visible when the query parameter advanced_space is set to true.

field chassis_serial_number: Optional[StrictStr] = None

The chassis serial number of the appliance.

field model: Optional[StrictStr] = None

The model of the appliance.

field space: Optional[AssetSpace] = None

Displays size and space consumption information. For Evergreen//One and Evergreen//Flex this is the effective space information. For Evergreen//Forever and Evergreen//Foundation this is the physical space information.

field version: Optional[StrictStr] = None

The Purity version of the appliance.

SubscriptionAssetArrayAdvancedSpace

pydantic model pypureclient.pure1.SubscriptionAssetArrayAdvancedSpace(*, effective: Optional[AssetSpace] = None, physical: Optional[AssetSpace] = None)

field effective: Optional[AssetSpace] = None

The effective space information of the appliance.

field physical: Optional[AssetSpace] = None

The physical space information of the appliance.

SubscriptionAssetGetResponse

pydantic model pypureclient.pure1.SubscriptionAssetGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[SubscriptionAsset]] = None)

field continuation_token: Optional[StrictStr] = None

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

field items: Optional[ConstrainedListValue[SubscriptionAsset]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

SubscriptionAssetResponse

pydantic model pypureclient.pure1.SubscriptionAssetResponse(*, items: Optional[ConstrainedListValue[SubscriptionAsset]] = None)

field items: Optional[ConstrainedListValue[SubscriptionAsset]] = None

SubscriptionGetResponse

pydantic model pypureclient.pure1.SubscriptionGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Subscription]] = None)

field continuation_token: Optional[StrictStr] = None

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

field items: Optional[ConstrainedListValue[Subscription]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

SubscriptionLicense

pydantic model pypureclient.pure1.SubscriptionLicense(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, add_on_slas: Optional[ConstrainedListValue[SubscriptionLicenseAddOnSla]] = None, average_on_demand: Optional[CurrentMetric] = None, expiration_date: Optional[StrictInt] = None, last_updated_date: Optional[StrictInt] = None, marketplace_partner: Optional[MarketplacePartner] = None, pre_ratio: Optional[SubscriptionLicensePreRatio] = None, quarter_on_demand: Optional[CurrentMetric] = None, reservation: Optional[CurrentMetric] = None, resources: Optional[ConstrainedListValue[LicenseResourceReference]] = None, service_tier: Optional[StrictStr] = None, site_address: Optional[BaseAddress] = None, start_date: Optional[StrictInt] = None, subscription: Optional[FixedReference] = None, usage: Optional[CurrentMetric] = None)

field add_on_slas: Optional[ConstrainedListValue[SubscriptionLicenseAddOnSla]] = None

Add-on SLAs.

field as_of: Optional[StrictInt] = None (alias '_as_of')

The freshness of the data (timestamp in millis since epoch).

field average_on_demand: Optional[CurrentMetric] = None

Estimated daily on-demand usage of the license from the current calendar quarter to date.

field expiration_date: Optional[StrictInt] = None

Date when the license expires. Represented as a timestamp of 00:00 on that date in UTC, in milliseconds since UNIX epoch.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field last_updated_date: Optional[StrictInt] = None

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

field marketplace_partner: Optional[MarketplacePartner] = None

Reference information about the marketplace partner of this license.

field name: Optional[StrictStr] = None

A non-modifiable, locally unique name chosen by the system.

field pre_ratio: Optional[SubscriptionLicensePreRatio] = None

field quarter_on_demand: Optional[CurrentMetric] = None

Estimated total on-demand usage of the license of the current calendar quarter to date.

field reservation: Optional[CurrentMetric] = None

Current reservation amount of the license.

field resources: Optional[ConstrainedListValue[LicenseResourceReference]] = None

References to the resources that operate under this license.

field service_tier: Optional[StrictStr] = None

The tier of the service for the license.

field site_address: Optional[BaseAddress] = None

The license site address.

field start_date: Optional[StrictInt] = None

Date when the license starts. Represented as a timestamp of 00:00 on that date in UTC, in milliseconds since UNIX epoch.

field subscription: Optional[FixedReference] = None

A reference to which subscription this license belongs.

field usage: Optional[CurrentMetric] = None

Usage of the license, averaged over the last day.

SubscriptionLicenseAddOnSla

pydantic model pypureclient.pure1.SubscriptionLicenseAddOnSla(*, name: StrictStr)

field name: StrictStr [Required]

SubscriptionLicenseGetResponse

pydantic model pypureclient.pure1.SubscriptionLicenseGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[SubscriptionLicense]] = None)

field continuation_token: Optional[StrictStr] = None

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

field items: Optional[ConstrainedListValue[SubscriptionLicense]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

SubscriptionLicensePreRatio

pydantic model pypureclient.pure1.SubscriptionLicensePreRatio(*, data: Optional[Union[StrictFloat, StrictInt]] = None, metric: Optional[FixedReference] = None, unit: Optional[StrictStr] = None)

The pre-reduced & encrypted ratio calculated at license level.

field data: Optional[Union[StrictFloat, StrictInt]] = None

field metric: Optional[FixedReference] = None

A reference to the metric this data measures.

field unit: Optional[StrictStr] = None

The unit of the metric.

SubscriptionLicenseResponse

pydantic model pypureclient.pure1.SubscriptionLicenseResponse(*, items: Optional[ConstrainedListValue[SubscriptionLicense]] = None)

field items: Optional[ConstrainedListValue[SubscriptionLicense]] = None

SubscriptionResponse

pydantic model pypureclient.pure1.SubscriptionResponse(*, items: Optional[ConstrainedListValue[Subscription]] = None)

field items: Optional[ConstrainedListValue[Subscription]] = None

SupportContract

pydantic model pypureclient.pure1.SupportContract(*, end_date: Optional[StrictInt] = None, resource: Optional[FixedReferenceFqdn] = None, start_date: Optional[StrictInt] = None)

field end_date: Optional[StrictInt] = None

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

field resource: Optional[FixedReferenceFqdn] = None

field start_date: Optional[StrictInt] = None

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

SupportContractGetResponse

pydantic model pypureclient.pure1.SupportContractGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[SupportContract]] = None)

field continuation_token: Optional[StrictStr] = None

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

field items: Optional[ConstrainedListValue[SupportContract]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

SupportContractResponse

pydantic model pypureclient.pure1.SupportContractResponse(*, items: Optional[ConstrainedListValue[SupportContract]] = None)

field items: Optional[ConstrainedListValue[SupportContract]] = None

SustainabilityArray

pydantic model pypureclient.pure1.SustainabilityArray(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, assessment: Optional[SustainabilityAssessment] = None, install_address: Optional[InstallAddress] = None, reporting_status: Optional[StrictStr] = None)

A single FlashArray/FlashBlade appliance Sustainability assessment information.

field as_of: Optional[StrictInt] = None (alias '_as_of')

The freshness of the data (timestamp in millis since epoch).

field assessment: Optional[SustainabilityAssessment] = None

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field install_address: Optional[InstallAddress] = None

The address where the array is installed. This address is also where replacement parts will be shipped to.

field name: Optional[StrictStr] = None

A non-modifiable, locally unique name chosen by the system.

field reporting_status: Optional[StrictStr] = None

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

SustainabilityArrayGetResponse

pydantic model pypureclient.pure1.SustainabilityArrayGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[SustainabilityArray]] = None)

field continuation_token: Optional[StrictStr] = None

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

field items: Optional[ConstrainedListValue[SustainabilityArray]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

SustainabilityArrayResponse

pydantic model pypureclient.pure1.SustainabilityArrayResponse(*, items: Optional[ConstrainedListValue[SustainabilityArray]] = None)

field items: Optional[ConstrainedListValue[SustainabilityArray]] = None

SustainabilityAssessment

pydantic model pypureclient.pure1.SustainabilityAssessment(*, _as_of: Optional[StrictInt] = None, _interval_end: Optional[StrictInt] = None, _interval_start: Optional[StrictInt] = None, array_data_reduction: Optional[Union[StrictFloat, StrictInt]] = None, array_total_load: Optional[Union[StrictFloat, StrictInt]] = None, assessment_level: Optional[StrictStr] = None, blades: Optional[StrictInt] = None, capacity_utilization: Optional[Union[StrictFloat, StrictInt]] = None, chassis: Optional[StrictInt] = None, heat_average: Optional[Union[StrictFloat, StrictInt]] = None, heat_peak_spec: Optional[Union[StrictFloat, StrictInt]] = None, heat_typical_spec: Optional[Union[StrictFloat, StrictInt]] = None, power_average: Optional[Union[StrictFloat, StrictInt]] = None, power_peak_spec: Optional[Union[StrictFloat, StrictInt]] = None, power_per_usable_capacity: Optional[Union[StrictFloat, StrictInt]] = None, power_per_used_space: Optional[Union[StrictFloat, StrictInt]] = None, power_typical_spec: Optional[Union[StrictFloat, StrictInt]] = None, rack_units: Optional[StrictInt] = None, shelves: Optional[StrictInt] = None)

A FlashArray or FlashBlade Sustainability assessment information. The _as_of is the time when the computation happened. Only the data from the given time interval was used for the aggregation. Typically the last week of data is used for the aggregation.

field array_data_reduction: Optional[Union[StrictFloat, StrictInt]] = None

The data reduction ratio of the appliance. Average over the assessment window.

field array_total_load: Optional[Union[StrictFloat, StrictInt]] = None

The load percentage. Average over the assessment window.

field as_of: Optional[StrictInt] = None (alias '_as_of')

The freshness of the data (timestamp in millis since epoch).

field assessment_level: Optional[StrictStr] = None

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

field blades: Optional[StrictInt] = None

The number of blades of the FlashBlade appliance, always zero for FlashArray appliances.

field capacity_utilization: Optional[Union[StrictFloat, StrictInt]] = None

The percentage of the used capacity. Average over the assessment window.

field chassis: Optional[StrictInt] = None

The number of chassis of the appliance, always one for FlashArray appliances.

field heat_average: Optional[Union[StrictFloat, StrictInt]] = None

The average of heat production of the appliance in BTU/Hr. Average over the assessment window.

field heat_peak_spec: Optional[Union[StrictFloat, StrictInt]] = None

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

field heat_typical_spec: Optional[Union[StrictFloat, StrictInt]] = None

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

field interval_end: Optional[StrictInt] = None (alias '_interval_end')

The timestamp of the end of the time interval.

field interval_start: Optional[StrictInt] = None (alias '_interval_start')

The timestamp of the start of the time interval.

field power_average: Optional[Union[StrictFloat, StrictInt]] = None

The average of power consumption of the appliance. Average over the assessment window.

field power_peak_spec: Optional[Union[StrictFloat, StrictInt]] = None

The peak power consumption of the appliance in Watts. The value is derived from benchmark data and remains static for the model and configuration.

field power_per_usable_capacity: Optional[Union[StrictFloat, StrictInt]] = None

The average of power consumption per TiB of usable capacity.

field power_per_used_space: Optional[Union[StrictFloat, StrictInt]] = None

The average of power consumption per TiB of used space.

field power_typical_spec: Optional[Union[StrictFloat, StrictInt]] = None

The typical power consumption of the appliance in Watts. The value is derived from benchmark data and remains static for the model and configuration.

field rack_units: Optional[StrictInt] = None

The total number of rack units occupied by the appliance.

field shelves: Optional[StrictInt] = None

The number of expansion shelves of the FlashArray appliance. It is always zero for FlashBlade appliances.

SustainabilityInsightArray

pydantic model pypureclient.pure1.SustainabilityInsightArray(*, _as_of: Optional[StrictInt] = None, _interval_end: Optional[StrictInt] = None, _interval_start: Optional[StrictInt] = None, additional_data: Optional[Dict[str, Any]] = None, resource: Optional[FixedReferenceFqdn] = None, severity: Optional[StrictStr] = None, type: Optional[StrictStr] = None)

A single FlashArray/FlashBlade appliance Sustainability assessment insights information. The _as_of is the time when the computation happened. Only the data from the given time interval was used for the computation of insight. Typically the last week of data is used for the computation of insights.

field additional_data: Optional[Dict[str, Any]] = None

The arbitrary data associated with the insight.

field as_of: Optional[StrictInt] = None (alias '_as_of')

The freshness of the data (timestamp in millis since epoch).

field interval_end: Optional[StrictInt] = None (alias '_interval_end')

The timestamp of the end of the time interval.

field interval_start: Optional[StrictInt] = None (alias '_interval_start')

The timestamp of the start of the time interval.

field resource: Optional[FixedReferenceFqdn] = None

field severity: Optional[StrictStr] = None

The severity of the insight. Should be one of medium, high.

field type: Optional[StrictStr] = None

The type of the insight.

SustainabilityInsightArrayGetResponse

pydantic model pypureclient.pure1.SustainabilityInsightArrayGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[SustainabilityInsightArray]] = None)

field continuation_token: Optional[StrictStr] = None

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

field items: Optional[ConstrainedListValue[SustainabilityInsightArray]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

SustainabilityInsightArrayResponse

pydantic model pypureclient.pure1.SustainabilityInsightArrayResponse(*, items: Optional[ConstrainedListValue[SustainabilityInsightArray]] = None)

field items: Optional[ConstrainedListValue[SustainabilityInsightArray]] = None

Tag

pydantic model pypureclient.pure1.Tag(*, key: Optional[StrictStr] = None, namespace: Optional[StrictStr] = None, resource: Optional[FixedReference] = None, tag_organization_id: Optional[StrictInt] = None, value: Optional[StrictStr] = None)

field key: Optional[StrictStr] = None

Key of the tag.

field namespace: Optional[StrictStr] = None

Namespace of the tag. Namespace identifies the category of the tag.

field resource: Optional[FixedReference] = None

field tag_organization_id: Optional[StrictInt] = None

Org id of the tag.

field value: Optional[StrictStr] = None

Value of the tag.

TagGetResponse

pydantic model pypureclient.pure1.TagGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Tag]] = None)

field continuation_token: Optional[StrictStr] = None

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

field items: Optional[ConstrainedListValue[Tag]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

TagPut

pydantic model pypureclient.pure1.TagPut(*, key: Optional[StrictStr] = None, value: Optional[StrictStr] = None)

field key: Optional[StrictStr] = None

Key of the tag.

field value: Optional[StrictStr] = None

Value of the tag.

TagResponse

pydantic model pypureclient.pure1.TagResponse(*, items: Optional[ConstrainedListValue[Tag]] = None)

field items: Optional[ConstrainedListValue[Tag]] = None

Target

pydantic model pypureclient.pure1.Target(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None, address: Optional[StrictStr] = None, status: Optional[StrictStr] = None, status_details: Optional[StrictStr] = None)

field address: Optional[StrictStr] = None

IP address or FQDN of the target system.

field arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None

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.

field as_of: Optional[StrictInt] = None (alias '_as_of')

The freshness of the data (timestamp in millis since epoch).

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

A non-modifiable, locally unique name chosen by the system.

field status: Optional[StrictStr] = None

Status of the connection. Values include connected and connecting.

field status_details: Optional[StrictStr] = None

Additional information describing any issues encountered when connecting, or null if the status is connected.

TargetGetResponse

pydantic model pypureclient.pure1.TargetGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Target]] = None)

field continuation_token: Optional[StrictStr] = None

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

field items: Optional[ConstrainedListValue[Target]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

TargetResponse

pydantic model pypureclient.pure1.TargetResponse(*, items: Optional[ConstrainedListValue[Target]] = None)

field items: Optional[ConstrainedListValue[Target]] = None

Tax

pydantic model pypureclient.pure1.Tax(*, amount: Optional[Union[StrictFloat, StrictInt]] = None, exemption_statement: Optional[StrictStr] = None, percentage: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None)

field amount: Optional[Union[StrictFloat, StrictInt]] = None

The total taxes of current invoice item, currency is specified in invoice currency.

field exemption_statement: Optional[StrictStr] = None

The tax exemption statement.

field percentage: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

The tax ratio in percentage.

TimeAware

pydantic model pypureclient.pure1.TimeAware(*, _as_of: Optional[StrictInt] = None)

field as_of: Optional[StrictInt] = None (alias '_as_of')

The freshness of the data (timestamp in millis since epoch).

TimeInterval

pydantic model pypureclient.pure1.TimeInterval(*, _interval_end: Optional[StrictInt] = None, _interval_start: Optional[StrictInt] = None)

field interval_end: Optional[StrictInt] = None (alias '_interval_end')

The timestamp of the end of the time interval.

field interval_start: Optional[StrictInt] = None (alias '_interval_start')

The timestamp of the start of the time interval.

Volume

pydantic model pypureclient.pure1.Volume(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None, created: Optional[StrictInt] = None, destroyed: Optional[StrictBool] = None, eradicated: Optional[StrictBool] = None, pod: Optional[FixedReference] = None, provisioned: Optional[ConstrainedIntValue] = None, serial: Optional[StrictStr] = None, source: Optional[FixedReference] = None)

field arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None

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.

field as_of: Optional[StrictInt] = None (alias '_as_of')

The freshness of the data (timestamp in millis since epoch).

field created: Optional[StrictInt] = None

Creation time in milliseconds since UNIX epoch.

field destroyed: Optional[StrictBool] = None

Whether this volume has been destroyed or not.

Constraints

• type = boolean

field eradicated: Optional[StrictBool] = None

Whether this volume has been eradicated or not.

Constraints

• type = boolean

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

A modifiable, locally unique name chosen by the user.

field pod: Optional[FixedReference] = None

A reference to the pod this volume belongs to, if applicable.

field provisioned: Optional[ConstrainedIntValue] = None

Provisioned size of the volume in bytes.

Constraints

• minimum = 1048576

• maximum = 4503599627370496

field serial: Optional[StrictStr] = None

Serial number generated by Purity when the volume was created.

field source: Optional[FixedReference] = None

A reference to the volume this volume was cloned from, if applicable.

VolumeGetResponse

pydantic model pypureclient.pure1.VolumeGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Volume]] = None)

field continuation_token: Optional[StrictStr] = None

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

field items: Optional[ConstrainedListValue[Volume]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

VolumeResponse

pydantic model pypureclient.pure1.VolumeResponse(*, items: Optional[ConstrainedListValue[Volume]] = None)

field items: Optional[ConstrainedListValue[Volume]] = None

VolumeSnapshot

pydantic model pypureclient.pure1.VolumeSnapshot(*, _as_of: Optional[StrictInt] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None, created: Optional[StrictInt] = None, destroyed: Optional[StrictBool] = None, on: Optional[FixedReferenceFqdn] = None, pod: Optional[FixedReference] = None, provisioned: Optional[StrictInt] = None, serial: Optional[StrictStr] = None, snapshot_group: Optional[FixedReference] = None, source: Optional[FixedReference] = None, suffix: Optional[StrictStr] = None)

A point-in-time image of the contents of a volume.

field arrays: Optional[ConstrainedListValue[FixedReferenceFqdn]] = None

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.

field as_of: Optional[StrictInt] = None (alias '_as_of')

The freshness of the data (timestamp in millis since epoch).

field created: Optional[StrictInt] = None

Creation time in milliseconds since UNIX epoch.

field destroyed: Optional[StrictBool] = None

Indicates if this snapshot has been destroyed and is pending eradication.

Constraints

• type = boolean

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

A non-modifiable, locally unique name chosen by the system.

field on: Optional[FixedReferenceFqdn] = None

A reference to the array or the offload where the snapshot is stored.

field pod: Optional[FixedReference] = None

A reference to the pod the source volume belongs to, if applicable.

field provisioned: Optional[StrictInt] = None

Indicates the size (in bytes) of the volume when the snapshot was taken.

field serial: Optional[StrictStr] = None

Serial number generated by Purity when the snapshot was created.

field snapshot_group: Optional[FixedReference] = None

A reference to a consistency group snapshot that this snapshot is part of.

field source: Optional[FixedReference] = None

A reference to the volume that the snapshot was taken from.

field suffix: Optional[StrictStr] = None

Suffix added to the source volume name used to generate the volume snapshot name.

VolumeSnapshotGetResponse

pydantic model pypureclient.pure1.VolumeSnapshotGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[VolumeSnapshot]] = None)

field continuation_token: Optional[StrictStr] = None

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

field items: Optional[ConstrainedListValue[VolumeSnapshot]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

VolumeSnapshotResponse

pydantic model pypureclient.pure1.VolumeSnapshotResponse(*, items: Optional[ConstrainedListValue[VolumeSnapshot]] = None)

field items: Optional[ConstrainedListValue[VolumeSnapshot]] = None