pypureclient.pure1.Pure1_1_1.api package

Submodules

pypureclient.pure1.Pure1_1_1.api.alerts_api module

Pure1 Public REST API

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

OpenAPI spec version: 1.1

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

class pypureclient.pure1.Pure1_1_1.api.alerts_api.AlertsApi(api_client)

Bases: object

api11_alerts_get_with_http_info(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

Get alerts

Retrieves information about alerts generated by Pure1-monitored appliances. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api11_alerts_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

  • authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2)

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

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

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

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

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

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

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

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

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

  • _return_http_data_only (bool) – Returns only data field.

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

  • _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

AlertsGetResponse If the method is called asynchronously, returns the request thread.

pypureclient.pure1.Pure1_1_1.api.arrays_api module

Pure1 Public REST API

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

OpenAPI spec version: 1.1

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

class pypureclient.pure1.Pure1_1_1.api.arrays_api.ArraysApi(api_client)

Bases: object

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

Get arrays

Retrieves information about FlashArray and FlashBlade storage appliances. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api11_arrays_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

  • authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2)

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

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

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

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

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

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

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

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

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

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

  • _return_http_data_only (bool) – Returns only data field.

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

  • _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

ArrayGetResponse If the method is called asynchronously, returns the request thread.

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

Get array support contracts

Retrieves the support contracts associated with arrays. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api11_arrays_support_contracts_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

  • authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2)

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

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

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

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

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

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

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

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

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

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

  • _return_http_data_only (bool) – Returns only data field.

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

  • _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

SupportContractGetResponse If the method is called asynchronously, returns the request thread.

api11_arrays_tags_batch_put_with_http_info(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

Create or update array tags

Creates or updates array tags contextual to Pure1 only. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api11_arrays_tags_batch_put_with_http_info(tag, async_req=True) >>> result = thread.get()

Parameters

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

  • authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2)

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

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

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

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

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

  • _return_http_data_only (bool) – Returns only data field.

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

  • _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

TagResponse If the method is called asynchronously, returns the request thread.

api11_arrays_tags_delete_with_http_info(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

Delete array tags

Deletes array tags from Pure1. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api11_arrays_tags_delete_with_http_info(async_req=True) >>> result = thread.get()

Parameters

  • authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2)

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

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

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

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

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

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

  • _return_http_data_only (bool) – Returns only data field.

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

  • _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

None If the method is called asynchronously, returns the request thread.

api11_arrays_tags_get_with_http_info(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

Get array tags

Retrieves the tags associated with specified arrays. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api11_arrays_tags_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

  • authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2)

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

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

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

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

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

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

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

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

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

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

  • _return_http_data_only (bool) – Returns only data field.

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

  • _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

TagGetResponse If the method is called asynchronously, returns the request thread.

pypureclient.pure1.Pure1_1_1.api.audits_api module

Pure1 Public REST API

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

OpenAPI spec version: 1.1

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

class pypureclient.pure1.Pure1_1_1.api.audits_api.AuditsApi(api_client)

Bases: object

api11_audits_get_with_http_info(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

Get audits

Retrieves audit objects. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api11_audits_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

  • authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2)

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

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

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

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

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

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

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

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

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

  • _return_http_data_only (bool) – Returns only data field.

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

  • _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

AuditsGetResponse If the method is called asynchronously, returns the request thread.

pypureclient.pure1.Pure1_1_1.api.authorization_api module

Pure1 Public REST API

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

OpenAPI spec version: 1.1

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

class pypureclient.pure1.Pure1_1_1.api.authorization_api.AuthorizationApi(api_client)

Bases: object

oauth210_token_post_with_http_info(grant_type: Optional[str] = None, subject_token: Optional[str] = None, subject_token_type: Optional[str] = None, x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → OauthTokenResponse

Get access token

Exchanges an ID Token for an OAuth 2.0 access token. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.oauth210_token_post_with_http_info(grant_type, subject_token, subject_token_type, async_req=True) >>> result = thread.get()

Parameters

  • grant_type (str) – The method by which the access token will be obtained. The Pure Storage REST API supports the OAuth 2.0 “token exchange” grant type, which indicates that a token exchange is being performed. Set grant_type to urn:ietf:params:oauth:grant-type:token-exchange. (required)

  • subject_token (str) – An encoded security ID Token representing the identity of the party on behalf of whom the request is being made. The token must be issued by a trusted identity provider which must be either a registered application in Pure1 or an enabled API client on the array. The token must be a JSON Web Token and must contain the following claims: > | JWT claim | Location | API Client Field | Description | Required By | > |-|-|-|-|-| > | kid | Header | key_id | Key ID of the API client that issues the identity token. | FlashArray and FlashBlade only. | > | aud | Payload | id | Client ID of the API client that issues the identity token. | FlashArray and FlashBlade only. | > | sub | Payload | | Login name of the array user for whom the token should be issued. This must be a valid user in the system. | FlashArray and FlashBlade only. | > | iss | Payload | issuer | Application ID for the Pure1 or API client’s trusted identity issuer on the array. | All products. | > | iat | Payload | | Timestamp of when the identity token was issued. Measured in milliseconds since the UNIX epoch. | All products. | > | exp | Payload | | Timestamp of when the identity token will expire. Measured in milliseconds since the UNIX epoch. | All products. | Each token must also be signed with the private key that is paired with the API client’s public key. (required)

  • subject_token_type (str) – An identifier that indicates the type of security token specifed in the subject_token parameter. The Pure Storage REST API supports the JSON Web Token (JWT) as the means for requesting the access token. Set subject_token_type to urn:ietf:params:oauth:token-type:jwt. (required)

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

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

  • _return_http_data_only (bool) – Returns only data field.

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

  • _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

OauthTokenResponse If the method is called asynchronously, returns the request thread.

pypureclient.pure1.Pure1_1_1.api.blades_api module

Pure1 Public REST API

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

OpenAPI spec version: 1.1

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

class pypureclient.pure1.Pure1_1_1.api.blades_api.BladesApi(api_client)

Bases: object

api11_blades_get_with_http_info(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

Get blades

Retrieves information about FlashBlade blades. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api11_blades_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

  • authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2)

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

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

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

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

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

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

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

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

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

  • _return_http_data_only (bool) – Returns only data field.

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

  • _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

BladeGetResponse If the method is called asynchronously, returns the request thread.

pypureclient.pure1.Pure1_1_1.api.buckets_api module

Pure1 Public REST API

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

OpenAPI spec version: 1.1

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

class pypureclient.pure1.Pure1_1_1.api.buckets_api.BucketsApi(api_client)

Bases: object

api11_buckets_get_with_http_info(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

Get buckets

Retrieves buckets. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api11_buckets_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

  • authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2)

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

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

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

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

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

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

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

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

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

  • _return_http_data_only (bool) – Returns only data field.

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

  • _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

BucketGetResponse If the method is called asynchronously, returns the request thread.

pypureclient.pure1.Pure1_1_1.api.controllers_api module

Pure1 Public REST API

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

OpenAPI spec version: 1.1

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

class pypureclient.pure1.Pure1_1_1.api.controllers_api.ControllersApi(api_client)

Bases: object

api11_controllers_get_with_http_info(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

Get controllers

Retrieves information about controllers. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api11_controllers_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

  • authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2)

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

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

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

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

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

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

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

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

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

  • _return_http_data_only (bool) – Returns only data field.

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

  • _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

ControllerGetResponse If the method is called asynchronously, returns the request thread.

pypureclient.pure1.Pure1_1_1.api.directories_api module

Pure1 Public REST API

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

OpenAPI spec version: 1.1

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

class pypureclient.pure1.Pure1_1_1.api.directories_api.DirectoriesApi(api_client)

Bases: object

api11_directories_get_with_http_info(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

Get managed directories

Retrieves information about FlashArray managed directory objects. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api11_directories_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

  • authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2)

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

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

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

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

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

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

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

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

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

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

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

  • _return_http_data_only (bool) – Returns only data field.

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

  • _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

DirectoryGetResponse If the method is called asynchronously, returns the request thread.

pypureclient.pure1.Pure1_1_1.api.drives_api module

Pure1 Public REST API

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

OpenAPI spec version: 1.1

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

class pypureclient.pure1.Pure1_1_1.api.drives_api.DrivesApi(api_client)

Bases: object

api11_drives_get_with_http_info(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

Get drives

Retrieves information about FlashArray drives. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api11_drives_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

  • authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2)

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

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

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

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

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

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

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

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

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

  • _return_http_data_only (bool) – Returns only data field.

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

  • _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

DriveGetResponse If the method is called asynchronously, returns the request thread.

pypureclient.pure1.Pure1_1_1.api.file_system_snapshots_api module

Pure1 Public REST API

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

OpenAPI spec version: 1.1

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

class pypureclient.pure1.Pure1_1_1.api.file_system_snapshots_api.FileSystemSnapshotsApi(api_client)

Bases: object

api11_file_system_snapshots_get_with_http_info(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

Get FlashBlade file system snapshots

Retrieves snapshots of FlashBlade file systems. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api11_file_system_snapshots_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

  • authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2)

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

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

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

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

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

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

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

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

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

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

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

  • _return_http_data_only (bool) – Returns only data field.

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

  • _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

FileSystemSnapshotGetResponse If the method is called asynchronously, returns the request thread.

api11_file_system_snapshots_policies_get_with_http_info(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

Get FlashBlade file system snapshot / policy pairs

Retrieves pairs of FlashBlade file system snapshot members and their policies. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api11_file_system_snapshots_policies_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

  • authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2)

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

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

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

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

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

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

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

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

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

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

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

  • _return_http_data_only (bool) – Returns only data field.

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

  • _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

PolicyMembersGetResponse If the method is called asynchronously, returns the request thread.

pypureclient.pure1.Pure1_1_1.api.file_systems_api module

Pure1 Public REST API

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

OpenAPI spec version: 1.1

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

class pypureclient.pure1.Pure1_1_1.api.file_systems_api.FileSystemsApi(api_client)

Bases: object

api11_file_systems_get_with_http_info(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

Get FlashArray and FlashBlade file systems

Retrieves information about FlashArray and FlashBlade file system objects. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api11_file_systems_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

  • authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2)

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

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

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

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

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

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

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

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

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

  • _return_http_data_only (bool) – Returns only data field.

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

  • _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

FileSystemGetResponse If the method is called asynchronously, returns the request thread.

api11_file_systems_policies_get_with_http_info(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

Get FlashBlade file system / policy pairs

Retrieves pairs of FlashBlade file system members and their policies. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api11_file_systems_policies_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

  • authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2)

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

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

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

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

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

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

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

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

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

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

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

  • _return_http_data_only (bool) – Returns only data field.

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

  • _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

PolicyMembersGetResponse If the method is called asynchronously, returns the request thread.

pypureclient.pure1.Pure1_1_1.api.hardware_api module

Pure1 Public REST API

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

OpenAPI spec version: 1.1

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

class pypureclient.pure1.Pure1_1_1.api.hardware_api.HardwareApi(api_client)

Bases: object

api11_hardware_get_with_http_info(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

Get hardware

Retrieves information about hardware components. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api11_hardware_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

  • authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2)

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

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

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

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

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

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

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

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

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

  • _return_http_data_only (bool) – Returns only data field.

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

  • _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

HardwareGetResponse If the method is called asynchronously, returns the request thread.

pypureclient.pure1.Pure1_1_1.api.hardware_connectors_api module

Pure1 Public REST API

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

OpenAPI spec version: 1.1

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

class pypureclient.pure1.Pure1_1_1.api.hardware_connectors_api.HardwareConnectorsApi(api_client)

Bases: object

api11_hardware_connectors_get_with_http_info(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

Get hardware connectors

Retrieves information about FlashBlade hardware connectors. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api11_hardware_connectors_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

  • authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2)

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

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

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

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

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

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

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

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

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

  • _return_http_data_only (bool) – Returns only data field.

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

  • _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

HardwareConnectorGetResponse If the method is called asynchronously, returns the request thread.

pypureclient.pure1.Pure1_1_1.api.invoices_api module

Pure1 Public REST API

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

OpenAPI spec version: 1.1

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

class pypureclient.pure1.Pure1_1_1.api.invoices_api.InvoicesApi(api_client)

Bases: object

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

Get invoices

Retrieves information about Pure1 subscription invoices. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api11_invoices_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

  • authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2)

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

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

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

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

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

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

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

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

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

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

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

  • _return_http_data_only (bool) – Returns only data field.

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

  • _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

InvoiceGetResponse If the method is called asynchronously, returns the request thread.

pypureclient.pure1.Pure1_1_1.api.metrics_api module

Pure1 Public REST API

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

OpenAPI spec version: 1.1

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

class pypureclient.pure1.Pure1_1_1.api.metrics_api.MetricsApi(api_client)

Bases: object

api11_metrics_get_with_http_info(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

Get metrics

Retrieves information about metrics that can be queried for. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api11_metrics_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

  • authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2)

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

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

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

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

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

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

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

  • resource_types (list[str]) – The resource types to list the available metrics. Valid values are arrays, 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’]. Single quotes are required around all strings.

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

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

  • _return_http_data_only (bool) – Returns only data field.

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

  • _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

MetricGetResponse If the method is called asynchronously, returns the request thread.

api11_metrics_history_get_with_http_info(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

Get metrics history

Retrieves historical metric data for resources. This endpoint supports batching: Up to 32 time series can be retrieved in one call. It can be multiple metrics for one resource, (e.g., load and bandwidth for one array - 2 time series), one metric for multiple resource (e.g., load for arrayA and arrayB - 2 time series), or a combination of both, multiple metrics for multiple resources, (e.g., load and bandwidth for arrayA and arrayB - 4 time series). This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api11_metrics_history_get_with_http_info(aggregation, end_time, resolution, start_time, async_req=True) >>> result = thread.get()

Parameters

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

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

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

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

  • authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2)

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

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

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

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

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

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

  • _return_http_data_only (bool) – Returns only data field.

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

  • _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

MetricHistoryGetResponse If the method is called asynchronously, returns the request thread.

pypureclient.pure1.Pure1_1_1.api.network_interfaces_api module

Pure1 Public REST API

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

OpenAPI spec version: 1.1

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

class pypureclient.pure1.Pure1_1_1.api.network_interfaces_api.NetworkInterfacesApi(api_client)

Bases: object

api11_network_interfaces_get_with_http_info(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

Get network interfaces

Retrieves information about physical and virtual network interface objects. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api11_network_interfaces_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

  • authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2)

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

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

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

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

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

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

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

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

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

  • _return_http_data_only (bool) – Returns only data field.

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

  • _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

NetworkInterfaceGetResponse If the method is called asynchronously, returns the request thread.

pypureclient.pure1.Pure1_1_1.api.object_store_accounts_api module

Pure1 Public REST API

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

OpenAPI spec version: 1.1

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

class pypureclient.pure1.Pure1_1_1.api.object_store_accounts_api.ObjectStoreAccountsApi(api_client)

Bases: object

api11_object_store_accounts_get_with_http_info(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

Get object store accounts

Retrieves object store accounts. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api11_object_store_accounts_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

  • authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2)

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

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

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

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

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

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

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

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

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

  • _return_http_data_only (bool) – Returns only data field.

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

  • _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

ObjectStoreAccountGetResponse If the method is called asynchronously, returns the request thread.

pypureclient.pure1.Pure1_1_1.api.pods_api module

Pure1 Public REST API

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

OpenAPI spec version: 1.1

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

class pypureclient.pure1.Pure1_1_1.api.pods_api.PodsApi(api_client)

Bases: object

api11_pods_get_with_http_info(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

Get pods

Retrieves information about pod objects. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api11_pods_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

  • authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2)

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

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

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

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

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

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

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

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

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

  • _return_http_data_only (bool) – Returns only data field.

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

  • _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

PodGetResponse If the method is called asynchronously, returns the request thread.

pypureclient.pure1.Pure1_1_1.api.policies_api module

Pure1 Public REST API

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

OpenAPI spec version: 1.1

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

class pypureclient.pure1.Pure1_1_1.api.policies_api.PoliciesApi(api_client)

Bases: object

Get policy / FlashBlade file system replica link pairs

Retrieves pairs of policy references and their FlashBlade file system replica link members. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api11_policies_file_system_replica_links_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

  • authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2)

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

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

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

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

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

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

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

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

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

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

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

  • _return_http_data_only (bool) – Returns only data field.

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

  • _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

PolicyMembersGetResponse If the method is called asynchronously, returns the request thread.

api11_policies_file_system_snapshots_get_with_http_info(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

Get policy / FlashBlade file system snapshot pairs

Retrieves pairs of policy references and their FlashBlade file system snapshot members. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api11_policies_file_system_snapshots_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

  • authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2)

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

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

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

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

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

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

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

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

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

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

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

  • _return_http_data_only (bool) – Returns only data field.

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

  • _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

PolicyMembersGetResponse If the method is called asynchronously, returns the request thread.

api11_policies_file_systems_get_with_http_info(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

Get policy / FlashBlade file system pairs

Retrieves pairs of policy references and their FlashBlade file system members. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api11_policies_file_systems_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

  • authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2)

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

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

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

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

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

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

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

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

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

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

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

  • _return_http_data_only (bool) – Returns only data field.

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

  • _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

PolicyMembersGetResponse If the method is called asynchronously, returns the request thread.

api11_policies_get_with_http_info(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

Get policies

Retrieves policies and their rules. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api11_policies_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

  • authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2)

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

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

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

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

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

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

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

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

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

  • _return_http_data_only (bool) – Returns only data field.

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

  • _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

PolicyGetResponse If the method is called asynchronously, returns the request thread.

api11_policies_members_get_with_http_info(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

Get policy / member pairs

Retrieves pairs of policy references and their members. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api11_policies_members_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

  • authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2)

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

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

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

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

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

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

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

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

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

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

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

  • _return_http_data_only (bool) – Returns only data field.

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

  • _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

PolicyMembersGetResponse If the method is called asynchronously, returns the request thread.

pypureclient.pure1.Pure1_1_1.api.ports_api module

Pure1 Public REST API

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

OpenAPI spec version: 1.1

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

class pypureclient.pure1.Pure1_1_1.api.ports_api.PortsApi(api_client)

Bases: object

api11_ports_get_with_http_info(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

Get ports

Retrieves information about FlashArray ports. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api11_ports_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

  • authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2)

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

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

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

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

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

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

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

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

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

  • _return_http_data_only (bool) – Returns only data field.

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

  • _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

PortGetResponse If the method is called asynchronously, returns the request thread.

pypureclient.pure1.Pure1_1_1.api.subscriptions_api module

Pure1 Public REST API

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

OpenAPI spec version: 1.1

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

class pypureclient.pure1.Pure1_1_1.api.subscriptions_api.SubscriptionsApi(api_client)

Bases: object

api11_subscription_licenses_get_with_http_info(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

Get subscription licenses

Retrieves information about Pure1 subscription licenses. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api11_subscription_licenses_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

  • authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2)

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

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

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

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

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

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

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

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

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

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

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

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

  • _return_http_data_only (bool) – Returns only data field.

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

  • _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

SubscriptionLicenseGetResponse If the method is called asynchronously, returns the request thread.

api11_subscriptions_get_with_http_info(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

Get subscriptions

Retrieves information about Pure1 subscriptions. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api11_subscriptions_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

  • authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2)

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

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

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

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

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

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

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

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

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

  • _return_http_data_only (bool) – Returns only data field.

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

  • _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

SubscriptionGetResponse If the method is called asynchronously, returns the request thread.

pypureclient.pure1.Pure1_1_1.api.sustainability_api module

Pure1 Public REST API

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

OpenAPI spec version: 1.1

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

class pypureclient.pure1.Pure1_1_1.api.sustainability_api.SustainabilityApi(api_client)

Bases: object

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

Get appliance sustainability information.

Retrieves information about FlashArray and FlashBlade size, power consumption, heat generation and its sustainability assessment. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api11_assessment_sustainability_arrays_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

  • authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2)

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

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

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

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

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

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

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

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

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

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

  • _return_http_data_only (bool) – Returns only data field.

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

  • _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

SustainabilityArrayGetResponse If the method is called asynchronously, returns the request thread.

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

Get appliance sustainability insights information.

Retrieves information about FlashArray and FlashBlade insights connected to sustainability assessment. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api11_assessment_sustainability_insights_arrays_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

  • authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2)

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

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

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

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

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

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

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

  • _return_http_data_only (bool) – Returns only data field.

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

  • _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

SustainabilityInsightArrayGetResponse If the method is called asynchronously, returns the request thread.

pypureclient.pure1.Pure1_1_1.api.targets_api module

Pure1 Public REST API

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

OpenAPI spec version: 1.1

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

class pypureclient.pure1.Pure1_1_1.api.targets_api.TargetsApi(api_client)

Bases: object

api11_targets_get_with_http_info(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

Get targets

Retrieves information about targets. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api11_targets_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

  • authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2)

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

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

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

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

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

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

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

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

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

  • _return_http_data_only (bool) – Returns only data field.

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

  • _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

TargetGetResponse If the method is called asynchronously, returns the request thread.

pypureclient.pure1.Pure1_1_1.api.volume_snapshots_api module

Pure1 Public REST API

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

OpenAPI spec version: 1.1

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

class pypureclient.pure1.Pure1_1_1.api.volume_snapshots_api.VolumeSnapshotsApi(api_client)

Bases: object

api11_volume_snapshots_get_with_http_info(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

Get volume snapshots

Retrieves information about snapshots of volumes. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api11_volume_snapshots_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

  • authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2)

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

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

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

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

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

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

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

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

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

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

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

  • _return_http_data_only (bool) – Returns only data field.

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

  • _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

VolumeSnapshotGetResponse If the method is called asynchronously, returns the request thread.

pypureclient.pure1.Pure1_1_1.api.volumes_api module

Pure1 Public REST API

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

OpenAPI spec version: 1.1

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

class pypureclient.pure1.Pure1_1_1.api.volumes_api.VolumesApi(api_client)

Bases: object

api11_volumes_get_with_http_info(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

Get volumes

Retrieves information about FlashArray volume objects. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api11_volumes_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

  • authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2)

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

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

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

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

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

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

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

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

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

  • _return_http_data_only (bool) – Returns only data field.

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

  • _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

VolumeGetResponse If the method is called asynchronously, returns the request thread.

Module contents