Pure1 Reference

Client

Pure1 REST Client Factory Method

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.

__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[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, keys: Optional[List[str]] = None, namespaces: Optional[List[str]] = None, resource_ids: Optional[List[str]] = None, resource_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) None

Deletes array tags from Pure1.

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • keys (list[str], optional) – A list of tag keys.

  • namespaces (list[str], optional) – A list of namespaces.

  • resource_ids (list[str], optional) – REQUIRED: either resource_ids or resource_names. A list of resource IDs. If there is not at least one resource that matches each resource_id element, an error is returned.

  • resource_names (list[str], optional) – REQUIRED: either resource_ids or resource_names. A list of resource names. If there is not at least one resource that matches each resource_name element, an error is returned.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • 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[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) AlertsGetResponse

Retrieves information about alerts generated by Pure1-monitored appliances.

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If there is not at least one resource that matches each id element, an error is returned.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each name element, an error is returned.

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

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_arrays(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, fqdns: Optional[List[str]] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) ArrayGetResponse

Retrieves information about FlashArray and FlashBlade storage appliances.

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • fqdns (list[str], optional) – A list of resource FQDNs. If there is not at least one resource that matches each fqdn element, an error is returned.

  • ids (list[str], optional) – A list of resource IDs. If there is not at least one resource that matches each id element, an error is returned.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each name element, an error is returned.

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

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_arrays_support_contracts(resources: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, resource_ids: Optional[List[str]] = None, resource_fqdns: Optional[List[str]] = None, resource_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) SupportContractGetResponse

Retrieves the support contracts associated with arrays.

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

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

  • resource_ids (list[str], optional) – A list of resource IDs. If there is not at least one resource that matches each resource_id element, an error is returned.

  • resource_fqdns (list[str], optional) – A list of resource FQDNs. If there is not at least one resource that matches each resource_fqdn element, an error is returned.

  • resource_names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each resource_name element, an error is returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_arrays_tags(resources: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, keys: Optional[List[str]] = None, limit: Optional[int] = None, namespaces: Optional[List[str]] = None, offset: Optional[int] = None, resource_ids: Optional[List[str]] = None, resource_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) TagGetResponse

Retrieves the tags associated with specified arrays.

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • keys (list[str], optional) – A list of tag keys.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • namespaces (list[str], optional) – A list of namespaces.

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

  • resource_ids (list[str], optional) – A list of resource IDs. If there is not at least one resource that matches each resource_id element, an error is returned.

  • resource_names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each resource_name element, an error is returned.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_assessment_sustainability_arrays(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, fqdns: Optional[List[str]] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) SustainabilityArrayGetResponse

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • fqdns (list[str], optional) – A list of resource FQDNs. If there is not at least one resource that matches each fqdn element, an error is returned.

  • ids (list[str], optional) – A list of resource IDs. If there is not at least one resource that matches each id element, an error is returned.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each name element, an error is returned.

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

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_assessment_sustainability_insights_arrays(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) SustainabilityInsightArrayGetResponse

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

Parameters
  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

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

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_audits(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) AuditsGetResponse

Retrieves audit objects.

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If there is not at least one resource that matches each id element, an error is returned.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each name element, an error is returned.

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

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_blades(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) BladeGetResponse

Retrieves information about FlashBlade blades.

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If there is not at least one resource that matches each id element, an error is returned.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each name element, an error is returned.

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

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

Retrieves information about bucket replica links.

Parameters
  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids keyword arguments.

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

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If there is not at least one resource that matches each id element, an error is returned.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • member_ids (list[str], optional) – 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. 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], optional) – 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. 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, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • source_ids (list[str], optional) – 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. 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], optional) – 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. 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], optional) – 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. 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], optional) – 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. 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) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_buckets(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) BucketGetResponse

Retrieves buckets.

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If there is not at least one resource that matches each id element, an error is returned.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each name element, an error is returned.

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

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_controllers(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) ControllerGetResponse

Retrieves information about controllers.

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If there is not at least one resource that matches each id element, an error is returned.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each name element, an error is returned.

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

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_directories(file_systems: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, file_system_ids: Optional[List[str]] = None, file_system_names: Optional[List[str]] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) DirectoryGetResponse

Retrieves information about FlashArray managed directory objects.

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • file_system_ids (list[str], optional) – 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.

  • file_system_names (list[str], optional) – 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.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If there is not at least one resource that matches each id element, an error is returned.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each name element, an error is returned.

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

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_drives(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) DriveGetResponse

Retrieves information about FlashArray drives.

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If there is not at least one resource that matches each id element, an error is returned.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each name element, an error is returned.

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

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

Retrieves information about FlashBlade file system replica links.

Parameters
  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids keyword arguments.

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

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If there is not at least one resource that matches each id element, an error is returned.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • member_ids (list[str], optional) – 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. 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], optional) – 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. 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, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • source_ids (list[str], optional) – 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. 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], optional) – 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. 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], optional) – 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. 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], optional) – 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. 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) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

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

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • member_ids (list[str], optional) – A list of member IDs. If there is not at least one resource that matches each member_id element, an error is returned.

  • member_names (list[str], optional) – A list of member names. If there is not at least one resource that matches each member_name element, an error is returned.

  • policy_ids (list[str], optional) – A list of policy IDs. If there is not at least one resource that matches each policy_id element, an error is returned.

  • policy_names (list[str], optional) – A list of policy names. If there is not at least one resource that matches each policy_name element, an error is returned.

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

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_file_system_snapshots(references: Optional[List[ReferenceType]] = None, sources: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, source_ids: Optional[List[str]] = None, source_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) FileSystemSnapshotGetResponse

Retrieves snapshots of FlashBlade file systems.

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If there is not at least one resource that matches each id element, an error is returned.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each name element, an error is returned.

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

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • source_ids (list[str], optional) – A 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.

  • source_names (list[str], optional) – A 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.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_file_system_snapshots_policies(members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) PolicyMembersGetResponse

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

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • member_ids (list[str], optional) – A list of member IDs. If there is not at least one resource that matches each member_id element, an error is returned.

  • member_names (list[str], optional) – A list of member names. If there is not at least one resource that matches each member_name element, an error is returned.

  • policy_ids (list[str], optional) – A list of policy IDs. If there is not at least one resource that matches each policy_id element, an error is returned.

  • policy_names (list[str], optional) – A list of policy names. If there is not at least one resource that matches each policy_name element, an error is returned.

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

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_file_systems(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) FileSystemGetResponse

Retrieves information about FlashArray and FlashBlade file system objects.

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If there is not at least one resource that matches each id element, an error is returned.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each name element, an error is returned.

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

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_file_systems_policies(members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) PolicyMembersGetResponse

Retrieves pairs of FlashBlade file system members and their policies.

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • member_ids (list[str], optional) – A list of member IDs. If there is not at least one resource that matches each member_id element, an error is returned.

  • member_names (list[str], optional) – A list of member names. If there is not at least one resource that matches each member_name element, an error is returned.

  • policy_ids (list[str], optional) – A list of policy IDs. If there is not at least one resource that matches each policy_id element, an error is returned.

  • policy_names (list[str], optional) – A list of policy names. If there is not at least one resource that matches each policy_name element, an error is returned.

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

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_hardware(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) HardwareGetResponse

Retrieves information about hardware components.

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If there is not at least one resource that matches each id element, an error is returned.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each name element, an error is returned.

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

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_hardware_connectors(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) HardwareConnectorGetResponse

Retrieves information about FlashBlade hardware connectors.

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If there is not at least one resource that matches each id element, an error is returned.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each name element, an error is returned.

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

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_invoices(references: Optional[List[ReferenceType]] = None, subscriptions: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, partner_purchase_orders: Optional[List[str]] = None, subscription_ids: Optional[List[str]] = None, subscription_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) InvoiceGetResponse

Retrieves information about Pure1 subscription invoices.

Parameters
  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids keyword arguments.

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If there is not at least one resource that matches each id element, an error is returned.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

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

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • partner_purchase_orders (list[str], optional) – A 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.

  • subscription_ids (list[str], optional) – A list of subscription IDs. If there is not at least one resource that matches each subscription.id element, an error is returned.

  • subscription_names (list[str], optional) – A list of subscription names. If there is not at least one resource that matches each subscription.name element, an error is returned.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_metrics(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, resource_types: Optional[List[str]] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) MetricGetResponse

Retrieves information about metrics that can be queried for.

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If there is not at least one resource that matches each id element, an error is returned.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each name element, an error is returned.

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

  • resource_types (list[str], optional) – 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’].

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_metrics_history(references: Optional[List[ReferenceType]] = None, resources: Optional[List[ReferenceType]] = None, aggregation: Optional[str] = None, end_time: Optional[int] = None, resolution: Optional[int] = None, start_time: Optional[int] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, resource_ids: Optional[List[str]] = None, resource_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) MetricHistoryGetResponse

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
  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

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

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

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

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – REQUIRED: either ids or names. A list of object IDs. If there is not at least one resource that matches each id element, an error is returned.

  • names (list[str], optional) – REQUIRED: either names or ids. A list of resource names. If there is not at least one resource that matches each name element, an error is returned.

  • resource_ids (list[str], optional) – REQUIRED: either resource_ids or resource_names. A list of resource IDs. If there is not at least one resource that matches each resource_id element, an error is returned.

  • resource_names (list[str], optional) – REQUIRED: either resource_ids or resource_names. A list of resource names. If there is not at least one resource that matches each resource_name element, an error is returned.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_network_interfaces(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) NetworkInterfaceGetResponse

Retrieves information about physical and virtual network interface objects.

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If there is not at least one resource that matches each id element, an error is returned.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each name element, an error is returned.

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

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_object_store_accounts(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) ObjectStoreAccountGetResponse

Retrieves object store accounts.

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If there is not at least one resource that matches each id element, an error is returned.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each name element, an error is returned.

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

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

Retrieves information about pod replica links.

Parameters
  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids keyword arguments.

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

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If there is not at least one resource that matches each id element, an error is returned.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • member_ids (list[str], optional) – 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. 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], optional) – 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. 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, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • source_ids (list[str], optional) – 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. 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], optional) – 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. 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], optional) – 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. 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], optional) – 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. 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) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_pods(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) PodGetResponse

Retrieves information about pod objects.

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If there is not at least one resource that matches each id element, an error is returned.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each name element, an error is returned.

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

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_policies(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) PolicyGetResponse

Retrieves policies and their rules.

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If there is not at least one resource that matches each id element, an error is returned.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each name element, an error is returned.

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

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

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

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • member_ids (list[str], optional) – A list of member IDs. If there is not at least one resource that matches each member_id element, an error is returned.

  • member_names (list[str], optional) – A list of member names. If there is not at least one resource that matches each member_name element, an error is returned.

  • policy_ids (list[str], optional) – A list of policy IDs. If there is not at least one resource that matches each policy_id element, an error is returned.

  • policy_names (list[str], optional) – A list of policy names. If there is not at least one resource that matches each policy_name element, an error is returned.

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

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_policies_file_system_snapshots(members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) PolicyMembersGetResponse

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

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • member_ids (list[str], optional) – A list of member IDs. If there is not at least one resource that matches each member_id element, an error is returned.

  • member_names (list[str], optional) – A list of member names. If there is not at least one resource that matches each member_name element, an error is returned.

  • policy_ids (list[str], optional) – A list of policy IDs. If there is not at least one resource that matches each policy_id element, an error is returned.

  • policy_names (list[str], optional) – A list of policy names. If there is not at least one resource that matches each policy_name element, an error is returned.

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

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_policies_file_systems(members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) PolicyMembersGetResponse

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

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • member_ids (list[str], optional) – A list of member IDs. If there is not at least one resource that matches each member_id element, an error is returned.

  • member_names (list[str], optional) – A list of member names. If there is not at least one resource that matches each member_name element, an error is returned.

  • policy_ids (list[str], optional) – A list of policy IDs. If there is not at least one resource that matches each policy_id element, an error is returned.

  • policy_names (list[str], optional) – A list of policy names. If there is not at least one resource that matches each policy_name element, an error is returned.

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

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_policies_members(members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) PolicyMembersGetResponse

Retrieves pairs of policy references and their members.

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • member_ids (list[str], optional) – A list of member IDs. If there is not at least one resource that matches each member_id element, an error is returned.

  • member_names (list[str], optional) – A list of member names. If there is not at least one resource that matches each member_name element, an error is returned.

  • policy_ids (list[str], optional) – A list of policy IDs. If there is not at least one resource that matches each policy_id element, an error is returned.

  • policy_names (list[str], optional) – A list of policy names. If there is not at least one resource that matches each policy_name element, an error is returned.

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

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_ports(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) PortGetResponse

Retrieves information about FlashArray ports.

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If there is not at least one resource that matches each id element, an error is returned.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each name element, an error is returned.

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

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_subscription_assets(references: Optional[List[ReferenceType]] = None, subscriptions: Optional[List[ReferenceType]] = None, licenses: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, advanced_space: Optional[bool] = None, subscription_ids: Optional[List[str]] = None, subscription_names: Optional[List[str]] = None, license_ids: Optional[List[str]] = None, license_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) SubscriptionAssetGetResponse

Retrieves information about Pure1 subscription assets.

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

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If there is not at least one resource that matches each id element, an error is returned.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each name element, an error is returned.

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

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

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

  • subscription_ids (list[str], optional) – A list of subscription IDs. If there is not at least one resource that matches each subscription.id element, an error is returned.

  • subscription_names (list[str], optional) – A list of subscription names. If there is not at least one resource that matches each subscription.name element, an error is returned.

  • license_ids (list[str], optional) – A list of subscriptionLicense IDs. If there is not at least one resource that matches each license.id element, an error is returned.

  • license_names (list[str], optional) – A list of subscriptionLicense names. If there is not at least one resource that matches each license.name element, an error is returned.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_subscription_licenses(references: Optional[List[ReferenceType]] = None, marketplace_partner_references: Optional[List[ReferenceType]] = None, subscriptions: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, marketplace_partner_reference_ids: Optional[List[str]] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, subscription_ids: Optional[List[str]] = None, subscription_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) SubscriptionLicenseGetResponse

Retrieves information about Pure1 subscription licenses.

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

  • marketplace_partner_references (list[FixedReference], optional) – A list of marketplace_partner_references to query for. Overrides marketplace_partner_reference_ids keyword arguments.

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If there is not at least one resource that matches each id element, an error is returned.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • marketplace_partner_reference_ids (list[str], optional) – A 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.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each name element, an error is returned.

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

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • subscription_ids (list[str], optional) – A list of subscription IDs. If there is not at least one resource that matches each subscription.id element, an error is returned.

  • subscription_names (list[str], optional) – A list of subscription names. If there is not at least one resource that matches each subscription.name element, an error is returned.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_subscriptions(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) SubscriptionGetResponse

Retrieves information about Pure1 subscriptions.

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If there is not at least one resource that matches each id element, an error is returned.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each name element, an error is returned.

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

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_targets(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) TargetGetResponse

Retrieves information about targets.

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If there is not at least one resource that matches each id element, an error is returned.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each name element, an error is returned.

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

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_volume_snapshots(references: Optional[List[ReferenceType]] = None, sources: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, source_ids: Optional[List[str]] = None, source_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) VolumeSnapshotGetResponse

Retrieves information about snapshots of volumes.

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If there is not at least one resource that matches each id element, an error is returned.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each name element, an error is returned.

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

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • source_ids (list[str], optional) – A 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.

  • source_names (list[str], optional) – A 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.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_volumes(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) VolumeGetResponse

Retrieves information about FlashArray volume objects.

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If there is not at least one resource that matches each id element, an error is returned.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each name element, an error is returned.

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

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

put_arrays_tags(resources: Optional[List[ReferenceType]] = None, error_unknown: Optional[TagBatchRequired] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, namespaces: Optional[List[str]] = None, resource_ids: Optional[List[str]] = None, resource_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) TagResponse

Creates or updates array tags contextual to Pure1 only.

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

  • error_unknown (TagBatchRequired, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • namespaces (list[str], optional) – A list of namespaces.

  • resource_ids (list[str], optional) – REQUIRED: either resource_ids or resource_names. A list of resource IDs. If there is not at least one resource that matches each resource_id element, an error is returned.

  • resource_names (list[str], optional) – REQUIRED: either resource_ids or resource_names. A list of resource names. If there is not at least one resource that matches each resource_name element, an error is returned.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • 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

Alert

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

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, name=None, id=None, arrays=None, severity=None, summary=None, actual=None, code=None, knowledge_base_url=None, created=None, notified=None, component_name=None, expected=None, origin=None, description=None, component_type=None, closed=None, state=None, category=None, updated=None)
Keyword Arguments
  • as_of (int) – The freshness of the data (timestamp in millis since epoch).

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

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

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

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

  • summary (str) – Summary of the alert.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Array

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

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, name=None, id=None, os=None, fqdn=None, model=None, version=None)
Keyword Arguments
  • as_of (int) – The freshness of the data (timestamp in millis since epoch).

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

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

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

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

  • model (str) – Model of the array.

  • version (str) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

AssetAddress

class pypureclient.pure1.AssetAddress(country=None, city=None, state=None, street_address=None)
swagger_types

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(country=None, city=None, state=None, street_address=None)
Keyword Arguments
  • country (str) –

  • city (str) –

  • state (str) – The state or province.

  • street_address (str) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

AssetOrg

class pypureclient.pure1.AssetOrg(name=None)
swagger_types

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None)
Keyword Arguments

name (str) – The organization name for the asset.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

AssetSpace

class pypureclient.pure1.AssetSpace(total_used_ratio=None, total_used=None, capacity=None)
swagger_types

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(total_used_ratio=None, total_used=None, capacity=None)
Keyword Arguments
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

AssetSpaceTotalUsedRatio

class pypureclient.pure1.AssetSpaceTotalUsedRatio(unit=None, data=None, metric=None)
swagger_types

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(unit=None, data=None, metric=None)
Keyword Arguments
  • unit (str) – The unit of the metric.

  • data (float) –

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

AssetUpgradeDetails

class pypureclient.pure1.AssetUpgradeDetails(upgrade_eligibility_date=None, commitment_date=None, action_needed=None)
swagger_types

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(upgrade_eligibility_date=None, commitment_date=None, action_needed=None)
Keyword Arguments
  • upgrade_eligibility_date (int) – 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.

  • commitment_date (int) – The date until which you need to commit to an Evergreen//Forever subscription to be eligible for the next Ever Modern Upgrade.

  • action_needed (str) – The action required to obtain the next free upgrade under your Evergreen//Forever subscription.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Audit

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

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, name=None, id=None, arrays=None, subcommand=None, origin=None, arguments=None, time=None, user=None, command=None)
Keyword Arguments
  • as_of (int) – The freshness of the data (timestamp in millis since epoch).

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

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

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

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

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

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

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

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

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

BaseAddress

class pypureclient.pure1.BaseAddress(country=None, city=None, state=None)
swagger_types

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(country=None, city=None, state=None)
Keyword Arguments
  • country (str) –

  • city (str) –

  • state (str) – The state or province.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Blade

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

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, name=None, id=None, raw_capacity=None, details=None, arrays=None, status=None)
Keyword Arguments
  • as_of (int) – The freshness of the data (timestamp in millis since epoch).

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

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

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

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

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

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

BladeArrayStatus

class pypureclient.pure1.BladeArrayStatus(name=None, resource_type=None, id=None, total_blades=None, fqdn=None, used_blades=None)
swagger_types

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, resource_type=None, id=None, total_blades=None, fqdn=None, used_blades=None)
Keyword Arguments
  • name (str) – The name of this resource.

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

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

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

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

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Bucket

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

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, name=None, id=None, arrays=None, destroyed=None, versioning=None, created=None, object_count=None, account=None)
Keyword Arguments
  • as_of (int) – The freshness of the data (timestamp in millis since epoch).

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

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

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

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

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

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

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

  • account (FixedReference) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Controller

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

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, name=None, id=None, arrays=None, mode=None, model=None, type=None, version=None, status=None)
Keyword Arguments
  • as_of (int) – The freshness of the data (timestamp in millis since epoch).

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

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

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

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

  • model (str) – Model of the controller.

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

  • version (str) – Version of the controller.

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

CurrentMetric

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

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(unit=None, data=None, metric=None)
Keyword Arguments
  • unit (str) – The unit of the metric.

  • data (float) – The data value.

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

DefaultDetails

class pypureclient.pure1.DefaultDetails
swagger_types

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__()

Keyword args:

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Directory

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

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, name=None, id=None, arrays=None, path=None, destroyed=None, file_system=None, created=None, directory_name=None)
Keyword Arguments
  • as_of (int) – The freshness of the data (timestamp in millis since epoch).

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

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

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

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

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

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

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

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Drive

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

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, name=None, id=None, protocol=None, details=None, arrays=None, type=None, capacity=None, status=None)
Keyword Arguments
  • as_of (int) – The freshness of the data (timestamp in millis since epoch).

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

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

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

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

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

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

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

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

DriveArrayStatus

class pypureclient.pure1.DriveArrayStatus(name=None, resource_type=None, id=None, drive_count=None, fqdn=None, total_capacity=None)
swagger_types

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, resource_type=None, id=None, drive_count=None, fqdn=None, total_capacity=None)
Keyword Arguments
  • name (str) – The name of this resource.

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

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

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

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

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Error

class pypureclient.pure1.Error(errors=None)
swagger_types

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(errors=None)
Keyword Arguments

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ErrorErrors

class pypureclient.pure1.ErrorErrors(context=None, message=None)
swagger_types

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(context=None, message=None)
Keyword Arguments
  • context (str) –

  • message (str) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ErrorNoContext

class pypureclient.pure1.ErrorNoContext(message=None)
swagger_types

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(message=None)
Keyword Arguments

message (str) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

EvergreenForeverAndFoundationDetails

class pypureclient.pure1.EvergreenForeverAndFoundationDetails(service_sla=None, service_tier=None)
swagger_types

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(service_sla=None, service_tier=None)
Keyword Arguments
  • service_sla (str) – The associated Service Level Agreements (SLAs) for the service tier.

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

FileSystem

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

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, name=None, id=None, arrays=None, destroyed=None, hard_limit_enabled=None, provisioned=None, created=None, http=None, smb=None, nfs=None, snapshot_directory_enabled=None, fast_remove_directory_enabled=None)
Keyword Arguments
  • as_of (int) – The freshness of the data (timestamp in millis since epoch).

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

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

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

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

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

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

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

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

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

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

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

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

FileSystemSnapshot

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

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, name=None, id=None, arrays=None, destroyed=None, created=None, source=None, suffix=None, on=None)
Keyword Arguments
  • as_of (int) – The freshness of the data (timestamp in millis since epoch).

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

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

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

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

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

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

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

  • on (FixedReferenceFqdn) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

FixedReference

class pypureclient.pure1.FixedReference(name=None, resource_type=None, id=None)
swagger_types

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, resource_type=None, id=None)
Keyword Arguments
  • name (str) – The name of this resource.

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

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

FixedReferenceFqdn

class pypureclient.pure1.FixedReferenceFqdn(name=None, resource_type=None, id=None, fqdn=None)
swagger_types

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, resource_type=None, id=None, fqdn=None)
Keyword Arguments
  • name (str) – The name of this resource.

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

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

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Geolocation

class pypureclient.pure1.Geolocation(latitude=None, longitude=None)
swagger_types

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(latitude=None, longitude=None)
Keyword Arguments
  • latitude (float) – The latitude of the address.

  • longitude (float) – The longitude of the address.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Hardware

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

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, name=None, id=None, arrays=None, identify_enabled=None, serial=None, temperature=None, details=None, model=None, slot=None, type=None, speed=None, status=None, voltage=None)
Keyword Arguments
  • as_of (int) – The freshness of the data (timestamp in millis since epoch).

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

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

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

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

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

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

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

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

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

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

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

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

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

HardwareConnector

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

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, name=None, id=None, arrays=None, lane_speed=None, transceiver_type=None, connector_type=None, port_count=None)
Keyword Arguments
  • as_of (int) – The freshness of the data (timestamp in millis since epoch).

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

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

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

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

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

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

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Http

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

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(enabled=None)
Keyword Arguments

enabled (bool) – Is the protocol enabled?

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

InstallAddress

class pypureclient.pure1.InstallAddress(street_address=None, updated=None, geolocation=None)
swagger_types

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(street_address=None, updated=None, geolocation=None)
Keyword Arguments
  • street_address (str) – The 1-line format street address of the array install address.

  • updated (int) – The epoch timestamp, in milliseconds, that denotes when the address was updated.

  • geolocation (Geolocation) – The geolocation that contains the latitude and the longitude of the address.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Invoice

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

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(_date=None, amount=None, due_date=None, end_user_purchase_order=None, subscription=None, end_user_name=None, payment_terms=None, partner_purchase_order=None, sales_representative=None, currency=None, id=None, lines=None, ship_date=None, status=None)
Keyword Arguments
  • _date (int) – The issuance date. Represented as a timestamp of 00:00 on that date in UTC, in milliseconds since UNIX epoch.

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

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

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

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

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

  • payment_terms (str) – The invoice payment terms.

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

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

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

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

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

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

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

InvoiceLine

class pypureclient.pure1.InvoiceLine(end_date=None, amount=None, components=None, item=None, quantity=None, description=None, tax=None, unit_price=None, start_date=None)
swagger_types

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(end_date=None, amount=None, components=None, item=None, quantity=None, description=None, tax=None, unit_price=None, start_date=None)
Keyword Arguments
  • end_date (int) – The invoice item end date. Represented as a timestamp of 00:00 on that date in UTC, in milliseconds since UNIX epoch.

  • amount (float) – The total price of current invoice item, currency is specified in invoice currency.

  • components (list[InvoiceLineComponent]) – The sub-components of current invoice item.

  • item (str) – The name of invoice item.

  • quantity (int) – The quantity of current invoice item.

  • description (str) –

  • tax (Tax) –

  • unit_price (float) – The unit price of current invoice item, currency is specified in invoice currency.

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

InvoiceLineComponent

class pypureclient.pure1.InvoiceLineComponent(item=None, quantity=None, description=None)
swagger_types

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(item=None, quantity=None, description=None)
Keyword Arguments
  • item (str) – The name of invoice component.

  • quantity (int) – The quantity of current invoice component.

  • description (str) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

LicenseResourceReference

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

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, resource_type=None, id=None, fqdn=None, usage=None, activation_time=None)
Keyword Arguments
  • name (str) – The name of this resource.

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

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

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

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

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

MarketplacePartner

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

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(reference_id=None, name=None)
Keyword Arguments
  • reference_id (str) – External ID the marketplace partner knows to refer to this license.

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Metric

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

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, name=None, id=None, unit=None, availabilities=None, description=None, resource_types=None)
Keyword Arguments
  • as_of (int) – The freshness of the data (timestamp in millis since epoch).

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

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

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

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

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

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

MetricAvailability

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

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

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

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

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

MetricHistory

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

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, name=None, id=None, unit=None, data=None, resources=None, aggregation=None, resolution=None)
Keyword Arguments
  • as_of (int) – The freshness of the data (timestamp in millis since epoch).

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

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

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

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

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

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

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

NetworkInterface

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

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, name=None, id=None, arrays=None, hwaddr=None, address=None, netmask=None, services=None, subinterfaces=None, enabled=None, gateway=None, speed=None, mtu=None)
Keyword Arguments
  • as_of (int) – The freshness of the data (timestamp in millis since epoch).

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

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

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

  • hwaddr (str) – Hardware address.

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

  • netmask (str) –

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

  • subinterfaces (list[str]) –

  • enabled (bool) –

  • gateway (str) –

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

  • mtu (int) – Maximum transmission unit.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Nfs

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

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(rules=None, enabled=None)
Keyword Arguments
  • rules (str) – NFS rules.

  • enabled (bool) – Is the protocol enabled?

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ObjectStoreAccount

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

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, name=None, id=None, arrays=None, created=None, object_count=None)
Keyword Arguments
  • as_of (int) – The freshness of the data (timestamp in millis since epoch).

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

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

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

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

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Pod

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

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, name=None, id=None, arrays=None, source=None, mediator=None)
Keyword Arguments
  • as_of (int) – The freshness of the data (timestamp in millis since epoch).

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

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

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

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

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Policy

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

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, name=None, id=None, arrays=None, rules=None, enabled=None)
Keyword Arguments
  • as_of (int) – The freshness of the data (timestamp in millis since epoch).

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

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

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

  • rules (list[PolicyRule]) –

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

PolicyMember

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

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, member=None, policy=None)
Keyword Arguments
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

PolicyRule

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

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

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

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

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

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Port

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

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, name=None, id=None, arrays=None, failover=None, iqn=None, nqn=None, portal=None, wwn=None)
Keyword Arguments
  • as_of (int) – The freshness of the data (timestamp in millis since epoch).

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

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

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

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

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

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

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

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Resource

class pypureclient.pure1.Resource(as_of=None, name=None, id=None)
swagger_types

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, name=None, id=None)
Keyword Arguments
  • as_of (int) – The freshness of the data (timestamp in millis since epoch).

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

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ResourceNoName

class pypureclient.pure1.ResourceNoName(as_of=None, id=None)
swagger_types

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, id=None)
Keyword Arguments
  • as_of (int) – The freshness of the data (timestamp in millis since epoch).

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ResourceWithLocation

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

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, resource_type=None, id=None, location=None)
Keyword Arguments
  • name (str) – The name of this resource.

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

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

  • location (FixedReferenceFqdn) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ResourceWithLocations

class pypureclient.pure1.ResourceWithLocations(name=None, resource_type=None, id=None, locations=None)
swagger_types

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, resource_type=None, id=None, locations=None)
Keyword Arguments
  • name (str) – The name of this resource.

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

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

  • locations (list[FixedReferenceFqdn]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Smb

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

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(enabled=None)
Keyword Arguments

enabled (bool) – Is the protocol enabled?

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Subscription

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

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, name=None, id=None, service_details=None, initial_name=None, partner_name=None, service=None, organization=None, subscription_term=None, expiration_date=None, last_updated_date=None, start_date=None, status=None)
Keyword Arguments
  • as_of (int) – The freshness of the data (timestamp in millis since epoch).

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

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

  • service_details (object) – Additional details for the given service.

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

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

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

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

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

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

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

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

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SubscriptionAsset

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

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, name=None, id=None, license=None, activation_date=None, array=None, organization=None, end_of_life_date=None, subscription=None, upgrade_details=None, install_address=None)
Keyword Arguments
  • as_of (int) – The freshness of the data (timestamp in millis since epoch).

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

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

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

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

  • array (SubscriptionAssetArray) – The specific fields for assets that are arrays.

  • organization (AssetOrg) – The Pure1 organization for the asset.

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

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

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

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SubscriptionAssetArray

class pypureclient.pure1.SubscriptionAssetArray(chassis_serial_number=None, model=None, advanced_space=None, version=None, space=None)
swagger_types

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(chassis_serial_number=None, model=None, advanced_space=None, version=None, space=None)
Keyword Arguments
  • chassis_serial_number (str) – The chassis serial number of the appliance.

  • model (str) – The model of the appliance.

  • advanced_space (SubscriptionAssetArrayAdvancedSpace) – The physical and effective space information. Only visible when the query parameter advanced_space is set to true.

  • version (str) – The Purity version of the appliance.

  • space (AssetSpace) – 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.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SubscriptionAssetArrayAdvancedSpace

class pypureclient.pure1.SubscriptionAssetArrayAdvancedSpace(effective=None, physical=None)
swagger_types

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(effective=None, physical=None)
Keyword Arguments
  • effective (AssetSpace) – The effective space information of the appliance.

  • physical (AssetSpace) – The physical space information of the appliance.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SubscriptionLicense

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

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, name=None, id=None, average_on_demand=None, quarter_on_demand=None, usage=None, resources=None, marketplace_partner=None, subscription=None, expiration_date=None, add_on_slas=None, pre_ratio=None, site_address=None, reservation=None, service_tier=None, last_updated_date=None, start_date=None)
Keyword Arguments
  • as_of (int) – The freshness of the data (timestamp in millis since epoch).

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

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

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

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

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

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

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

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

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

  • add_on_slas (list[SubscriptionLicenseAddOnSla]) – Add-on SLAs.

  • pre_ratio (SubscriptionLicensePreRatio) –

  • site_address (BaseAddress) – The license site address.

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

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

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

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SubscriptionLicenseAddOnSla

class pypureclient.pure1.SubscriptionLicenseAddOnSla(name)
swagger_types

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name)
Keyword Arguments

name (str, required) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SubscriptionLicensePreRatio

class pypureclient.pure1.SubscriptionLicensePreRatio(unit=None, data=None, metric=None)
swagger_types

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(unit=None, data=None, metric=None)
Keyword Arguments
  • unit (str) – The unit of the metric.

  • data (float) –

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SupportContract

class pypureclient.pure1.SupportContract(end_date=None, resource=None, start_date=None)
swagger_types

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

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

  • resource (FixedReferenceFqdn) –

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SustainabilityArray

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

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, name=None, id=None, assessment=None, reporting_status=None, install_address=None)
Keyword Arguments
  • as_of (int) – The freshness of the data (timestamp in millis since epoch).

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

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

  • assessment (SustainabilityAssessment) –

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

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SustainabilityAssessment

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

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, interval_end=None, interval_start=None, blades=None, capacity_utilization=None, heat_peak_spec=None, heat_average=None, array_data_reduction=None, chassis=None, power_average=None, power_peak_spec=None, power_per_usable_capacity=None, array_total_load=None, assessment_level=None, shelves=None, heat_typical_spec=None, power_per_used_space=None, rack_units=None, power_typical_spec=None)
Keyword Arguments
  • as_of (int) – The freshness of the data (timestamp in millis since epoch).

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SustainabilityInsightArray

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

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, interval_end=None, interval_start=None, severity=None, additional_data=None, resource=None, type=None)
Keyword Arguments
  • as_of (int) – The freshness of the data (timestamp in millis since epoch).

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

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

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

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

  • resource (FixedReferenceFqdn) –

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Tag

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

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(resource=None, tag_organization_id=None, namespace=None, value=None, key=None)
Keyword Arguments
  • resource (FixedReference) –

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

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

  • value (str) – Value of the tag.

  • key (str) – Key of the tag.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

TagBatchRequired

class pypureclient.pure1.TagBatchRequired
swagger_types

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__()

Keyword args:

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

TagPut

class pypureclient.pure1.TagPut(value=None, key=None)
swagger_types

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(value=None, key=None)
Keyword Arguments
  • value (str) – Value of the tag.

  • key (str) – Key of the tag.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Target

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

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, name=None, id=None, arrays=None, address=None, status_details=None, status=None)
Keyword Arguments
  • as_of (int) – The freshness of the data (timestamp in millis since epoch).

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

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

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

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

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

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Tax

class pypureclient.pure1.Tax(exemption_statement=None, amount=None, percentage=None)
swagger_types

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(exemption_statement=None, amount=None, percentage=None)
Keyword Arguments
  • exemption_statement (str) – The tax exemption statement.

  • amount (float) – The total taxes of current invoice item, currency is specified in invoice currency.

  • percentage (float) – The tax ratio in percentage.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

TimeInterval

class pypureclient.pure1.TimeInterval(interval_end=None, interval_start=None)
swagger_types

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(interval_end=None, interval_start=None)
Keyword Arguments
  • interval_end (int) – The timestamp of the end of the time interval.

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Volume

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

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, name=None, id=None, arrays=None, destroyed=None, pod=None, provisioned=None, serial=None, created=None, source=None, eradicated=None)
Keyword Arguments
  • as_of (int) – The freshness of the data (timestamp in millis since epoch).

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

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

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

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

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

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

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

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

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

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

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

VolumeSnapshot

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

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

Type

dict

attribute_map

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

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(as_of=None, name=None, id=None, arrays=None, destroyed=None, pod=None, provisioned=None, serial=None, created=None, source=None, suffix=None, snapshot_group=None, on=None)
Keyword Arguments
  • as_of (int) – The freshness of the data (timestamp in millis since epoch).

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

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

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

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

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

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

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

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

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

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

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

  • on (FixedReferenceFqdn) – A reference to the array or the offload where the snapshot is stored.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model