pypureclient.pure1.Pure1_1_0 package

Subpackages

Submodules

pypureclient.pure1.Pure1_1_0.api_client module

Pure1 Public REST API

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: 1.0

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

class pypureclient.pure1.Pure1_1_0.api_client.ApiClient(configuration=None, header_name=None, header_value=None, cookie=None)

Bases: object

Generic API client for Swagger client library builds.

Swagger generic API client. This client handles the client- server communication, and is invariant across implementations. Specifics of the methods and models for each application are generated from the Swagger templates.

Parameters

  • configuration – .Configuration object for this client

  • header_name – a header to pass when making calls to the API.

  • header_value – a header value to pass when making calls to the API.

  • cookie – a cookie to include in the header when making calls to the API

NATIVE_TYPES_MAPPING = {'bool': <class 'bool'>, 'date': <class 'datetime.date'>, 'datetime': <class 'datetime.datetime'>, 'float': <class 'float'>, 'int': <class 'int'>, 'long': <class 'int'>, 'object': <class 'object'>, 'str': <class 'str'>}
PRIMITIVE_TYPES = (<class 'float'>, <class 'bool'>, <class 'bytes'>, <class 'str'>, <class 'int'>)
call_api(resource_path, method, path_params=None, query_params=None, header_params=None, body=None, post_params=None, files=None, response_type=None, auth_settings=None, async_req=None, _return_http_data_only=None, collection_formats=None, _preload_content=True, _request_timeout=None)

Makes the HTTP request (synchronous) and returns deserialized data.

To make an async request, set the async_req parameter.

Parameters

  • resource_path – Path to method endpoint.

  • method – Method to call.

  • path_params – Path parameters in the url.

  • query_params – Query parameters in the url.

  • header_params – Header parameters to be placed in the request header.

  • body – Request body.

  • dict (files) – Request post form parameters, for application/x-www-form-urlencoded, multipart/form-data.

  • list (auth_settings) – Auth Settings names for the request.

  • response – Response data type.

  • dict – key -> filename, value -> filepath, for multipart/form-data.

  • bool (async_req) – execute request asynchronously

  • _return_http_data_only – response data without head status code and headers

  • collection_formats – dict of collection formats for path, query, header, and post parameters.

  • _preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

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

Returns

If async_req parameter is True, the request will be called asynchronously. The method will return the request thread. If parameter async_req is False or missing, then the method will return the response directly.

close()
deserialize(response, response_type)

Deserializes response into an object.

Parameters

  • response – RESTResponse object to be deserialized.

  • response_type – class literal for deserialized object, or string of class name.

Returns

deserialized object.

extract_object_dict_from_object(obj)

Convert model obj to dict, using swagger_types and use attribute_map to determine json keys.

parameters_to_tuples(params, collection_formats)

Get parameters as list of tuples, formatting collections.

Parameters

  • params – Parameters as dict or list of two-tuples

  • collection_formats (dict) – Parameter collection formats

Returns

Parameters as list of tuples, collections formatted

prepare_post_parameters(post_params=None, files=None)

Builds form parameters.

Parameters

  • post_params – Normal form parameters.

  • files – File parameters.

Returns

Form parameters with files.

request(method, url, query_params=None, headers=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)

Makes the HTTP request using RESTClient.

sanitize_for_serialization(obj)

Builds a JSON POST object.

If obj is None, return None. If obj is str, int, long, float, bool, return directly. If obj is datetime.datetime, datetime.date

convert to string in iso8601 format.

If obj is list, sanitize each element in the list. If obj is dict, return the dict. If obj is swagger model, return the properties dict.

Parameters

obj – The data to serialize.

Returns

The serialized form of data.

select_header_accept(accepts)

Returns Accept based on an array of accepts provided.

Parameters

accepts – List of headers.

Returns

Accept (e.g. application/json).

select_header_content_type(content_types)

Returns Content-Type based on an array of content_types provided.

Parameters

content_types – List of content-types.

Returns

Content-Type (e.g. application/json).

set_default_header(header_name, header_value)
update_params_for_auth(headers, querys, auth_settings)

Updates header and query params based on authentication setting.

Parameters

  • headers – Header parameters dict to be updated.

  • querys – Query parameters tuple list to be updated.

  • auth_settings – Authentication setting identifiers list.

property user_agent

User agent for this API client

pypureclient.pure1.Pure1_1_0.client module

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

Bases: object

A client for making REST API calls to Pure1.

APP_ID_ENV = 'PURE1_APP_ID'
APP_ID_KEY = 'app_id'
ID_TOKEN_ENV = 'PURE1_ID_TOKEN'
ID_TOKEN_KEY = 'id_token'
PRIVATE_KEY_FILE_ENV = 'PURE1_PRIVATE_KEY_FILE'
PRIVATE_KEY_FILE_KEY = 'private_key_file'
PRIVATE_KEY_PASSWORD_ENV = 'PURE1_PRIVATE_KEY_PASSWORD'
PRIVATE_KEY_PASSWORD_KEY = 'private_key_password'
RETRIES_DEFAULT = 5
RETRIES_KEY = 'retries'
TIMEOUT_DEFAULT = 15.0
TIMEOUT_KEY = 'timeout'
TOKEN_ENDPOINT = 'https://api.pure1.purestorage.com/oauth2/1.0/token'
USER_AGENT = 'pypureclient/1.52.0/Pure1/1.0/Linux/5.15.0-25-generic'
__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, 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.

  • 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_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_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_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_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, volumes, and pods. 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_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 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, tag: Optional[List[TagPut]] = 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.

  • tag (list[TagPut], required) – A list of tags to be upserted.

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

pypureclient.pure1.Pure1_1_0.configuration module

Pure1 Public REST API

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: 1.0

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

class pypureclient.pure1.Pure1_1_0.configuration.Configuration

Bases: object

__init__()

Constructor

auth_settings()

Gets Auth Settings dict for api client.

Returns

The Auth Settings information dict.

property debug

Debug status

Parameters

value – The debug status, True or False.

Type

bool

get_api_key_with_prefix(identifier)

Gets API key (with prefix if set).

Parameters

identifier – The identifier of apiKey.

Returns

The token for api key authentication.

get_basic_auth_token()

Gets HTTP basic authentication header (string).

Returns

The token for basic HTTP authentication.

property logger_file

The logger file.

If the logger_file is None, then add stream handler and remove file handler. Otherwise, add file handler and remove stream handler.

Parameters

value – The logger_file path.

Type

str

property logger_format

The logger format.

The logger_formatter will be updated when sets logger_format.

Parameters

value – The format string.

Type

str

to_debug_report()

Gets the essential information for debugging.

Returns

The report for debugging.

class pypureclient.pure1.Pure1_1_0.configuration.TypeWithDefault(name, bases, dct)

Bases: type

set_default(default)

pypureclient.pure1.Pure1_1_0.rest module

Pure1 Public REST API

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: 1.0

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

exception pypureclient.pure1.Pure1_1_0.rest.ApiException(status=None, reason=None, http_resp=None)

Bases: Exception

__str__()

Custom error messages for exception

class pypureclient.pure1.Pure1_1_0.rest.RESTClientObject(configuration, pools_size=4, maxsize=None)

Bases: object

DELETE(url, headers=None, query_params=None, body=None, _preload_content=True, _request_timeout=None)
GET(url, headers=None, query_params=None, _preload_content=True, _request_timeout=None)
HEAD(url, headers=None, query_params=None, _preload_content=True, _request_timeout=None)
OPTIONS(url, headers=None, query_params=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)
PATCH(url, headers=None, query_params=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)
POST(url, headers=None, query_params=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)
PUT(url, headers=None, query_params=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)
request(method, url, query_params=None, headers=None, body=None, post_params=None, _preload_content=True, _request_timeout=None)

Perform requests.

Parameters

  • method – http request method

  • url – http request url

  • query_params – query parameters in the url

  • headers – http request headers

  • body – request json body, for application/json

  • post_params – request post parameters, application/x-www-form-urlencoded and multipart/form-data

  • _preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

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

class pypureclient.pure1.Pure1_1_0.rest.RESTResponse(resp)

Bases: IOBase

getheader(name, default=None)

Returns a given response header.

getheaders()

Returns a dictionary of the response headers.

Module contents

pypureclient.pure1.Pure1_1_0.add_properties(model)