pypureclient.flasharray.FA_2_32.api package

Submodules

pypureclient.flasharray.FA_2_32.api.active_directory_api module

FlashArray REST API

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

OpenAPI spec version: 2.32

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

class pypureclient.flasharray.FA_2_32.api.active_directory_api.ActiveDirectoryApi(api_client)

Bases: object

api232_active_directory_delete_with_http_info(names: Optional[List[str]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, local_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Delete Active Directory account

Deletes one or more specified Active Directory accounts. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_active_directory_delete_with_http_info(names, async_req=True) >>> result = thread.get()

Parameters

• names (list[str]) – Performs the operation on the unique name specified. For example, name01. Enter multiple names in comma-separated format. (required)

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

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

• local_only (bool) – If specified as true, only delete the Active Directory configuration on the local array, without deleting the computer account created in the Active Directory domain. If not specified, defaults to false.

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

api232_active_directory_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, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ActiveDirectoryGetResponse

List Active Directory accounts

Displays configured Active Directory accounts. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_active_directory_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_active_directory_patch_with_http_info(names: Optional[List[str]] = None, active_directory: Optional[ActiveDirectoryPatch] = None, authorization: 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) → ActiveDirectoryResponse

Modify Active Directory account

Modifies specified Active Directory account. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_active_directory_patch_with_http_info(names, active_directory, async_req=True) >>> result = thread.get()

Parameters

• names (list[str]) – Performs the operation on the unique name specified. For example, name01. Enter multiple names in comma-separated format. (required)

• active_directory (ActiveDirectoryPatch) – (required)

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

• 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

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

api232_active_directory_post_with_http_info(names: Optional[List[str]] = None, active_directory: Optional[ActiveDirectoryPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, join_existing_account: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ActiveDirectoryResponse

Create Active Directory account

Creates one or more Active Directory accounts. The user and password provided are used to join the array to the specified domain. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_active_directory_post_with_http_info(names, active_directory, async_req=True) >>> result = thread.get()

Parameters

• names (list[str]) – Performs the operation on the unique name specified. For example, name01. Enter multiple names in comma-separated format. (required)

• active_directory (ActiveDirectoryPost) – (required)

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

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

• join_existing_account (bool) – If specified as true, the domain is searched for a pre-existing computer account to join to, and no new account will be created within the domain. The user specified when joining a pre-existing account must have permissions to ‘read all properties from’ and ‘reset the password of’ the pre-existing account. join_ou will be read from the pre-existing account and cannot be specified when joining to an existing account. If not specified, defaults to false.

• 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

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

pypureclient.flasharray.FA_2_32.api.administrators_api module

FlashArray REST API

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

OpenAPI spec version: 2.32

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

class pypureclient.flasharray.FA_2_32.api.administrators_api.AdministratorsApi(api_client)

Bases: object

api232_admins_api_tokens_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, 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 API tokens

Deletes the API tokens of the specified administrators. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_admins_api_tokens_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, /login, and /logout)

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

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

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

api232_admins_api_tokens_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, expose_api_token: Optional[bool] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → AdminApiTokenGetResponse

List API tokens

Displays API tokens for the specified administrators. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_admins_api_tokens_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• expose_api_token (bool) – If true, exposes the API token of the current user.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_admins_api_tokens_post_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, timeout: Optional[int] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → AdminApiTokenResponse

Create API tokens

Creates API tokens for the specified administrators. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_admins_api_tokens_post_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, /login, and /logout)

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

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• timeout (int) – The duration of API token validity, in milliseconds.

• 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

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

api232_admins_cache_delete_with_http_info(remove_all_entries: Optional[bool] = None, authorization: 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) → None

Delete cache entries

Deletes all entries from the administrator cache. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_admins_cache_delete_with_http_info(remove_all_entries, async_req=True) >>> result = thread.get()

Parameters

• remove_all_entries (bool) – If set to true, removes all entries from the administrator cache. (required)

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

• 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

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

api232_admins_cache_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, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → AdminCacheGetResponse

List administrator cache entries

Displays entries in the administrator cache. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_admins_cache_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_admins_cache_put_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → AdminCacheResponse

Update or refresh entries in the administrator cache

Updates entries in the cache for administrators who currently do not have a cache entry, otherwise refreshes the existing entry. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_admins_cache_put_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, /login, and /logout)

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

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• 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

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

api232_admins_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, 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 an administrator

Deletes the specified administrator. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_admins_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, /login, and /logout)

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

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

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

api232_admins_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, expose_api_token: Optional[bool] = None, expose_public_key: Optional[bool] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → AdminGetResponse

List administrators

Displays a list of administrators. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_admins_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• expose_api_token (bool) – If true, exposes the API token of the current user.

• expose_public_key (bool) – If true, exposes the public key of the current user.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_admins_patch_with_http_info(admin: Optional[AdminPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → AdminResponse

Modify an administrator

Modifies properties for the specified administrator. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_admins_patch_with_http_info(admin, async_req=True) >>> result = thread.get()

Parameters

• admin (AdminPatch) – (required)

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

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

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• 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

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

api232_admins_post_with_http_info(admin: Optional[AdminPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → AdminResponse

Create an administrator

Creates an administrator. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_admins_post_with_http_info(admin, async_req=True) >>> result = thread.get()

Parameters

• admin (AdminPost) – (required)

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

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

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• 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

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

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

List administrator settings

Displays the global administrator settings for the array. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_admins_settings_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, /login, and /logout)

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

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_admins_settings_patch_with_http_info(admin_settings: Optional[AdminSettings] = None, authorization: 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) → AdminSettingsResponse

Modify administrator settings

Modifies the global administrator settings for the array. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_admins_settings_patch_with_http_info(admin_settings, async_req=True) >>> result = thread.get()

Parameters

• admin_settings (AdminSettings) – (required)

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

• 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

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

pypureclient.flasharray.FA_2_32.api.alert_watchers_api module

FlashArray REST API

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

OpenAPI spec version: 2.32

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

class pypureclient.flasharray.FA_2_32.api.alert_watchers_api.AlertWatchersApi(api_client)

Bases: object

api232_alert_watchers_delete_with_http_info(names: Optional[List[str]] = None, authorization: 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) → None

Delete alert watcher

Delete alert watcher email address from the list of alert watchers. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_alert_watchers_delete_with_http_info(names, async_req=True) >>> result = thread.get()

Parameters

• names (list[str]) – Performs the operation on the unique name specified. For example, name01. Enter multiple names in comma-separated format. (required)

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

• 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

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

api232_alert_watchers_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, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → AlertWatcherGetResponse

List alert watchers

Displays alert watcher email addressess and indicates whether they are enabled. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_alert_watchers_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_alert_watchers_patch_with_http_info(names: Optional[List[str]] = None, alert_watcher: Optional[AlertWatcherPatch] = None, authorization: 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) → AlertWatcherResponse

Modify alert watcher

Modify alert watcher email address by enabling or disabling it. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_alert_watchers_patch_with_http_info(names, alert_watcher, async_req=True) >>> result = thread.get()

Parameters

• names (list[str]) – Performs the operation on the unique name specified. For example, name01. Enter multiple names in comma-separated format. (required)

• alert_watcher (AlertWatcherPatch) – (required)

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

• 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

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

api232_alert_watchers_post_with_http_info(names: Optional[List[str]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, alert_watcher: Optional[AlertWatcherPost] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → AlertWatcherResponse

Create alert watcher

Creates one or more alert watcher email addresses, adding them to the list of alert watchers. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_alert_watchers_post_with_http_info(names, async_req=True) >>> result = thread.get()

Parameters

• names (list[str]) – Performs the operation on the unique name specified. For example, name01. Enter multiple names in comma-separated format. (required)

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

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

• alert_watcher (AlertWatcherPost) –

• 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

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

api232_alert_watchers_test_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → TestResultWithResourceGetResponse

List alert watcher test

Displays alert watcher email test results. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_alert_watchers_test_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, /login, and /logout)

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

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

pypureclient.flasharray.FA_2_32.api.alerts_api module

FlashArray REST API

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

OpenAPI spec version: 2.32

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

class pypureclient.flasharray.FA_2_32.api.alerts_api.AlertsApi(api_client)

Bases: object

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

List alert events

Displays a list of alert events. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_alerts_events_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• flagged (bool) – If set to true, lists only flagged messages. If set to false, lists only unflagged messages. if not specified, lists all messages.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. For example, name01. Enter multiple names in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

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

List alerts

Displays a list of alerts. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• flagged (bool) – If set to true, lists only flagged messages. If set to false, lists only unflagged messages. if not specified, lists all messages.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_alerts_patch_with_http_info(alert: Optional[Alert] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → AlertResponse

Modify flagged state

Modifies one or more alerts and display updated information about these alerts. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_alerts_patch_with_http_info(alert, async_req=True) >>> result = thread.get()

Parameters

• alert (Alert) – (required)

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

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

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• 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

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

api232_alerts_rules_catalog_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, code: Optional[int] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → AlertRulesCatalogGetResponse

List available customizable alert codes

Displays a list of available customizable alert codes. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_alerts_rules_catalog_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, /login, and /logout)

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

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• code (int) – The alert code to display.

• 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

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

api232_alerts_rules_delete_with_http_info(code: Optional[int] = None, parameter: Optional[str] = None, authorization: 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) → None

Delete a custom alert rule

Deletes a custom alert rule. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_alerts_rules_delete_with_http_info(code, parameter, async_req=True) >>> result = thread.get()

Parameters

• code (int) – The alert code that the rule applies to. Available alert codes for customization can be found in the alert rules catalog. (required)

• parameter (str) – The parameter of the custom alert rule to modify. Values include info and warning. Available parameter values can be found in the alert rules catalog. (required)

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

• 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

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

api232_alerts_rules_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, code: Optional[int] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → AlertRulesGetResponse

List custom alert rules

Displays a list of custom alert rules. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_alerts_rules_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, /login, and /logout)

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

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• code (int) – The alert code to display.

• 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

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

api232_alerts_rules_patch_with_http_info(code: Optional[int] = None, parameter: Optional[str] = None, alert_rule: Optional[AlertRules] = None, authorization: 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) → AlertRulesResponse

Modify a custom alert rule

Modifies a custom alert rule to a new value. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_alerts_rules_patch_with_http_info(code, parameter, alert_rule, async_req=True) >>> result = thread.get()

Parameters

• code (int) – The alert code that the rule applies to. Available alert codes for customization can be found in the alert rules catalog. (required)

• parameter (str) – The parameter of the custom alert rule to modify. Values include info and warning. Available parameter values can be found in the alert rules catalog. (required)

• alert_rule (AlertRules) – (required)

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

• 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

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

api232_alerts_rules_post_with_http_info(code: Optional[int] = None, parameter: Optional[str] = None, alert_rule: Optional[AlertRules] = None, authorization: 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) → AlertRulesResponse

Create a custom alert rule

Creates an alert rule with a custom value. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_alerts_rules_post_with_http_info(code, parameter, alert_rule, async_req=True) >>> result = thread.get()

Parameters

• code (int) – The alert code that the rule applies to. Available alert codes for customization can be found in the alert rules catalog. (required)

• parameter (str) – The parameter of the custom alert rule to modify. Values include info and warning. Available parameter values can be found in the alert rules catalog. (required)

• alert_rule (AlertRules) – (required)

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

• 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

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

pypureclient.flasharray.FA_2_32.api.api_clients_api module

FlashArray REST API

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

OpenAPI spec version: 2.32

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

class pypureclient.flasharray.FA_2_32.api.api_clients_api.APIClientsApi(api_client)

Bases: object

api232_api_clients_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, 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 an API client

Deletes an API client. The ids or names parameter is required, but they cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_api_clients_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, /login, and /logout)

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

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

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

api232_api_clients_get_with_http_info(authorization: Optional[str] = None, x_request_id: 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, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ApiClientGetResponse

List API clients

Returns a list of API clients. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_api_clients_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, /login, and /logout)

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

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_api_clients_patch_with_http_info(api_clients: Optional[ApiClientPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ApiClientResponse

Manage an API client

Enables or disables an API client. The ids or names parameter is required, but they cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_api_clients_patch_with_http_info(api_clients, async_req=True) >>> result = thread.get()

Parameters

• api_clients (ApiClientPatch) – (required)

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

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

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• 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

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

api232_api_clients_post_with_http_info(api_clients: Optional[ApiClientPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ApiClientResponse

Create an API client

Creates an API client. Newly created API clients are disabled by default. Enable an API client through the PATCH method. The names, max_role, issuer, and public_key parameters are required. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_api_clients_post_with_http_info(api_clients, async_req=True) >>> result = thread.get()

Parameters

• api_clients (ApiClientPost) – (required)

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

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

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• 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

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

pypureclient.flasharray.FA_2_32.api.apps_api module

FlashArray REST API

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

OpenAPI spec version: 2.32

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

class pypureclient.flasharray.FA_2_32.api.apps_api.AppsApi(api_client)

Bases: object

api232_apps_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, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → AppGetResponse

List apps

Displays a list of installed apps. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_apps_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

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

List app nodes

Displays a list of installed apps and their nodes. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_apps_nodes_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• app_names (list[str]) – The name of the installed app. Enter multiple names in comma-separated format.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_apps_patch_with_http_info(names: Optional[List[str]] = None, app: Optional[App] = None, authorization: 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) → AppResponse

Modify app

Modifies an installed app or modifies Virtual Network Computing (VNC) access for apps that are being patched. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_apps_patch_with_http_info(names, app, async_req=True) >>> result = thread.get()

Parameters

• names (list[str]) – Performs the operation on the unique name specified. For example, name01. Enter multiple names in comma-separated format. (required)

• app (App) – (required)

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

• 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

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

pypureclient.flasharray.FA_2_32.api.array_connections_api module

FlashArray REST API

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

OpenAPI spec version: 2.32

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

class pypureclient.flasharray.FA_2_32.api.array_connections_api.ArrayConnectionsApi(api_client)

Bases: object

api232_array_connections_connection_key_get_with_http_info(authorization: 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) → ArrayConnectionKeyGetResponse

List connection key

Displays the connection key for the array. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_array_connections_connection_key_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, /login, and /logout)

• 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

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

api232_array_connections_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, 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 an array connection

Deletes the connection to the current array from the specified array. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_array_connections_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, /login, and /logout)

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

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

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

api232_array_connections_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, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ArrayConnectionGetResponse

List connected arrays

Display a list of connected arrays. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_array_connections_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_array_connections_patch_with_http_info(array_connection: Optional[Throttle] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ArrayConnectionResponse

Modify an array connection

Modifies the bandwidth throttling attributes for a connected array. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_array_connections_patch_with_http_info(array_connection, async_req=True) >>> result = thread.get()

Parameters

• array_connection (Throttle) – (required)

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

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

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• 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

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

api232_array_connections_path_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, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ArrayConnectionPathGetResponse

List connection path

Displays the connection path from the array where the connection was made. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_array_connections_path_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_array_connections_post_with_http_info(array_connection: Optional[ArrayConnectionPost] = None, authorization: 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) → ArrayConnectionResponse

Create an array connection

Creates a connection between the current array and the specified array. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_array_connections_post_with_http_info(array_connection, async_req=True) >>> result = thread.get()

Parameters

• array_connection (ArrayConnectionPost) – (required)

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

• 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

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

pypureclient.flasharray.FA_2_32.api.arrays_api module

FlashArray REST API

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

OpenAPI spec version: 2.32

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

class pypureclient.flasharray.FA_2_32.api.arrays_api.ArraysApi(api_client)

Bases: object

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

List CBS array capacity status

Displays the capacity status of the CBS array including the progress of the capacity update. Requests for non-CBS arrays will receive an error response. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_arrays_cloud_capacity_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, /login, and /logout)

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

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_arrays_cloud_capacity_patch_with_http_info(capacity: Optional[CloudCapacityStatus] = None, authorization: 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) → CloudCapacityPatchResponse

Modify CBS array capacity

Modifies the raw capacity of the CBS array. This should trigger a backend process that will update the CBS array capacity. The array capacity can be updated only to values defined by the capacity steps endpoint. When an existing capacity update request is in progress, any new request to update of the capacity will receive an error response. For non-CBS arrays, this feature is not supported and requests will receive an error response. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_arrays_cloud_capacity_patch_with_http_info(capacity, async_req=True) >>> result = thread.get()

Parameters

• capacity (CloudCapacityStatus) – The requested capacity of the CBS array. (required)

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

• 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

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

api232_arrays_cloud_capacity_supported_steps_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, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → CloudCapacityStepsGetResponse

List CBS array capacity steps

Displays the list of supported raw capacity sizes in bytes the CBS array can be upgraded to. Requests for non-CBS arrays will receive an error response. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_arrays_cloud_capacity_supported_steps_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_arrays_cloud_provider_tags_batch_put_with_http_info(tag: Optional[List[CloudProviderTag]] = None, authorization: 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) → CloudProviderTagResponse

Update user tags on the cloud.

Updates users tags to deployed cloud resources of a CBS array. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_arrays_cloud_provider_tags_batch_put_with_http_info(tag, async_req=True) >>> result = thread.get()

Parameters

• tag (list[CloudProviderTag]) – A list of tags to be created or, if already existing, updated. (required)

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

• 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

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

api232_arrays_cloud_provider_tags_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, keys: 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 user tags from the cloud.

Deletes user tags from deployed cloud resources of a CBS array. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_arrays_cloud_provider_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, /login, and /logout)

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

• keys (list[str]) – A comma-separated list of tag keys.

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

api232_arrays_cloud_provider_tags_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, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → CloudProviderTagGetResponse

List user tags on the cloud.

Displays the list of user tags on deployed cloud resources of a CBS array. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_arrays_cloud_provider_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_arrays_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, eradicate_all_data: Optional[bool] = None, factory_reset_token: Optional[int] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Delete an array

Deletes an array. For physical appliances, deleting an array restores the hardware to factory settings. This entails deleting all data, metadata, configuration, and logs. The array returns to the state it was in prior to any configuration changes being made. If the hardware is reused, it must be as a different array with a new ID. For virtual appliances, deleting an array puts it into an unusable state. Virtual resources (e.g., virtual machines) can later be freed, which deletes any remaining data, metadata, configuration, and logs. Prior to factory reset, an array must be manually prepared (e.g., all volumes and snapshots must be eradicated) and a factory reset token must be created. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_arrays_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, /login, and /logout)

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

• eradicate_all_data (bool) – Set to true to perform a factory reset.

• factory_reset_token (int) – A token required to perform a factory reset.

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

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

List End User Agreement and signature

Displays the End User Agreement and signature. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_arrays_eula_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, /login, and /logout)

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

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_arrays_eula_patch_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, eula: Optional[Eula] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → EulaResponse

Modify signature on the End User Agreement

Modifies the signature on the End User Agreement. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_arrays_eula_patch_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, /login, and /logout)

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

• eula (Eula) –

• 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

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

api232_arrays_factory_reset_token_delete_with_http_info(authorization: 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) → None

Delete a factory reset token

Deletes an existing token that could be used to perform a factory reset on the array. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_arrays_factory_reset_token_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, /login, and /logout)

• 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

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

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

List factory reset tokens

Displays a list of tokens used to perform a factory reset on the array. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_arrays_factory_reset_token_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, /login, and /logout)

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

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_arrays_factory_reset_token_post_with_http_info(authorization: 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) → ArrayFactoryResetTokenResponse

Create a factory reset token

Creates a token that can be used to perform a factory reset on the array. Factory reset tokens can only be created after the array has been prepared for reset (e.g., all volumes and snapshots must first be eradicated). After a token has been created, operations that would take the array out of the prepared state are disabled (e.g., creating volumes) until all tokens have been deleted. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_arrays_factory_reset_token_post_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, /login, and /logout)

• 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

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

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

List arrays

Displays general array properties including the array name, login banner, idle timeout for management sessions, and NTP servers. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_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, /login, and /logout)

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

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

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

api232_arrays_ntp_test_get_with_http_info(authorization: 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) → TestResultGetResponse

List NTP test results

Displays test results for configured NTP servers. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_arrays_ntp_test_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, /login, and /logout)

• 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

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

api232_arrays_patch_with_http_info(array: Optional[Arrays] = None, authorization: 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) → ArrayResponse

Modify an array

Modifies general array properties such as the array name, login banner, idle timeout for management sessions, and NTP servers. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_arrays_patch_with_http_info(array, async_req=True) >>> result = thread.get()

Parameters

• array (Arrays) – (required)

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

• 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

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

api232_arrays_performance_by_link_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, end_time: Optional[int] = None, resolution: Optional[int] = None, start_time: Optional[int] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ArrayPerformanceByLinkGetResponse

List array front-end IO performance data by link

Displays real-time and historical front-end performance data at the array level including latency, bandwidth, IOPS, average I/O size, and queue depth. Group output is shown by link. A link represents a set of arrays that an I/O operation depends on. For local-only I/Os, this is a local array. For mirrored I/Os, this is a set of synchronous replication peer arrays. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_arrays_performance_by_link_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, /login, and /logout)

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

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_arrays_performance_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, end_time: Optional[int] = None, resolution: Optional[int] = None, start_time: Optional[int] = None, protocol: Optional[str] = None, protocol_group: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ArrayPerformanceGetResponse

List array front-end performance data

Displays real-time and historical front-end performance data at the array level including latency, bandwidth, IOPS, average I/O size, and queue depth. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_arrays_performance_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, /login, and /logout)

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

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• protocol (str) – Protocol type. Valid values are nfs, smb, and all.

• protocol_group (str) – Protocol group type. Valid values are block, file, and all.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_arrays_space_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, end_time: Optional[int] = None, resolution: Optional[int] = None, start_time: Optional[int] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ArraySpaceGetResponse

List array space information

Displays real-time and historical array space information including unique volume and snapshot space, shared space, data reduction, provisioned capacity, usable capacity, and parity. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_arrays_space_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, /login, and /logout)

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

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

pypureclient.flasharray.FA_2_32.api.audits_api module

FlashArray REST API

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

OpenAPI spec version: 2.32

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

class pypureclient.flasharray.FA_2_32.api.audits_api.AuditsApi(api_client)

Bases: object

api232_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, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → AuditGetResponse

List audits

Displays a list of audits. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

pypureclient.flasharray.FA_2_32.api.authorization_api module

FlashArray REST API

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

OpenAPI spec version: 2.32

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

class pypureclient.flasharray.FA_2_32.api.authorization_api.AuthorizationApi(api_client)

Bases: object

api232_login_post_with_http_info(x_request_id: Optional[str] = None, api_token: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → UsernameResponse

POST login (placeholder)

Exchange an API token for a session token. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_login_post_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• api_token (str) – API token for a user.

• 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

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

api232_logout_post_with_http_info(x_request_id: Optional[str] = None, x_auth_token: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

POST logout (placeholder)

Invalidate a session token. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_logout_post_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• x_auth_token (str) – Session token for a user.

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

api_api_version_get_with_http_info(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) → ApiVersionResponse

List available API versions

Returns a list of available API versions. No authentication is required to access this endpoint. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api_api_version_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• 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

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

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.flasharray.FA_2_32.api.certificates_api module

FlashArray REST API

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

OpenAPI spec version: 2.32

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

class pypureclient.flasharray.FA_2_32.api.certificates_api.CertificatesApi(api_client)

Bases: object

api232_certificates_certificate_signing_requests_post_with_http_info(certificate: Optional[CertificateSigningRequestPost] = None, authorization: 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) → CertificateSigningRequestResponse

Create certificate signing request

Creates a certificate signing request based on the certificate type and parameters. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_certificates_certificate_signing_requests_post_with_http_info(certificate, async_req=True) >>> result = thread.get()

Parameters

• certificate (CertificateSigningRequestPost) – (required)

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

• 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

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

api232_certificates_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, 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 certificate

Deletes a specific certificate object. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_certificates_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, /login, and /logout)

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

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

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

api232_certificates_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, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → CertificateGetResponse

List certificate attributes

Displays certificate attributes. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_certificates_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_certificates_patch_with_http_info(certificate: Optional[CertificatePost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, generate_new_key: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → CertificateResponse

Modify certificates

Modifies certificate attributes. When you modify the attributes of a self-signed certificate, Purity//FA replaces the existing certificate with a new certificate, which is generated with the specified attributes. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_certificates_patch_with_http_info(certificate, async_req=True) >>> result = thread.get()

Parameters

• certificate (CertificatePost) – (required)

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

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

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• generate_new_key (bool) – If set to true, a new private key is generated when generating a new certificate with the specified attributes. This may not be set to true when importing a certificate and private key, and may not be set to false when generating a new self-signed certificate to replace a certificate that was imported. Default setting is false.

• 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

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

api232_certificates_post_with_http_info(certificate: Optional[CertificatePost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → CertificateResponse

Create certificate

Creates a certificate object and specifies the valid time period and organization details of the certificate. A certificate can be imported or manually configured. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_certificates_post_with_http_info(certificate, async_req=True) >>> result = thread.get()

Parameters

• certificate (CertificatePost) – (required)

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

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

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• 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

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

pypureclient.flasharray.FA_2_32.api.connections_api module

FlashArray REST API

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

OpenAPI spec version: 2.32

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

class pypureclient.flasharray.FA_2_32.api.connections_api.ConnectionsApi(api_client)

Bases: object

api232_connections_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, host_group_names: Optional[List[str]] = None, host_names: Optional[List[str]] = None, volume_names: Optional[List[str]] = None, volume_ids: 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 a connection between a volume and its host or host group

Deletes the connection between a volume and its associated host or host group. One of volume_names or volume_ids and one of host_names or host_group_names query parameters are required. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_connections_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, /login, and /logout)

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

• host_group_names (list[str]) – Performs the operation on the host group specified. Enter multiple names in comma-separated format. A request cannot include a mix of multiple objects with multiple names. For example, a request cannot include a mix of multiple host group names and volume names; instead, at least one of the objects (e.g., host_group_names) must be set to only one name (e.g., hgroup01).

• host_names (list[str]) – Performs the operation on the hosts specified. Enter multiple names in comma-separated format. For example, host01,host02. A request cannot include a mix of multiple objects with multiple names. For example, a request cannot include a mix of multiple host names and volume names; instead, at least one of the objects (e.g., host_names) must be set to only one name (e.g., host01).

• volume_names (list[str]) – Performs the operation on the volume specified. Enter multiple names in comma-separated format. For example, vol01,vol02. A request cannot include a mix of multiple objects with multiple names. For example, a request cannot include a mix of multiple volume names and host names; instead, at least one of the objects (e.g., volume_names) must be set to only one name (e.g., vol01).

• volume_ids (list[str]) – Performs the operation on the specified volume. Enter multiple ids in comma-separated format. For example, vol01id,vol02id. A request cannot include a mix of multiple objects with multiple IDs. For example, a request cannot include a mix of multiple volume IDs and host names; instead, at least one of the objects (e.g., volume_ids) must be set to only one name (e.g., vol01id). Only one of the two between volume_names and volume_ids may be used at a time.

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

api232_connections_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, host_group_names: Optional[List[str]] = None, host_names: Optional[List[str]] = None, limit: Optional[int] = None, offset: Optional[int] = None, protocol_endpoint_ids: Optional[List[str]] = None, protocol_endpoint_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, volume_names: Optional[List[str]] = None, volume_ids: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ConnectionGetResponse

List volume connections

Displays a list of connections between a volume and its hosts and host groups, as well as the logical unit numbers (LUNs) or NVMe Namespace IDs (NSIDs) used by the associated hosts to address these volumes. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_connections_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• host_group_names (list[str]) – Performs the operation on the host group specified. Enter multiple names in comma-separated format. A request cannot include a mix of multiple objects with multiple names. For example, a request cannot include a mix of multiple host group names and volume names; instead, at least one of the objects (e.g., host_group_names) must be set to only one name (e.g., hgroup01).

• host_names (list[str]) – Performs the operation on the hosts specified. Enter multiple names in comma-separated format. For example, host01,host02. A request cannot include a mix of multiple objects with multiple names. For example, a request cannot include a mix of multiple host names and volume names; instead, at least one of the objects (e.g., host_names) must be set to only one name (e.g., host01).

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• protocol_endpoint_ids (list[str]) – Performs the operation on the protocol endpoints specified. Enter multiple IDs in comma-separated format. For example, peid01,peid02. A request cannot include a mix of multiple objects with multiple IDs. For example, a request cannot include a mix of multiple protocol endpoint IDs and host names. Instead, at least one of the objects (e.g., protocol_endpoint_ids) must be set to one ID (e.g., peid01).

• protocol_endpoint_names (list[str]) – Performs the operation on the protocol endpoints specified. Enter multiple names in comma-separated format. For example, pe01,pe02. A request cannot include a mix of multiple objects with multiple names. For example, a request cannot include a mix of multiple protocol endpoint names and host names; instead, at least one of the objects (e.g., protocol_endpoint_names) must be set to one name (e.g., pe01).

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• volume_names (list[str]) – Performs the operation on the volume specified. Enter multiple names in comma-separated format. For example, vol01,vol02. A request cannot include a mix of multiple objects with multiple names. For example, a request cannot include a mix of multiple volume names and host names; instead, at least one of the objects (e.g., volume_names) must be set to only one name (e.g., vol01).

• volume_ids (list[str]) – Performs the operation on the specified volume. Enter multiple ids in comma-separated format. For example, vol01id,vol02id. A request cannot include a mix of multiple objects with multiple IDs. For example, a request cannot include a mix of multiple volume IDs and host names; instead, at least one of the objects (e.g., volume_ids) must be set to only one name (e.g., vol01id). Only one of the two between volume_names and volume_ids may be used at a time.

• 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

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

api232_connections_post_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, host_group_names: Optional[List[str]] = None, host_names: Optional[List[str]] = None, volume_names: Optional[List[str]] = None, volume_ids: Optional[List[str]] = None, connection: Optional[ConnectionPost] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ConnectionResponse

Create a connection between a volume and host or host group

Creates a connection between a volume and a host or host group. One of volume_names or volume_ids and one of host_names or host_group_names query parameters are required. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_connections_post_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, /login, and /logout)

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

• host_group_names (list[str]) – Performs the operation on the host group specified. Enter multiple names in comma-separated format. A request cannot include a mix of multiple objects with multiple names. For example, a request cannot include a mix of multiple host group names and volume names; instead, at least one of the objects (e.g., host_group_names) must be set to only one name (e.g., hgroup01).

• host_names (list[str]) – Performs the operation on the hosts specified. Enter multiple names in comma-separated format. For example, host01,host02. A request cannot include a mix of multiple objects with multiple names. For example, a request cannot include a mix of multiple host names and volume names; instead, at least one of the objects (e.g., host_names) must be set to only one name (e.g., host01).

• volume_names (list[str]) – Performs the operation on the volume specified. Enter multiple names in comma-separated format. For example, vol01,vol02. A request cannot include a mix of multiple objects with multiple names. For example, a request cannot include a mix of multiple volume names and host names; instead, at least one of the objects (e.g., volume_names) must be set to only one name (e.g., vol01).

• volume_ids (list[str]) – Performs the operation on the specified volume. Enter multiple ids in comma-separated format. For example, vol01id,vol02id. A request cannot include a mix of multiple objects with multiple IDs. For example, a request cannot include a mix of multiple volume IDs and host names; instead, at least one of the objects (e.g., volume_ids) must be set to only one name (e.g., vol01id). Only one of the two between volume_names and volume_ids may be used at a time.

• connection (ConnectionPost) –

• 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

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

pypureclient.flasharray.FA_2_32.api.container_default_protections_api module

FlashArray REST API

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

OpenAPI spec version: 2.32

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

class pypureclient.flasharray.FA_2_32.api.container_default_protections_api.ContainerDefaultProtectionsApi(api_client)

Bases: object

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

List container default protections

Displays a list of containers with its default protections. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_container_default_protections_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, /login, and /logout)

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

• ids (list[str]) – Performs the operation on the container ID specified. Enter multiple source IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together. Specifying ids or names with no value will perform the operation on local array.

• names (list[str]) – Performs the operation on the unique container name specified. Enter multiple names in comma-separated format. The ids or names parameter is required, but they cannot be set together. Specifying ids or names with no value will perform the operation on local array.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_container_default_protections_patch_with_http_info(container_default_protection: Optional[ContainerDefaultProtection] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ContainerDefaultProtectionResponse

Modify a container’s default protections

Modifies a container’s default protections. To modify, set default_protections to the new list. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_container_default_protections_patch_with_http_info(container_default_protection, async_req=True) >>> result = thread.get()

Parameters

• container_default_protection (ContainerDefaultProtection) – (required)

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

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

• ids (list[str]) – Performs the operation on the container ID specified. Enter multiple source IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together. Specifying ids or names with no value will perform the operation on local array.

• names (list[str]) – Performs the operation on the unique container name specified. Enter multiple names in comma-separated format. The ids or names parameter is required, but they cannot be set together. Specifying ids or names with no value will perform the operation on local array.

• 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

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

pypureclient.flasharray.FA_2_32.api.controllers_api module

FlashArray REST API

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

OpenAPI spec version: 2.32

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

class pypureclient.flasharray.FA_2_32.api.controllers_api.ControllersApi(api_client)

Bases: object

api232_controllers_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, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ControllerGetResponse

List controller information and status

Displays the name, mode, FlashArray model, Purity//FA software version, and status of each controller in the array. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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.flasharray.FA_2_32.api.directories_api module

FlashArray REST API

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

OpenAPI spec version: 2.32

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

class pypureclient.flasharray.FA_2_32.api.directories_api.DirectoriesApi(api_client)

Bases: object

api232_directories_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, 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 managed directories

Deletes one or more managed directories. To be deleted, a managed directory must be empty and not attached to any enabled export policies. Deleted managed directories cannot be recovered. The ids or names parameter is required, but cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_directories_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, /login, and /logout)

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

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

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

api232_directories_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = 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, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → DirectoryGetResponse

List directories

Displays a list of directories, including those pending eradication. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• 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 or file_system_names parameter is required, but they cannot be set together.

• 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, filesystem01,filesystem02.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

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

api232_directories_locks_nlm_reclamations_post_with_http_info(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) → DirectoryLockNlmReclamationResponse

Initiate NLM reclamation.

NLM reclamation is a system-wide operation, affecting all clients, and so only one may be in progress at a time. Attempting to initiate reclamation while one is in progress will result in an error. When NLM reclamation is initiated, all NLM locks are deleted and client applications are notified that they can reacquire their locks within a grace period. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_directories_locks_nlm_reclamations_post_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• 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

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

api232_directories_patch_with_http_info(directory: Optional[DirectoryPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → DirectoryResponse

Modify a managed directory

Modifies a managed directory. To rename a managed directory, set name to the new name. The ids or names parameter is required, but cannot be set together. The name or directory_name parameter is required. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_directories_patch_with_http_info(directory, async_req=True) >>> result = thread.get()

Parameters

• directory (DirectoryPatch) – (required)

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

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

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• 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

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

api232_directories_performance_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, end_time: Optional[int] = None, resolution: Optional[int] = None, start_time: Optional[int] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, protocol: Optional[str] = None, protocol_group: Optional[str] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → DirectoryPerformanceGetResponse

List directory performance data

Displays real-time and historical performance data, real-time latency data, and average I/O sizes for each directory and as a total of all directories across the entire array. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_directories_performance_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, /login, and /logout)

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

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• protocol (str) – Protocol type. Valid values are nfs, smb, and all.

• protocol_group (str) – Protocol group type. Valid values are block, file, and all.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• 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

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

api232_directories_policies_autodir_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = 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, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Delete a membership between a directory and one or more auto managed directory policies

Deletes a membership between a directory with one or more auto managed directory policies. The policy_ids or policy_names parameter is required, but they cannot be set together. The member_ids or member_names parameter is required, but they cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_directories_policies_autodir_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, /login, and /logout)

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

• member_ids (list[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• policy_ids (list[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (list[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

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

api232_directories_policies_autodir_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = 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, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberGetResponse

List auto managed directory policies attached to a directory

Displays a list of auto managed directory policies that are attached to directories. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_directories_policies_autodir_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (list[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• policy_ids (list[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (list[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_directories_policies_autodir_post_with_http_info(policies: Optional[DirectoryPolicyPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberResponse

Create a membership between a directory with one or more auto managed directory policies

Creates a membership between a directory with one or more auto managed directory policies. The member_ids or member_names parameter is required, but they cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_directories_policies_autodir_post_with_http_info(policies, async_req=True) >>> result = thread.get()

Parameters

• policies (DirectoryPolicyPost) – (required)

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

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

• member_ids (list[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• 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

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

api232_directories_policies_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = 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, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberGetResponse

List policies

Displays a list of policies that are attached to directories. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_directories_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (list[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• policy_ids (list[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (list[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_directories_policies_nfs_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = 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, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Delete a membership between a directory and one or more NFS policies

Deletes a membership between a directory and one or more NFS policies. The policy_ids or policy_names parameter is required, but cannot be set together. The member_ids or member_names parameter is required, but cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_directories_policies_nfs_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, /login, and /logout)

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

• member_ids (list[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• policy_ids (list[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (list[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

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

api232_directories_policies_nfs_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = 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, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberExportGetResponse

List NFS policies attached to a directory

Displays a list of NFS policies that are attached to directories. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_directories_policies_nfs_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (list[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• policy_ids (list[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (list[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_directories_policies_nfs_post_with_http_info(policies: Optional[DirectoryPolicyExportPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberExportResponse

Create a membership between a directory and one or more NFS policies

Creates a membership between a directory and one or more NFS policies. The member_ids or member_names parameter is required but cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_directories_policies_nfs_post_with_http_info(policies, async_req=True) >>> result = thread.get()

Parameters

• policies (DirectoryPolicyExportPost) – (required)

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

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

• member_ids (list[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• 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

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

api232_directories_policies_quota_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = 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, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Delete a membership between a directory and one or more quota policies

Deletes a membership between a directory and one or more quota policies. The policy_ids or policy_names parameter is required, but cannot be set together. The member_ids or member_names parameter is required, but cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_directories_policies_quota_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, /login, and /logout)

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

• member_ids (list[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• policy_ids (list[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (list[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

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

api232_directories_policies_quota_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = 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, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberGetResponse

List quota policies attached to a directory

Displays a list of quota policies that are attached to directories. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_directories_policies_quota_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (list[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• policy_ids (list[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (list[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_directories_policies_quota_post_with_http_info(policies: Optional[DirectoryPolicyPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, ignore_usage: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberResponse

Create a membership between a directory and one or more quota policies

Creates a membership between a directory and one or more quota policies. The member_ids or member_names parameter is required, but cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_directories_policies_quota_post_with_http_info(policies, async_req=True) >>> result = thread.get()

Parameters

• policies (DirectoryPolicyPost) – (required)

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

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

• member_ids (list[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• ignore_usage (bool) – Flag used to override checks for quota management operations. If set to true, directory usage is not checked against the quota_limits that are set. If set to false, the actual logical bytes in use are prevented from exceeding the limits set on the directory. Client operations might be impacted. If the limit exceeds the quota, the client operation is not allowed. If not specified, defaults to false.

• 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

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

api232_directories_policies_smb_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = 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, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Delete a membership between a directory and one or more SMB policies

Deletes a membership between a directory and one or more SMB policies. The policy_ids or policy_names parameter is required, but cannot be set together. The member_ids or member_names parameter is required, but cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_directories_policies_smb_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, /login, and /logout)

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

• member_ids (list[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• policy_ids (list[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (list[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

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

api232_directories_policies_smb_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = 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, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberExportGetResponse

List SMB policies attached to a directory

Displays a list of SMB policies that are attached to directories. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_directories_policies_smb_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (list[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• policy_ids (list[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (list[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_directories_policies_smb_post_with_http_info(policies: Optional[DirectoryPolicyExportPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberExportResponse

Create a membership between a directory and one or more SMB policies

Creates a membership between a directory and one or more SMB policies. The member_ids or member_names parameter is required, but cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_directories_policies_smb_post_with_http_info(policies, async_req=True) >>> result = thread.get()

Parameters

• policies (DirectoryPolicyExportPost) – (required)

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

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

• member_ids (list[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• 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

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

api232_directories_policies_snapshot_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = 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, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Delete a membership between a directory and one or more snapshot policies

Deletes a membership between a directory and one or more snapshot policies. The policy_ids or policy_names parameter is required, but cannot be set together. The member_ids or member_names parameter is required, but cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_directories_policies_snapshot_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, /login, and /logout)

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

• member_ids (list[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• policy_ids (list[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (list[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

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

api232_directories_policies_snapshot_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = 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, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberGetResponse

List snapshot policies attached to a directory

Displays a list of snapshot policies that are attached to directories. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_directories_policies_snapshot_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (list[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• policy_ids (list[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (list[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_directories_policies_snapshot_post_with_http_info(policies: Optional[DirectoryPolicyPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberResponse

Create a membership between a directory with one or more snapshot policies

Creates a membership between a directory with one or more snapshot policies. The member_ids or member_names parameter is required, but cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_directories_policies_snapshot_post_with_http_info(policies, async_req=True) >>> result = thread.get()

Parameters

• policies (DirectoryPolicyPost) – (required)

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

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

• member_ids (list[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• 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

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

api232_directories_post_with_http_info(directory: Optional[DirectoryPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, file_system_names: Optional[List[str]] = None, file_system_ids: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → DirectoryResponse

Create directory

Creates a managed directory at the specified path. The managed directory name must consist of a file system name prefix and a managed directory name suffix (separated with ‘&#58;’). The suffix must be between 1 and 63 characters (alphanumeric and ‘-’) in length and begin and end with a letter or number. The suffix must include at least one letter or ‘-’. Set names to create a managed directory with the specified full managed directory name, or set file_system_names or file_system_ids in the query parameters and suffix in the body parameters to create a managed directory in the specified file system with the specified suffix. These two options are exclusive. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_directories_post_with_http_info(directory, async_req=True) >>> result = thread.get()

Parameters

• directory (DirectoryPost) – (required)

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

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

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• 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, filesystem01,filesystem02.

• 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 or file_system_names parameter is required, but they cannot be set together.

• 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

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

api232_directories_space_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, end_time: Optional[int] = None, resolution: Optional[int] = None, start_time: Optional[int] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ResourceDirectorySpaceGetResponse

List directory space information

Displays physical storage consumption data for each directory. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_directories_space_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, /login, and /logout)

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

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• 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

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

pypureclient.flasharray.FA_2_32.api.directory_exports_api module

FlashArray REST API

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

OpenAPI spec version: 2.32

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

class pypureclient.flasharray.FA_2_32.api.directory_exports_api.DirectoryExportsApi(api_client)

Bases: object

api232_directory_exports_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, directory_ids: Optional[List[str]] = None, directory_names: Optional[List[str]] = None, export_names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_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 directory exports

Deletes one or more directory exports. If any of the export_names is not unique across the system, policy_ids or policy_names must be specified to determine the exports. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_directory_exports_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, /login, and /logout)

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

• directory_ids (list[str]) – Performs the operation on the unique managed directory IDs specified. Enter multiple managed directory IDs in comma-separated format. The directory_ids or directory_names parameter is required, but they cannot be set together.

• directory_names (list[str]) – Performs the operation on the managed directory names specified. Enter multiple full managed directory names in comma-separated format. For example, fs:dir01,fs:dir02.

• export_names (list[str]) – Performs the operation on the export names specified. Enter multiple names in comma-separated format. For example, name01,name02.

• policy_ids (list[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (list[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

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

api232_directory_exports_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, directory_ids: Optional[List[str]] = None, directory_names: Optional[List[str]] = None, export_names: Optional[List[str]] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → DirectoryExportGetResponse

List directory exports

Displays a list of directory exports. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_directory_exports_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• directory_ids (list[str]) – Performs the operation on the unique managed directory IDs specified. Enter multiple managed directory IDs in comma-separated format. The directory_ids or directory_names parameter is required, but they cannot be set together.

• directory_names (list[str]) – Performs the operation on the managed directory names specified. Enter multiple full managed directory names in comma-separated format. For example, fs:dir01,fs:dir02.

• export_names (list[str]) – Performs the operation on the export names specified. Enter multiple names in comma-separated format. For example, name01,name02.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (list[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (list[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_directory_exports_patch_with_http_info(export: Optional[DirectoryExportPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, directory_ids: Optional[List[str]] = None, directory_names: Optional[List[str]] = None, export_names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → DirectoryExportResponse

Modify directory exports

Modifies a directory export. Used for manually renaming, enabling, and disabling directory exports. To rename a directory export, set ‘export_name’ to the new name. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_directory_exports_patch_with_http_info(export, async_req=True) >>> result = thread.get()

Parameters

• export (DirectoryExportPatch) – (required)

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

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

• directory_ids (list[str]) – Performs the operation on the unique managed directory IDs specified. Enter multiple managed directory IDs in comma-separated format. The directory_ids or directory_names parameter is required, but they cannot be set together.

• directory_names (list[str]) – Performs the operation on the managed directory names specified. Enter multiple full managed directory names in comma-separated format. For example, fs:dir01,fs:dir02.

• export_names (list[str]) – Performs the operation on the export names specified. Enter multiple names in comma-separated format. For example, name01,name02.

• policy_ids (list[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (list[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• 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

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

api232_directory_exports_post_with_http_info(exports: Optional[DirectoryExportPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, directory_ids: Optional[List[str]] = None, directory_names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → DirectoryExportResponse

Create directory exports

Creates an export of a managed directory. The directory_ids or directory_names parameter is required, but cannot be set together. The policy_ids or policy_names parameter is required, but cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_directory_exports_post_with_http_info(exports, async_req=True) >>> result = thread.get()

Parameters

• exports (DirectoryExportPost) – (required)

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

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

• directory_ids (list[str]) – Performs the operation on the unique managed directory IDs specified. Enter multiple managed directory IDs in comma-separated format. The directory_ids or directory_names parameter is required, but they cannot be set together.

• directory_names (list[str]) – Performs the operation on the managed directory names specified. Enter multiple full managed directory names in comma-separated format. For example, fs:dir01,fs:dir02.

• policy_ids (list[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (list[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• 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

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

pypureclient.flasharray.FA_2_32.api.directory_quotas_api module

FlashArray REST API

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

OpenAPI spec version: 2.32

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

class pypureclient.flasharray.FA_2_32.api.directory_quotas_api.DirectoryQuotasApi(api_client)

Bases: object

api232_directory_quotas_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, directory_ids: Optional[List[str]] = None, directory_names: Optional[List[str]] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → DirectoryQuotasGetResponse

List directories with attached quota policies

Displays a list of directories and the quota policies attached to them. Directories with multiple policies are listed repeatedly (once per policy). The directories without a policy attached are not listed. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_directory_quotas_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• directory_ids (list[str]) – Performs the operation on the unique managed directory IDs specified. Enter multiple managed directory IDs in comma-separated format. The directory_ids or directory_names parameter is required, but they cannot be set together.

• directory_names (list[str]) – Performs the operation on the managed directory names specified. Enter multiple full managed directory names in comma-separated format. For example, fs:dir01,fs:dir02.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (list[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (list[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

pypureclient.flasharray.FA_2_32.api.directory_services_api module

FlashArray REST API

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

OpenAPI spec version: 2.32

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

class pypureclient.flasharray.FA_2_32.api.directory_services_api.DirectoryServicesApi(api_client)

Bases: object

api232_directory_services_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, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → DirectoryServiceGetResponse

List directory services configuration

Displays the directory services configuration settings for manageability. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_directory_services_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_directory_services_local_groups_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, sids: Optional[List[str]] = None, gids: Optional[List[int]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Delete local groups

Deletes one or more local groups. The gids, names, or sids parameter is required, but cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_directory_services_local_groups_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, /login, and /logout)

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

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• sids (list[str]) – Performs the operation on the object SID specified. Enter multiple SIDs in comma-separated format. For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

• gids (list[int]) – Performs the operation on the specified GIDs. Enter multiple GIDs in comma-separated format. For example, 4234235,9681923.

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

api232_directory_services_local_groups_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, ids: Optional[List[str]] = None, gids: Optional[List[int]] = None, sids: Optional[List[str]] = None, names: Optional[List[str]] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → LocalGroupGetResponse

List local groups

Displays a list of local groups. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_directory_services_local_groups_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• gids (list[int]) – Performs the operation on the specified GIDs. Enter multiple GIDs in comma-separated format. For example, 4234235,9681923.

• sids (list[str]) – Performs the operation on the object SID specified. Enter multiple SIDs in comma-separated format. For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_directory_services_local_groups_members_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, group_names: Optional[List[str]] = None, group_sids: Optional[List[str]] = None, group_gids: Optional[List[int]] = None, member_names: Optional[List[str]] = None, member_sids: Optional[List[str]] = None, member_ids: Optional[List[int]] = None, member_types: 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 local group membership

Deletes one or more local group memberships. The group_names, group_sids, or group_ids parameter is required, but cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_directory_services_local_groups_members_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, /login, and /logout)

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

• group_names (list[str]) – Performs the operation on the group names specified. Enter multiple group names in comma-separated format. For example, group1,group2.

• group_sids (list[str]) – Performs the operation on the specified group SID. Enter multiple group SIDs in comma-separated format. For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

• group_gids (list[int]) – Performs the operation on the specified GIDs. Enter multiple GIDs in comma-separated format. For example, 4234235,9681923.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_sids (list[str]) – Performs the operation on the specified member SID. Enter multiple member SIDs in comma-separated format. For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

• member_ids (list[int]) – Performs the operation on the unique local member IDs specified. Enter multiple member IDs in comma-separated format. For local group IDs refer to group IDs (GID). For local user IDs refer to user IDs (UID). The member_ids and member_names parameters cannot be provided together.

• member_types (list[str]) – Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include directories. Enter multiple member types in comma-separated format. For example, type01,type02.

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

api232_directory_services_local_groups_members_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, group_names: Optional[List[str]] = None, group_sids: Optional[List[str]] = None, group_gids: Optional[List[int]] = None, member_names: Optional[List[str]] = None, member_sids: Optional[List[str]] = None, member_ids: Optional[List[int]] = None, member_types: Optional[List[str]] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → LocalMembershipGetResponse

List local group memberships

Displays a list of local group memberships. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_directory_services_local_groups_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• group_names (list[str]) – Performs the operation on the group names specified. Enter multiple group names in comma-separated format. For example, group1,group2.

• group_sids (list[str]) – Performs the operation on the specified group SID. Enter multiple group SIDs in comma-separated format. For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

• group_gids (list[int]) – Performs the operation on the specified GIDs. Enter multiple GIDs in comma-separated format. For example, 4234235,9681923.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_sids (list[str]) – Performs the operation on the specified member SID. Enter multiple member SIDs in comma-separated format. For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

• member_ids (list[int]) – Performs the operation on the unique local member IDs specified. Enter multiple member IDs in comma-separated format. For local group IDs refer to group IDs (GID). For local user IDs refer to user IDs (UID). The member_ids and member_names parameters cannot be provided together.

• member_types (list[str]) – Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include directories. Enter multiple member types in comma-separated format. For example, type01,type02.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_directory_services_local_groups_members_post_with_http_info(local_membership: Optional[LocalGroupMembershipPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, group_names: Optional[List[str]] = None, group_sids: Optional[List[str]] = None, group_gids: Optional[List[int]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → LocalMembershipResponse

Create local group membership

Creates a local group membership with a group. The group_names, group_sids, or group_ids parameter is required, but cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_directory_services_local_groups_members_post_with_http_info(local_membership, async_req=True) >>> result = thread.get()

Parameters

• local_membership (LocalGroupMembershipPost) – The member_names, member_sids, or member_gids parameter is required, but cannot be set together. (required)

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

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

• group_names (list[str]) – Performs the operation on the group names specified. Enter multiple group names in comma-separated format. For example, group1,group2.

• group_sids (list[str]) – Performs the operation on the specified group SID. Enter multiple group SIDs in comma-separated format. For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

• group_gids (list[int]) – Performs the operation on the specified GIDs. Enter multiple GIDs in comma-separated format. For example, 4234235,9681923.

• 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

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

api232_directory_services_local_groups_patch_with_http_info(local_group: Optional[LocalGroup] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, sids: Optional[List[str]] = None, gids: Optional[List[int]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → LocalGroupResponse

Modify local groups

Modifies local groups. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_directory_services_local_groups_patch_with_http_info(local_group, async_req=True) >>> result = thread.get()

Parameters

• local_group (LocalGroup) – (required)

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

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

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• sids (list[str]) – Performs the operation on the object SID specified. Enter multiple SIDs in comma-separated format. For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

• gids (list[int]) – Performs the operation on the specified GIDs. Enter multiple GIDs in comma-separated format. For example, 4234235,9681923.

• 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

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

api232_directory_services_local_groups_post_with_http_info(names: Optional[List[str]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, local_group: Optional[LocalGroupPost] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → LocalGroupResponse

Create local group

Creates a local group. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_directory_services_local_groups_post_with_http_info(names, async_req=True) >>> result = thread.get()

Parameters

• names (list[str]) – Performs the operation on the unique name specified. For example, name01. Enter multiple names in comma-separated format. (required)

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

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

• local_group (LocalGroupPost) –

• 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

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

api232_directory_services_local_users_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, sids: Optional[List[str]] = None, uids: Optional[List[int]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Delete local users

Deletes one or more local users. The uids, names, or sids parameter is required, but cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_directory_services_local_users_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, /login, and /logout)

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

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• sids (list[str]) – Performs the operation on the object SID specified. Enter multiple SIDs in comma-separated format. For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

• uids (list[int]) – A comma-separated list of local user IDs (UIDs). Enter multiple local user IDs in comma-separated format. For example, 423,51234.

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

api232_directory_services_local_users_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, ids: Optional[List[str]] = None, uids: Optional[List[int]] = None, sids: Optional[List[str]] = None, names: Optional[List[str]] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → LocalUserGetResponse

List local users

Displays a list of local users. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_directory_services_local_users_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• uids (list[int]) – A comma-separated list of local user IDs (UIDs). Enter multiple local user IDs in comma-separated format. For example, 423,51234.

• sids (list[str]) – Performs the operation on the object SID specified. Enter multiple SIDs in comma-separated format. For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_directory_services_local_users_members_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, group_names: Optional[List[str]] = None, group_sids: Optional[List[str]] = None, group_gids: Optional[List[int]] = None, member_names: Optional[List[str]] = None, member_sids: Optional[List[str]] = None, member_ids: Optional[List[int]] = None, member_types: 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 local user membership

Deletes one or more local user memberships. The member_names, member_sids, or member_ids parameter is required, but cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_directory_services_local_users_members_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, /login, and /logout)

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

• group_names (list[str]) – Performs the operation on the group names specified. Enter multiple group names in comma-separated format. For example, group1,group2.

• group_sids (list[str]) – Performs the operation on the specified group SID. Enter multiple group SIDs in comma-separated format. For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

• group_gids (list[int]) – Performs the operation on the specified GIDs. Enter multiple GIDs in comma-separated format. For example, 4234235,9681923.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_sids (list[str]) – Performs the operation on the specified member SID. Enter multiple member SIDs in comma-separated format. For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

• member_ids (list[int]) – Performs the operation on the unique local member IDs specified. Enter multiple member IDs in comma-separated format. For local group IDs refer to group IDs (GID). For local user IDs refer to user IDs (UID). The member_ids and member_names parameters cannot be provided together.

• member_types (list[str]) – Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include directories. Enter multiple member types in comma-separated format. For example, type01,type02.

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

api232_directory_services_local_users_members_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, group_names: Optional[List[str]] = None, group_sids: Optional[List[str]] = None, group_gids: Optional[List[int]] = None, member_names: Optional[List[str]] = None, member_sids: Optional[List[str]] = None, member_ids: Optional[List[int]] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → LocalMembershipGetResponse

List local user memberships

Displays a list of local user memberships. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_directory_services_local_users_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• group_names (list[str]) – Performs the operation on the group names specified. Enter multiple group names in comma-separated format. For example, group1,group2.

• group_sids (list[str]) – Performs the operation on the specified group SID. Enter multiple group SIDs in comma-separated format. For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

• group_gids (list[int]) – Performs the operation on the specified GIDs. Enter multiple GIDs in comma-separated format. For example, 4234235,9681923.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_sids (list[str]) – Performs the operation on the specified member SID. Enter multiple member SIDs in comma-separated format. For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

• member_ids (list[int]) – Performs the operation on the unique local member IDs specified. Enter multiple member IDs in comma-separated format. For local group IDs refer to group IDs (GID). For local user IDs refer to user IDs (UID). The member_ids and member_names parameters cannot be provided together.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_directory_services_local_users_members_post_with_http_info(local_membership: Optional[LocalUserMembershipPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, member_names: Optional[List[str]] = None, member_sids: Optional[List[str]] = None, member_ids: Optional[List[int]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → LocalMembershipResponse

Create local user membership

Creates a local user membership with a group. The member_names or member_sids or member_ids parameter is required, but cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_directory_services_local_users_members_post_with_http_info(local_membership, async_req=True) >>> result = thread.get()

Parameters

• local_membership (LocalUserMembershipPost) – The group_names, group_sids, or group_gids parameter is required, but cannot be set together. (required)

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

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

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_sids (list[str]) – Performs the operation on the specified member SID. Enter multiple member SIDs in comma-separated format. For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

• member_ids (list[int]) – Performs the operation on the unique local member IDs specified. Enter multiple member IDs in comma-separated format. For local group IDs refer to group IDs (GID). For local user IDs refer to user IDs (UID). The member_ids and member_names parameters cannot be provided together.

• 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

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

api232_directory_services_local_users_patch_with_http_info(local_user: Optional[LocalUserPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, keep_open_sessions: Optional[bool] = None, sids: Optional[List[str]] = None, uids: Optional[List[int]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → LocalUserResponse

Modify local user

Modifies a local user. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_directory_services_local_users_patch_with_http_info(local_user, async_req=True) >>> result = thread.get()

Parameters

• local_user (LocalUserPatch) – (required)

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

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

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• keep_open_sessions (bool) – If set to true, the session does not expire. If set to false, when the user is disabled or password is changed, the session expires. If not specified, defaults to false.

• sids (list[str]) – Performs the operation on the object SID specified. Enter multiple SIDs in comma-separated format. For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

• uids (list[int]) – A comma-separated list of local user IDs (UIDs). Enter multiple local user IDs in comma-separated format. For example, 423,51234.

• 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

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

api232_directory_services_local_users_post_with_http_info(names: Optional[List[str]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, local_user: Optional[LocalUserPost] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → LocalUserResponse

Create local user

Creates a local user. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_directory_services_local_users_post_with_http_info(names, async_req=True) >>> result = thread.get()

Parameters

• names (list[str]) – Performs the operation on the unique name specified. For example, name01. Enter multiple names in comma-separated format. (required)

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

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

• local_user (LocalUserPost) –

• 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

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

api232_directory_services_patch_with_http_info(names: Optional[List[str]] = None, directory_service: Optional[DirectoryService] = None, authorization: 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) → DirectoryServiceResponse

Modify directory services configuration

Modifies the directory service configuration. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_directory_services_patch_with_http_info(names, directory_service, async_req=True) >>> result = thread.get()

Parameters

• names (list[str]) – Performs the operation on the unique name specified. For example, name01. Enter multiple names in comma-separated format. (required)

• directory_service (DirectoryService) – (required)

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

• 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

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

api232_directory_services_roles_delete_with_http_info(names: Optional[List[str]] = None, authorization: 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) → None

Delete a group to role mapping

Delete a group to role mapping This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_directory_services_roles_delete_with_http_info(names, async_req=True) >>> result = thread.get()

Parameters

• names (list[str]) – Performs the operation on the unique names specified. For example, GroupRoleMappingName. Enter multiple names in comma-separated format. (required)

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

• 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

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

api232_directory_services_roles_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, names: Optional[List[str]] = None, limit: Optional[int] = None, offset: Optional[int] = None, role_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → DirectoryServiceRoleGetResponse

List directory services roles

Displays the role-based access control (RBAC) group role settings. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_directory_services_roles_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• names (list[str]) – Performs the operation on the unique names specified. For example, GroupRoleMappingName. Enter multiple names in comma-separated format.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• role_names (list[str]) – Performs the operation on the unique roles specified. For example, array_admin. Enter multiple roles in comma-separated format.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_directory_services_roles_patch_with_http_info(names: Optional[List[str]] = None, directory_service_roles: Optional[DirectoryServiceRole] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, role_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → DirectoryServiceRoleResponse

Modify a group to role mapping

Modifies group to role mapping entries This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_directory_services_roles_patch_with_http_info(names, directory_service_roles, async_req=True) >>> result = thread.get()

Parameters

• names (list[str]) – Performs the operation on the unique names specified. For example, GroupRoleMappingName. Enter multiple names in comma-separated format. (required)

• directory_service_roles (DirectoryServiceRole) – (required)

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

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

• role_names (list[str]) – Performs the operation on the unique roles specified. For example, array_admin. Enter multiple roles in comma-separated format.

• 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

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

api232_directory_services_roles_post_with_http_info(names: Optional[List[str]] = None, directory_service_roles: Optional[DirectoryServiceRole] = None, authorization: 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) → DirectoryServiceRoleResponse

Add group to role mapping

Add group to role mapping This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_directory_services_roles_post_with_http_info(names, directory_service_roles, async_req=True) >>> result = thread.get()

Parameters

• names (list[str]) – Performs the operation on the unique names specified. For example, GroupRoleMappingName. Enter multiple names in comma-separated format. (required)

• directory_service_roles (DirectoryServiceRole) – (required)

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

• 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

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

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

List directory services test results

Displays the directory services test and displays the results. The test verifies that URIs can be resolved and that the array can bind and query the tree using the bind user credentials. The test also verifies that the array can find all configured groups to ensure the common names and group base are correctly configured. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_directory_services_test_get_with_http_info(names, async_req=True) >>> result = thread.get()

Parameters

• names (list[str]) – Performs the operation on the unique name specified. For example, name01. Enter multiple names in comma-separated format. (required)

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

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

pypureclient.flasharray.FA_2_32.api.directory_snapshots_api module

FlashArray REST API

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

OpenAPI spec version: 2.32

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

class pypureclient.flasharray.FA_2_32.api.directory_snapshots_api.DirectorySnapshotsApi(api_client)

Bases: object

api232_directory_snapshots_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, 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 directory snapshot

Deletes a directory snapshot that has been destroyed and is pending eradication. Eradicated directory snapshots cannot be recovered. Directory snapshots are destroyed by using the PATCH method. The ids or names parameter is required, but they cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_directory_snapshots_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, /login, and /logout)

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

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

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

api232_directory_snapshots_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = 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, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → DirectorySnapshotGetResponse

List directory snapshots

Displays a list of directory snapshots, including those pending eradication. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_directory_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• source_ids (list[str]) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

• source_names (list[str]) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• 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

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

api232_directory_snapshots_patch_with_http_info(directory_snapshot: Optional[DirectorySnapshotPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → DirectorySnapshotResponse

Modify directory snapshot

Modifies a directory snapshot. You can destroy, recover, or update the policy or time remaining of a directory snapshot. To destroy a directory snapshot, set destroyed=true. To recover a directory snapshot that has been destroyed and is pending eradication, set destroyed=false. To rename a directory snapshot, set name to the new name. The ids or names parameter is required, but they cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_directory_snapshots_patch_with_http_info(directory_snapshot, async_req=True) >>> result = thread.get()

Parameters

• directory_snapshot (DirectorySnapshotPatch) – (required)

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

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

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• 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

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

api232_directory_snapshots_post_with_http_info(directory_snapshot: Optional[DirectorySnapshotPost] = None, authorization: Optional[str] = None, x_request_id: Optional[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) → DirectorySnapshotResponse

Create directory snapshot

Creates a snapshot of the contents of a directory. The source_ids or source_names parameter is required, but they cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_directory_snapshots_post_with_http_info(directory_snapshot, async_req=True) >>> result = thread.get()

Parameters

• directory_snapshot (DirectorySnapshotPost) – (required)

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

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

• source_ids (list[str]) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

• source_names (list[str]) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

• 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

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

pypureclient.flasharray.FA_2_32.api.dns_api module

FlashArray REST API

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

OpenAPI spec version: 2.32

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

class pypureclient.flasharray.FA_2_32.api.dns_api.DNSApi(api_client)

Bases: object

api232_dns_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, 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 DNS configuration

Deletes DNS configuration identified by configuration name. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_dns_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, /login, and /logout)

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

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

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

api232_dns_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, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → DnsGetResponse

List DNS parameters

Displays the current DNS configurations and their parameters including domain suffix, the list of DNS name server IP addresses, and the list of services that DNS parameters apply to. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_dns_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_dns_patch_with_http_info(dns: Optional[DnsPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → DnsResponse

Modify DNS parameters

Modifies the DNS parameters of an array, including the domain suffix, the list of DNS name server IP addresses, and the list of services that DNS parameters apply to. If there is no DNS configuration beforehand new DNS configuration with ‘default’ name is created. If more than one DNS configuration exists name has to be specified to identify the DNS configuration to be modified. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_dns_patch_with_http_info(dns, async_req=True) >>> result = thread.get()

Parameters

• dns (DnsPatch) – (required)

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

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

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• 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

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

api232_dns_post_with_http_info(dns: Optional[DnsPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → DnsResponse

Create DNS configuration

Creates new DNS configuration with parameters including the domain suffix, the list of DNS name server IP addresses, and the list of services that DNS parameters apply to. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_dns_post_with_http_info(dns, async_req=True) >>> result = thread.get()

Parameters

• dns (DnsPost) – (required)

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

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

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• 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

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

pypureclient.flasharray.FA_2_32.api.drives_api module

FlashArray REST API

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

OpenAPI spec version: 2.32

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

class pypureclient.flasharray.FA_2_32.api.drives_api.DrivesApi(api_client)

Bases: object

api232_drives_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, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → DriveGetResponse

List flash, NVRAM, and cache modules

Displays a list of flash, NVRAM, and cache modules that are installed in the array along with their attributes and status. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

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

api232_drives_patch_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, admit: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → DriveResponse

Modify flash and NVRAM modules

Modifies flash and NVRAM modules that have been added or connected but not yet admitted to the array. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_drives_patch_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, /login, and /logout)

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

• admit (bool) – If true, admits any unadmitted drives into the system.

• 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

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

pypureclient.flasharray.FA_2_32.api.file_systems_api module

FlashArray REST API

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

OpenAPI spec version: 2.32

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

class pypureclient.flasharray.FA_2_32.api.file_systems_api.FileSystemsApi(api_client)

Bases: object

api232_file_systems_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, 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 file system

Deletes a file system that has been destroyed and is pending eradication. Eradicated file systems cannot be recovered. File systems are destroyed using the PATCH method. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_file_systems_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, /login, and /logout)

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

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

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

api232_file_systems_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = 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, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → FileSystemGetResponse

List file systems

Displays a list of file systems, including those pending eradication. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

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

api232_file_systems_patch_with_http_info(file_system: Optional[FileSystemPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → FileSystemResponse

Modify a file system

Modifies a file system. You can rename, destroy, move, or recover a file system. To rename a file system, set name to the new name. To destroy a file system, set destroyed=true. To move a file system, set ‘pod’ to the destination pod reference. To recover a file system that has been destroyed and is pending eradication, set destroyed=false. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_file_systems_patch_with_http_info(file_system, async_req=True) >>> result = thread.get()

Parameters

• file_system (FileSystemPatch) – (required)

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

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

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• 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

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

api232_file_systems_post_with_http_info(names: Optional[List[str]] = None, authorization: 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) → FileSystemResponse

Create file system

Creates one or more file systems. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_file_systems_post_with_http_info(names, async_req=True) >>> result = thread.get()

Parameters

• names (list[str]) – Performs the operation on the unique name specified. For example, name01. Enter multiple names in comma-separated format. (required)

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

• 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

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

pypureclient.flasharray.FA_2_32.api.files_api module

FlashArray REST API

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

OpenAPI spec version: 2.32

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

class pypureclient.flasharray.FA_2_32.api.files_api.FilesApi(api_client)

Bases: object

api232_files_post_with_http_info(source_file: Optional[FilePost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, directory_ids: Optional[List[str]] = None, directory_names: Optional[List[str]] = None, paths: Optional[List[str]] = None, overwrite: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Create a file copy

Creates a file copy from one path to another path. The directory_ids, directory_names or paths value must be specified. If the directory_ids or directory_names value is not specified, the file is copied to the source directory specified in the body params. The paths value refers to the path of the target file relative to the target directory. If paths value is not specified, the file will be copied to the relative path specified in source_path under the target directory. The source_path value refers to the path of the source file relative to the source directory. To overwrite an existing file, set the overwrite flag to true. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_files_post_with_http_info(source_file, async_req=True) >>> result = thread.get()

Parameters

• source_file (FilePost) – (required)

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

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

• directory_ids (list[str]) – Performs the operation on the unique managed directory IDs specified. Enter multiple managed directory IDs in comma-separated format. The directory_ids or directory_names parameter is required, but they cannot be set together.

• directory_names (list[str]) – Performs the operation on the managed directory names specified. Enter multiple full managed directory names in comma-separated format. For example, fs:dir01,fs:dir02.

• paths (list[str]) – Target file path relative to the target directory. Enter multiple target file path in a comma-separated format. For example, /dir1/dir2/file1,/dir3/dir4/file2.

• overwrite (bool) – If set to true, overwrites an existing object during an object copy operation. If set to false or not set at all and the target name is an existing object, the copy operation fails. Required if the source body parameter is set and the source overwrites an existing object during the copy operation.

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

pypureclient.flasharray.FA_2_32.api.hardware_api module

FlashArray REST API

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

OpenAPI spec version: 2.32

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

class pypureclient.flasharray.FA_2_32.api.hardware_api.HardwareApi(api_client)

Bases: object

api232_hardware_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → HardwareGetResponse

List hardware component information

Displays a list of hardware slots and bays and status of installed components. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_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, /login, and /logout)

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

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

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

api232_hardware_patch_with_http_info(hardware: Optional[HardwarePatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → HardwareResponse

Modify visual identification

Modifies the visual identification of a specified hardware component, and causing the ID LED to turn on or off. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_hardware_patch_with_http_info(hardware, async_req=True) >>> result = thread.get()

Parameters

• hardware (HardwarePatch) – (required)

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

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

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• 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

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

pypureclient.flasharray.FA_2_32.api.host_groups_api module

FlashArray REST API

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

OpenAPI spec version: 2.32

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

class pypureclient.flasharray.FA_2_32.api.host_groups_api.HostGroupsApi(api_client)

Bases: object

api232_host_groups_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, 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 a host group

Deletes a host group. The names query parameter is required. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_host_groups_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, /login, and /logout)

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

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

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

api232_host_groups_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, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → HostGroupGetResponse

List host groups

Displays a list of host groups. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_host_groups_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_host_groups_hosts_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, group_names: Optional[List[str]] = None, member_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

Remove a host from a host group

Removes a host from a host group. Removing a host from a host group automatically disconnects the host from all volumes associated with the group. Hosts can be removed from host groups at any time. The group_names and member_names parameters are required and must be set together, and only one host group can be specified at a time. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_host_groups_hosts_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, /login, and /logout)

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

• group_names (list[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

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

api232_host_groups_hosts_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, group_names: Optional[List[str]] = None, limit: Optional[int] = None, member_names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → MemberNoIdAllGetResponse

List host groups that are associated with hosts

Returns a list of host groups that are associated with hosts. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_host_groups_hosts_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• group_names (list[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_host_groups_hosts_post_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, group_names: Optional[List[str]] = None, member_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → MemberNoIdAllResponse

Add a host to a host group

Adds a host to a host group. Adding a host to a host group automatically connects the host to all volumes associated with the group. Multiple hosts can be belong to a host group, but a host can only belong to one host group. Hosts can be added to host groups at any time. The group_names and member_names parameters are required and must be set together, and only one host group can be specified at a time. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_host_groups_hosts_post_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, /login, and /logout)

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

• group_names (list[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• 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

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

api232_host_groups_patch_with_http_info(host_group: Optional[HostGroupPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → HostGroupResponse

Modify a host group

Modifies a host group. The names query parameter is required. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_host_groups_patch_with_http_info(host_group, async_req=True) >>> result = thread.get()

Parameters

• host_group (HostGroupPatch) – (required)

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

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

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• 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

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

api232_host_groups_performance_by_array_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, end_time: Optional[int] = None, resolution: Optional[int] = None, start_time: Optional[int] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ResourcePerformanceNoIdByArrayGetResponse

List host group performance data by array

Displays real-time and historical performance data, real-time latency data, and average I/O size data. The data is displayed by total size across all host groups on each array and by individual host group on each array. The displayed data represents the volumes that are connected to a host group on the current array and the volumes that are connected to a host group on any remote arrays that are visible to the current array. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_host_groups_performance_by_array_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, /login, and /logout)

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

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• 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

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

api232_host_groups_performance_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, end_time: Optional[int] = None, resolution: Optional[int] = None, start_time: Optional[int] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ResourcePerformanceNoIdGetResponse

List host group performance data

Displays real-time and historical performance data, real-time latency data, and average I/O sizes of all host groups, displayed both by host group and by total size across all host groups. This data represents volumes that are connected to the host groups on the local array and stretched volumes connected to the host groups on arrays that are connected by synchronous replication. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_host_groups_performance_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, /login, and /logout)

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

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• 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

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

api232_host_groups_post_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → HostGroupResponse

Create a host group

Creates a host group. The names query parameter is required. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_host_groups_post_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, /login, and /logout)

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

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• 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

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

api232_host_groups_protection_groups_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, group_ids: Optional[List[str]] = None, group_names: Optional[List[str]] = None, member_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 a host group from a protection group

Deletes a host group member from a protection group. After the member has been removed, it is no longer protected by the group. Any protection group snapshots that were taken before the member was removed are not affected. Removing a member from a protection group does not delete the member from the array, and the member can be added back to the protection group at any time. The group_names parameter represents the name of the protection group, and the member_names parameter represents the name of the host group. The group_names and member_names parameters are required and must be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_host_groups_protection_groups_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, /login, and /logout)

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

• group_ids (list[str]) – A comma-separated list of group IDs.

• group_names (list[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

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

api232_host_groups_protection_groups_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, group_ids: Optional[List[str]] = None, group_names: Optional[List[str]] = None, limit: Optional[int] = None, member_names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → MemberNoIdMemberGetResponse

List host groups that are members of protection groups

Displays a list of host group members that belong to one or more protection groups. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_host_groups_protection_groups_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• group_ids (list[str]) – A comma-separated list of group IDs.

• group_names (list[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_host_groups_protection_groups_post_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, group_ids: Optional[List[str]] = None, group_names: Optional[List[str]] = None, member_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → MemberNoIdMemberResponse

Create a host group

Creates a host group member and assigns to a protection group. Members that are already in the protection group are not affected. For asynchronous replication, only members of the same type can belong to a protection group. The group_names parameter represents the name of the protection group, and the member_names parameter represents the name of the host group. The group_names and member_names parameters are required and must be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_host_groups_protection_groups_post_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, /login, and /logout)

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

• group_ids (list[str]) – A comma-separated list of group IDs.

• group_names (list[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• 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

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

api232_host_groups_space_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ResourceSpaceNoIdGetResponse

List host group space information

Displays provisioned size and physical storage consumption data for each host group. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_host_groups_space_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, /login, and /logout)

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

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

pypureclient.flasharray.FA_2_32.api.hosts_api module

FlashArray REST API

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

OpenAPI spec version: 2.32

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

class pypureclient.flasharray.FA_2_32.api.hosts_api.HostsApi(api_client)

Bases: object

api232_hosts_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, 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 a host

Deletes an existing host. All volumes that are connected to the host, either through private or shared connections, must be disconnected from the host before the host can be deleted. The names query parameter is required. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_hosts_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, /login, and /logout)

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

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

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

api232_hosts_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, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → HostGetResponse

List hosts

Displays a list of hosts. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_hosts_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_hosts_host_groups_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, group_names: Optional[List[str]] = None, member_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

Remove a host from a host group

Removes a host from a host group. Removing a host from a host group automatically disconnects the host from all volumes associated with the group. Hosts can be removed from host groups at any time. The group_names and member_names parameters are required and must be set together, and only one host group can be specified at a time. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_hosts_host_groups_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, /login, and /logout)

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

• group_names (list[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

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

api232_hosts_host_groups_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, group_names: Optional[List[str]] = None, limit: Optional[int] = None, member_names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → MemberNoIdAllGetResponse

List hosts that are associated with host groups

Returns a list of hosts that are associated with host groups. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_hosts_host_groups_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• group_names (list[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_hosts_host_groups_post_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, group_names: Optional[List[str]] = None, member_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → MemberNoIdAllResponse

Add a host to a host group

Adds a host to a host group. Adding a host to a host group automatically connects the host to all volumes associated with the group. Multiple hosts can be belong to a host group, but a host can only belong to one host group. Hosts can be added to host groups at any time. The group_names and member_names parameters are required and must be set together, and only one host group can be specified at a time. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_hosts_host_groups_post_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, /login, and /logout)

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

• group_names (list[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• 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

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

api232_hosts_patch_with_http_info(host: Optional[HostPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → HostResponse

Modify a host

Modifies an existing host, including its storage network addresses, CHAP, host personality, and preferred arrays, or associate a host to a host group. The names query parameter is required. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_hosts_patch_with_http_info(host, async_req=True) >>> result = thread.get()

Parameters

• host (HostPatch) – (required)

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

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

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• 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

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

api232_hosts_performance_balance_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → HostPerformanceBalanceGetResponse

List host performance balance

Displays the I/O balance statistics for host paths. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_hosts_performance_balance_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, /login, and /logout)

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

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_hosts_performance_by_array_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, end_time: Optional[int] = None, resolution: Optional[int] = None, start_time: Optional[int] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ResourcePerformanceNoIdByArrayGetResponse

List host performance data by array

Displays real-time and historical performance data, real-time latency data, and average I/O size data. The data is displayed by total size across all hosts on each array and by individual host on each array. The displayed data represents the volumes that are connected to a host on the current array and the volumes that are connected to a host on any remote arrays that are visible to the current array. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_hosts_performance_by_array_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, /login, and /logout)

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

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• 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

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

api232_hosts_performance_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, end_time: Optional[int] = None, resolution: Optional[int] = None, start_time: Optional[int] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ResourcePerformanceNoIdGetResponse

List host performance data

Displays real-time and historical performance data, real-time latency data, and average I/O sizes across all hosts, displayed by host and by total size across all hosts. This data represents volumes that are connected to the hosts on the local array and stretched volumes connected to the hosts on any arrays that are connected by synchronous replication. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_hosts_performance_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, /login, and /logout)

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

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• 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

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

api232_hosts_post_with_http_info(host: Optional[HostPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → HostResponse

Create a host

Creates a host. The names query parameter is required. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_hosts_post_with_http_info(host, async_req=True) >>> result = thread.get()

Parameters

• host (HostPost) – (required)

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

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

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• 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

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

api232_hosts_protection_groups_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, group_ids: Optional[List[str]] = None, group_names: Optional[List[str]] = None, member_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 a host from a protection group

Deletes a host member from a protection group. After the member has been removed, it is no longer protected by the group. Any protection group snapshots that were taken before the member was removed are not affected. Removing a member from a protection group does not delete the member from the array, and the member can be added back to the protection group at any time. The group_names parameter represents the name of the protection group, and the member_names parameter represents the name of the host. The group_names and member_names parameters are required and must be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_hosts_protection_groups_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, /login, and /logout)

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

• group_ids (list[str]) – A comma-separated list of group IDs.

• group_names (list[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

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

api232_hosts_protection_groups_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, group_ids: Optional[List[str]] = None, group_names: Optional[List[str]] = None, limit: Optional[int] = None, member_names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → MemberNoIdMemberGetResponse

List hosts that are members of protection groups

Displays a list of host members that belong to one or more protection groups. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_hosts_protection_groups_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• group_ids (list[str]) – A comma-separated list of group IDs.

• group_names (list[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_hosts_protection_groups_post_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, group_ids: Optional[List[str]] = None, group_names: Optional[List[str]] = None, member_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → MemberNoIdMemberResponse

Create a host

Creates a host member and adds it to a protection group. Members that are already in the protection group are not affected. For asynchronous replication, only members of the same type can belong to a protection group. The group_names parameter represents the name of the protection group, and the member_names parameter represents the name of the host. The group_names and member_names parameters are required and must be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_hosts_protection_groups_post_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, /login, and /logout)

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

• group_ids (list[str]) – A comma-separated list of group IDs.

• group_names (list[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• 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

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

api232_hosts_space_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ResourceSpaceNoIdGetResponse

List host space information

Displays provisioned size and physical storage consumption data for each host. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_hosts_space_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, /login, and /logout)

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

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

pypureclient.flasharray.FA_2_32.api.kmip_api module

FlashArray REST API

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

OpenAPI spec version: 2.32

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

class pypureclient.flasharray.FA_2_32.api.kmip_api.KMIPApi(api_client)

Bases: object

api232_kmip_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, 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 KMIP server object

Deletes KMIP server objects. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_kmip_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, /login, and /logout)

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

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

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

api232_kmip_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, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → KmipGetResponse

List KMIP server objects

Displays the list of KMIP server objects. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_kmip_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_kmip_patch_with_http_info(kmip: Optional[KmipPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → KmipResponse

Modify KMIP attributes

Modifies one or more attributes of KMIP server objects. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_kmip_patch_with_http_info(kmip, async_req=True) >>> result = thread.get()

Parameters

• kmip (KmipPatch) – (required)

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

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

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• 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

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

api232_kmip_post_with_http_info(kmip: Optional[KmipPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → KmipResponse

Create KMIP server object

Creates KMIP server objects. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_kmip_post_with_http_info(kmip, async_req=True) >>> result = thread.get()

Parameters

• kmip (KmipPost) – (required)

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

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

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• 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

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

api232_kmip_test_get_with_http_info(names: Optional[List[str]] = None, authorization: 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) → KmipTestResultGetResponse

Lists KMIP connection tests

Displays communication data between a FlashArray and KMIP server. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_kmip_test_get_with_http_info(names, async_req=True) >>> result = thread.get()

Parameters

• names (list[str]) – Performs the operation on the unique name specified. For example, name01. Enter multiple names in comma-separated format. (required)

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

• 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

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

pypureclient.flasharray.FA_2_32.api.maintenance_windows_api module

FlashArray REST API

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

OpenAPI spec version: 2.32

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

class pypureclient.flasharray.FA_2_32.api.maintenance_windows_api.MaintenanceWindowsApi(api_client)

Bases: object

api232_maintenance_windows_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, 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 maintenance window

Deletes an open maintenance window before its scheduled end (expire) time. The names parameter is required and must be set to environment. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_maintenance_windows_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, /login, and /logout)

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

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

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

api232_maintenance_windows_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, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → MaintenanceWindowsGetResponse

List maintenance window details

Displays maintenance window details, including start time, end time, and maintenance type. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_maintenance_windows_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_maintenance_windows_post_with_http_info(maintenance_window: Optional[MaintenanceWindowPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → MaintenanceWindowsResponse

Create a maintenance window

Creates a maintenance window that suppresses alerts for a specified period of time. A maintenance window can be manually closed at any time. The names and timeout parameters are required. Set the names parameter to environment. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_maintenance_windows_post_with_http_info(maintenance_window, async_req=True) >>> result = thread.get()

Parameters

• maintenance_window (MaintenanceWindowPost) – (required)

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

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

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• 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

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

pypureclient.flasharray.FA_2_32.api.network_interfaces_api module

FlashArray REST API

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

OpenAPI spec version: 2.32

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

class pypureclient.flasharray.FA_2_32.api.network_interfaces_api.NetworkInterfacesApi(api_client)

Bases: object

api232_network_interfaces_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, 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 network interface

Deletes a network interface on a controller. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_network_interfaces_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, /login, and /logout)

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

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

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

api232_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, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → NetworkInterfaceGetResponse

List network interfaces

Displays all network interfaces for all controllers on the array. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

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

api232_network_interfaces_neighbors_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, local_port_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → NetworkInterfaceNeighborGetResponse

List network interface neighbors

Displays all neighbors for all network interfaces on the array. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_network_interfaces_neighbors_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, /login, and /logout)

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

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• local_port_names (list[str]) – Performs the operation on the unique local port name specified. Enter multiple names in comma-separated format. For example, ct0.eth0,ct1.eth0.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_network_interfaces_patch_with_http_info(network: Optional[NetworkInterfacePatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → NetworkInterfaceResponse

Modify network interface

Modifies a network interface on a controller. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_network_interfaces_patch_with_http_info(network, async_req=True) >>> result = thread.get()

Parameters

• network (NetworkInterfacePatch) – (required)

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

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

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• 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

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

api232_network_interfaces_performance_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, end_time: Optional[int] = None, resolution: Optional[int] = None, start_time: Optional[int] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → NetworkInterfacePerformanceGetResponse

List network performance statistics

Displays network statistics, historical bandwidth, and error reporting for all specified network interfaces. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_network_interfaces_performance_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, /login, and /logout)

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

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• 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

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

api232_network_interfaces_port_details_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → NetworkInterfacesPortDetailsGetResponse

List SFP port details

Displays Ethernet and Fibre Channel SFP details. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_network_interfaces_port_details_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, /login, and /logout)

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

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_network_interfaces_post_with_http_info(network: Optional[NetworkInterfacePost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → NetworkInterfaceResponse

Create network interface

Creates a network interface on a controller on the array. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_network_interfaces_post_with_http_info(network, async_req=True) >>> result = thread.get()

Parameters

• network (NetworkInterfacePost) – (required)

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

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

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• 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

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

pypureclient.flasharray.FA_2_32.api.offloads_api module

FlashArray REST API

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

OpenAPI spec version: 2.32

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

class pypureclient.flasharray.FA_2_32.api.offloads_api.OffloadsApi(api_client)

Bases: object

api232_offloads_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, 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 offload target

Deletes an offload target. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_offloads_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, /login, and /logout)

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

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

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

api232_offloads_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, protocol: Optional[str] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → OffloadGetResponse

List offload targets

Displays a list of offload targets that are connected to the array. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_offloads_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, /login, and /logout)

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

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• protocol (str) – Protocol type. Valid values are azure, google-cloud, nfs, and s3.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• 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

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

api232_offloads_post_with_http_info(offload: Optional[OffloadPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, initialize: Optional[bool] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → OffloadResponse

Create offload target

Creates an offload target, connecting it to an array. Before you can connect to, manage, and replicate to an offload target, the Purity Run app must be installed. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_offloads_post_with_http_info(offload, async_req=True) >>> result = thread.get()

Parameters

• offload (OffloadPost) – (required)

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

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

• initialize (bool) – If set to true, initializes the Amazon S3/Azure Blob container/Google Cloud Storage in preparation for offloading. The parameter must be set to true if this is the first time the array is connecting to the offload target.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• 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

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

pypureclient.flasharray.FA_2_32.api.pod_replica_links_api module

FlashArray REST API

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

OpenAPI spec version: 2.32

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

class pypureclient.flasharray.FA_2_32.api.pod_replica_links_api.PodReplicaLinksApi(api_client)

Bases: object

api232_pod_replica_links_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, local_pod_ids: Optional[List[str]] = None, local_pod_names: Optional[List[str]] = None, remote_pod_ids: Optional[List[str]] = None, remote_pod_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 pod replica links

Deletes pod replica links. The local_pod_names and remote_pod_names are required. Valid values are replicating, baselining, paused, unhealthy, quiescing, and quiesced. A status of replicating indicates that the source array is replicating to the target array. A status of baselining indicates that the the initial version of the dataset is being sent. During this phase, you cannot promote the target pod. In addition, changing the link direction might trigger the baselining status to recur. A status of paused ` indicates that data transfer between objects has stopped. A status of `unhealthy indicates that the link is currently unhealthy and customers must perform some health checks to determine the cause. A status of quiescing indicates that the source pod is not accepting new write requests but the most recent changes to the source have not arrived on the target. A status of quiesced indicates that the source pod has been demoted and all changes have been replicated to the target pod. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_pod_replica_links_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, /login, and /logout)

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

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• local_pod_ids (list[str]) – A comma-separated list of local pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the local_pod_names query parameter.

• local_pod_names (list[str]) – A comma-separated list of local pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the local_pod_ids query parameter.

• remote_pod_ids (list[str]) – A comma-separated list of remote pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_pod_names query parameter.

• remote_pod_names (list[str]) – A comma-separated list of remote pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_pod_ids query parameter.

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

api232_pod_replica_links_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, local_pod_ids: Optional[List[str]] = None, local_pod_names: Optional[List[str]] = None, offset: Optional[int] = None, remote_ids: Optional[List[str]] = None, remote_names: Optional[List[str]] = None, remote_pod_ids: Optional[List[str]] = None, remote_pod_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PodReplicaLinkGetResponse

List pod replica links

Displays the list of pod replica links that are configured between arrays. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_pod_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, /login, and /logout)

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

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• local_pod_ids (list[str]) – A comma-separated list of local pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the local_pod_names query parameter.

• local_pod_names (list[str]) – A comma-separated list of local pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the local_pod_ids query parameter.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• remote_ids (list[str]) – A comma-separated list of remote array IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_names query parameter.

• remote_names (list[str]) – A comma-separated list of remote array names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_ids query parameter.

• remote_pod_ids (list[str]) – A comma-separated list of remote pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_pod_names query parameter.

• remote_pod_names (list[str]) – A comma-separated list of remote pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_pod_ids query parameter.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_pod_replica_links_lag_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, end_time: Optional[int] = None, resolution: Optional[int] = None, start_time: Optional[int] = None, limit: Optional[int] = None, local_pod_ids: Optional[List[str]] = None, local_pod_names: Optional[List[str]] = None, offset: Optional[int] = None, remote_ids: Optional[List[str]] = None, remote_names: Optional[List[str]] = None, remote_pod_ids: Optional[List[str]] = None, remote_pod_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PodReplicaLinkLagGetResponse

List pod replica link lag

Displays the lag in milliseconds that the replication target is behind the source. This is the time difference between the current time and the recovery point. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_pod_replica_links_lag_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, /login, and /logout)

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

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• local_pod_ids (list[str]) – A comma-separated list of local pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the local_pod_names query parameter.

• local_pod_names (list[str]) – A comma-separated list of local pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the local_pod_ids query parameter.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• remote_ids (list[str]) – A comma-separated list of remote array IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_names query parameter.

• remote_names (list[str]) – A comma-separated list of remote array names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_ids query parameter.

• remote_pod_ids (list[str]) – A comma-separated list of remote pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_pod_names query parameter.

• remote_pod_names (list[str]) – A comma-separated list of remote pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_pod_ids query parameter.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_pod_replica_links_mappings_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, local_pod_ids: Optional[List[str]] = None, local_pod_names: Optional[List[str]] = None, offset: Optional[int] = None, pod_replica_link_ids: Optional[List[str]] = None, remote_ids: Optional[List[str]] = None, remote_names: Optional[List[str]] = None, remote_pod_ids: Optional[List[str]] = None, remote_pod_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PodReplicaLinkMappingPolicyGetResponse

List policy mappings

Displays a list of policy mappings. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_pod_replica_links_mappings_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• local_pod_ids (list[str]) – A comma-separated list of local pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the local_pod_names query parameter.

• local_pod_names (list[str]) – A comma-separated list of local pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the local_pod_ids query parameter.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• pod_replica_link_ids (list[str]) – A comma-separated list of pod replica link IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned.

• remote_ids (list[str]) – A comma-separated list of remote array IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_names query parameter.

• remote_names (list[str]) – A comma-separated list of remote array names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_ids query parameter.

• remote_pod_ids (list[str]) – A comma-separated list of remote pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_pod_names query parameter.

• remote_pod_names (list[str]) – A comma-separated list of remote pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_pod_ids query parameter.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_pod_replica_links_mappings_policies_patch_with_http_info(mapping: Optional[MappingPolicyPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, local_pod_ids: Optional[List[str]] = None, local_pod_names: Optional[List[str]] = None, pod_replica_link_ids: Optional[List[str]] = None, remote_ids: Optional[List[str]] = None, remote_names: Optional[List[str]] = None, remote_pod_ids: Optional[List[str]] = None, remote_pod_names: Optional[List[str]] = None, remote_policy_ids: Optional[List[str]] = None, remote_policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PodReplicaLinkMappingPolicyResponse

Modify policy mappings

Modifies policy mappings of a replica link. Valid mapping values are connected and disconnected. connected indicates that the source policy and its attachments will be mirrored on the target pod. disconnected indicates that the associated policy and its attachments are independent from any policy on the remote. This operation can only be performed on the target side of a pod replica link. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_pod_replica_links_mappings_policies_patch_with_http_info(mapping, async_req=True) >>> result = thread.get()

Parameters

• mapping (MappingPolicyPatch) – (required)

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

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

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• local_pod_ids (list[str]) – A comma-separated list of local pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the local_pod_names query parameter.

• local_pod_names (list[str]) – A comma-separated list of local pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the local_pod_ids query parameter.

• pod_replica_link_ids (list[str]) – A comma-separated list of pod replica link IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned.

• remote_ids (list[str]) – A comma-separated list of remote array IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_names query parameter.

• remote_names (list[str]) – A comma-separated list of remote array names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_ids query parameter.

• remote_pod_ids (list[str]) – A comma-separated list of remote pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_pod_names query parameter.

• remote_pod_names (list[str]) – A comma-separated list of remote pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_pod_ids query parameter.

• remote_policy_ids (list[str]) – A comma-separated list of remote policy IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_policy_names query parameter.

• remote_policy_names (list[str]) – A comma-separated list of remote policy names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_policy_ids query parameter.

• 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

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

api232_pod_replica_links_patch_with_http_info(pod_replica_link: Optional[PodReplicaLinkPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, local_pod_ids: Optional[List[str]] = None, local_pod_names: Optional[List[str]] = None, remote_ids: Optional[List[str]] = None, remote_names: Optional[List[str]] = None, remote_pod_ids: Optional[List[str]] = None, remote_pod_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PodReplicaLinkResponse

Modify pod replica links

Modifies pod replica links. The local_pod_names and remote_pod_names are required. Valid values are replicating, baselining, paused, unhealthy, quiescing, and quiesced. A status of replicating indicates that the source array is replicating to the target array. A status of baselining indicates that the the initial version of the dataset is being sent. During this phase, you cannot promote the target pod. In addition, changing the link direction might trigger the baselining status to recur. A status of paused ` indicates that data transfer between objects has stopped. A status of `unhealthy indicates that the link is currently unhealthy and customers must perform some health checks to determine the cause. A status of quiescing indicates that the source pod is not accepting new write requests but the most recent changes to the source have not arrived on the target. A status of quiesced indicates that the source pod has been demoted and all changes have been replicated to the target pod. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_pod_replica_links_patch_with_http_info(pod_replica_link, async_req=True) >>> result = thread.get()

Parameters

• pod_replica_link (PodReplicaLinkPatch) – (required)

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

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

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• local_pod_ids (list[str]) – A comma-separated list of local pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the local_pod_names query parameter.

• local_pod_names (list[str]) – A comma-separated list of local pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the local_pod_ids query parameter.

• remote_ids (list[str]) – A comma-separated list of remote array IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_names query parameter.

• remote_names (list[str]) – A comma-separated list of remote array names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_ids query parameter.

• remote_pod_ids (list[str]) – A comma-separated list of remote pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_pod_names query parameter.

• remote_pod_names (list[str]) – A comma-separated list of remote pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_pod_ids query parameter.

• 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

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

api232_pod_replica_links_performance_replication_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, end_time: Optional[int] = None, resolution: Optional[int] = None, start_time: Optional[int] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, local_pod_ids: Optional[List[str]] = None, local_pod_names: Optional[List[str]] = None, offset: Optional[int] = None, remote_ids: Optional[List[str]] = None, remote_names: Optional[List[str]] = None, remote_pod_ids: Optional[List[str]] = None, remote_pod_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PodReplicaLinkPerformanceReplicationGetResponse

api232_pod_replica_links_performance_replication_get

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_pod_replica_links_performance_replication_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, /login, and /logout)

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

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• local_pod_ids (list[str]) – A comma-separated list of local pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the local_pod_names query parameter.

• local_pod_names (list[str]) – A comma-separated list of local pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the local_pod_ids query parameter.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• remote_ids (list[str]) – A comma-separated list of remote array IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_names query parameter.

• remote_names (list[str]) – A comma-separated list of remote array names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_ids query parameter.

• remote_pod_ids (list[str]) – A comma-separated list of remote pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_pod_names query parameter.

• remote_pod_names (list[str]) – A comma-separated list of remote pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_pod_ids query parameter.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, only return the aggregate value of all items after filtering. For real-time performance, the values are aggregated for the latest timestamp. For historical performance, the values are aggregated for each timestamp from start_time to end_time. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• 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

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

api232_pod_replica_links_post_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, local_pod_ids: Optional[List[str]] = None, local_pod_names: Optional[List[str]] = None, remote_ids: Optional[List[str]] = None, remote_names: Optional[List[str]] = None, remote_pod_ids: Optional[List[str]] = None, remote_pod_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PodReplicaLinkResponse

Create pod replica links

Creates pod replica links between two arrays. The local_pod_names and remote_pod_names are required. Valid values are replicating, baselining, paused, unhealthy, quiescing, and quiesced. A status of replicating indicates that the source array is replicating to the target array. A status of baselining indicates that the the initial version of the dataset is being sent. During this phase, you cannot promote the target pod. In addition, changing the link direction might trigger the baselining status to recur. A status of paused ` indicates that data transfer between objects has stopped. A status of `unhealthy indicates that the link is currently unhealthy and customers must perform some health checks to determine the cause. A status of quiescing indicates that the source pod is not accepting new write requests but the most recent changes to the source have not arrived on the target. A status of quiesced indicates that the source pod has been demoted and all changes have been replicated to the target pod. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_pod_replica_links_post_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, /login, and /logout)

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

• local_pod_ids (list[str]) – A comma-separated list of local pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the local_pod_names query parameter.

• local_pod_names (list[str]) – A comma-separated list of local pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the local_pod_ids query parameter.

• remote_ids (list[str]) – A comma-separated list of remote array IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_names query parameter.

• remote_names (list[str]) – A comma-separated list of remote array names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_ids query parameter.

• remote_pod_ids (list[str]) – A comma-separated list of remote pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_pod_names query parameter.

• remote_pod_names (list[str]) – A comma-separated list of remote pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_pod_ids query parameter.

• 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

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

pypureclient.flasharray.FA_2_32.api.pods_api module

FlashArray REST API

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

OpenAPI spec version: 2.32

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

class pypureclient.flasharray.FA_2_32.api.pods_api.PodsApi(api_client)

Bases: object

api232_pods_arrays_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, group_names: Optional[List[str]] = None, group_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, member_ids: Optional[List[str]] = None, with_unknown: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Unstretch a pod from an array

Unstretches a pod from an array, collapsing the pod to a single array. Unstretch a pod from an array when the volumes within the stretched pod no longer need to be synchronously replicated between the two arrays. After a pod has been unstretched, synchronous replication stops. A destroyed version of the pod with “restretch” appended to the pod name is created on the array that no longer has the pod. The restretch pod represents a point-in-time snapshot of the pod, just before it was unstretched. The restretch pod enters an eradication pending period starting from the time that the pod was unstretched. A restretch can pod can be cloned or destroyed, but it cannot be explicitly recovered. The group_names parameter represents the name of the pod to be unstretched. The member_names parameter represents the name of the array from which the pod is to be unstretched. The group_names and member_names parameters are required and must be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_pods_arrays_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, /login, and /logout)

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

• group_names (list[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• group_ids (list[str]) – A comma-separated list of group IDs.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_ids (list[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• with_unknown (bool) – If set to true, unstretches the specified pod from the specified array by force. Use the with_unknown parameter in the following rare event&#58; the local array goes offline while the pod is still stretched across two arrays, the status of the remote array becomes unknown, and there is no guarantee that the pod is online elsewhere.

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

api232_pods_arrays_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, group_names: Optional[List[str]] = None, group_ids: Optional[List[str]] = None, limit: Optional[int] = None, member_names: Optional[List[str]] = None, member_ids: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → MemberGetResponse

List pods and their the array members

Returns a list of pods and the local and remote arrays over which the pods are stretched. The optional group_names parameter represents the name of the pod. The optional member_names parameter represents the name of the array over which the pod is stretched. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_pods_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, /login, and /logout)

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

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• group_names (list[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• group_ids (list[str]) – A comma-separated list of group IDs.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_ids (list[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_pods_arrays_post_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, group_names: Optional[List[str]] = None, group_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, member_ids: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → MemberResponse

Stretch a pod to an array

Stretches a pod to an array. When a pod is stretched to an array, the data in the arrays over which the pod is stretched is synchronously replicated. The group_names parameter represents the name of the pod to be stretched. The member_names parameter represents the name of the array over which the pod is to be stretched. The group_names and member_names parameters are required and must be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_pods_arrays_post_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, /login, and /logout)

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

• group_names (list[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• group_ids (list[str]) – A comma-separated list of group IDs.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_ids (list[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• 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

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

api232_pods_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, eradicate_contents: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Delete a pod

Deletes a pod that has been destroyed and is pending eradication. Eradicated pods cannot be recovered. Pods are destroyed using the PATCH method. The ids or names parameter is required, but they cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_pods_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, /login, and /logout)

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

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• eradicate_contents (bool) – Set to true to eradicate contents (e.g., volumes, protection groups, snapshots) and containers (e.g., pods, volume groups). This enables you to eradicate containers with contents.

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

api232_pods_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = 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, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PodGetResponse

List pods

Displays a list of pods that are stretched to this array. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

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

api232_pods_patch_with_http_info(pod: Optional[PodPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, abort_quiesce: Optional[bool] = None, quiesce: Optional[bool] = None, skip_quiesce: Optional[bool] = None, promote_from: Optional[str] = None, destroy_contents: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PodResponse

Modify a pod

Modifies pod details. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_pods_patch_with_http_info(pod, async_req=True) >>> result = thread.get()

Parameters

• pod (PodPatch) – (required)

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

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

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• abort_quiesce (bool) – Set to true to promote the pod when the pod-replica-link is in the quiescing state and abort when waiting for the pod-replica-link to complete the quiescing operation.

• quiesce (bool) – Set to true to demote the pod after the pod-replica-link goes into quiesced state and allow the pod to become a target of the remote pod. This ensures that all local data has been replicated to the remote pod before the pod is demoted.

• skip_quiesce (bool) – Set to true to demote the pod without quiescing the pod-replica-link and allow the pod to become a target of the remote pod. This stops all pending replication to the remote pod.

• promote_from (str) – The undo-demote pod that should be used to promote the pod. After the pod has been promoted, it will have the same data as the undo-demote pod and the undo-demote pod will be eradicated.

• destroy_contents (bool) – Set to true to destroy contents (e.g., volumes, protection groups, snapshots) and containers (e.g., pods, volume groups). This enables you to destroy containers with contents.

• 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

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

api232_pods_performance_by_array_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, end_time: Optional[int] = None, resolution: Optional[int] = None, start_time: Optional[int] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, protocol: Optional[str] = None, protocol_group: Optional[str] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PodPerformanceByArrayGetResponse

List pod performance data by array

Displays real-time and historical performance data, real-time latency data, and average I/O size data. The data is displayed as a total across all pods on the local array and by individual pod. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_pods_performance_by_array_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, /login, and /logout)

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

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• protocol (str) – Protocol type. Valid values are nfs, smb, and all.

• protocol_group (str) – Protocol group type. Valid values are block, file, and all.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• 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

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

api232_pods_performance_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, end_time: Optional[int] = None, resolution: Optional[int] = None, start_time: Optional[int] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, protocol: Optional[str] = None, protocol_group: Optional[str] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PodPerformanceGetResponse

List pod performance data

Displays real-time and historical performance data, real-time latency data, and average I/O sizes across all pods, displayed both by pod and as a total across all pods. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_pods_performance_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, /login, and /logout)

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

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• protocol (str) – Protocol type. Valid values are nfs, smb, and all.

• protocol_group (str) – Protocol group type. Valid values are block, file, and all.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• 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

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

api232_pods_performance_replication_by_array_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, end_time: Optional[int] = None, resolution: Optional[int] = None, start_time: Optional[int] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PodPerformanceReplicationByArrayGetResponse

List pod replication performance data by array

Displays pod replication performance data, organized by array. The data returned is the real-time and historical performance data for each replication type at the pod level. Values include continuous, periodic, resync, and sync. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_pods_performance_replication_by_array_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, /login, and /logout)

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

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• 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

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

api232_pods_performance_replication_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, end_time: Optional[int] = None, resolution: Optional[int] = None, start_time: Optional[int] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PodPerformanceReplicationGetResponse

List pod replication performance data

Displays pod replication performance data. The data returned is the real-time and historical performance data for each replication type at the pod level. Values include continuous, periodic, resync, and sync. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_pods_performance_replication_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, /login, and /logout)

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

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, only return the aggregate value of all items after filtering. For real-time performance, the values are aggregated for the latest timestamp. For historical performance, the values are aggregated for each timestamp from start_time to end_time. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• 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

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

api232_pods_post_with_http_info(pod: Optional[PodPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, allow_throttle: Optional[bool] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PodResponse

Create a pod

Creates a pod on the local array. Each pod must be given a unique name across the arrays to which they are stretched. A pod cannot be stretched to an array that already contains a pod with the same name. After a pod has been created, add volumes and protection groups, and then stretch the pod to another (connected) array. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_pods_post_with_http_info(pod, async_req=True) >>> result = thread.get()

Parameters

• pod (PodPost) – (required)

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

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

• allow_throttle (bool) – If set to true, allows operation to fail if array health is not optimal.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• 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

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

api232_pods_space_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, end_time: Optional[int] = None, resolution: Optional[int] = None, start_time: Optional[int] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ResourcePodSpaceGetResponse

List pod space information

Displays provisioned size and physical storage consumption data for each pod on the local array. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_pods_space_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, /login, and /logout)

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

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• 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

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

api232_pods_test_post_with_http_info(pod: Optional[PodPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, allow_throttle: Optional[bool] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → TestResultWithResourceWithIdPostResponse

Create an attempt to clone a pod

Creates an attempt to clone a pod on the local array without actually cloning it, to test if the pod can be successfully cloned. It does not suppport pod creation. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_pods_test_post_with_http_info(pod, async_req=True) >>> result = thread.get()

Parameters

• pod (PodPost) – (required)

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

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

• allow_throttle (bool) – If set to true, allows operation to fail if array health is not optimal.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• 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

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

pypureclient.flasharray.FA_2_32.api.policies_api module

FlashArray REST API

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

OpenAPI spec version: 2.32

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

class pypureclient.flasharray.FA_2_32.api.policies_api.PoliciesApi(api_client)

Bases: object

api232_policies_autodir_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, 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 auto managed directory policies

Deletes one or more auto managed directory policies. The ids or names parameter is required, but they cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_policies_autodir_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, /login, and /logout)

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

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

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

api232_policies_autodir_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = 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, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyGetResponse

List auto managed directory policies

Displays a list of auto managed directory policies. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_policies_autodir_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

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

api232_policies_autodir_members_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, member_types: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_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 auto managed directory policies

Deletes one or more auto managed directory policies from resources. The policy_ids or policy_names parameter is required, but they cannot be set together. The member_ids or member_names parameter is required, but they cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_policies_autodir_members_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, /login, and /logout)

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

• member_ids (list[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_types (list[str]) – Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include directories. Enter multiple member types in comma-separated format. For example, type01,type02.

• policy_ids (list[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (list[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

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

api232_policies_autodir_members_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, member_types: 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, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberGetResponse

List auto managed directories policy members

Displays a list of auto managed directory policy members. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_policies_autodir_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (list[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_types (list[str]) – Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include directories. Enter multiple member types in comma-separated format. For example, type01,type02.

• policy_ids (list[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (list[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_policies_autodir_members_post_with_http_info(members: Optional[PolicyMemberPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberResponse

Create auto managed directory policies

Creates a membership between one or more resources with an auto managed directory policy. Applicable resources are directories. The policy_ids or policy_names parameter is required, but they cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_policies_autodir_members_post_with_http_info(members, async_req=True) >>> result = thread.get()

Parameters

• members (PolicyMemberPost) – (required)

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

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

• policy_ids (list[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (list[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• 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

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

api232_policies_autodir_patch_with_http_info(policy: Optional[PolicyPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyResponse

Modify auto managed directory policies

Modifies one or more auto managed directory policies. To enable a policy, set enabled=true. To disable a policy, set enabled=true. To rename a policy, set name to the new name. The ids or names parameter is required, but they cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_policies_autodir_patch_with_http_info(policy, async_req=True) >>> result = thread.get()

Parameters

• policy (PolicyPatch) – (required)

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

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

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• 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

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

api232_policies_autodir_post_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, source_ids: Optional[List[str]] = None, source_names: Optional[List[str]] = None, policy: Optional[PolicyPost] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyResponse

Create auto managed directory policies

Creates one or more auto managed directory policies. To copy a policy, set one of either source_names or source_ids. Each policy can only have one entry. To create a policy from scratch, policy body is required. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_policies_autodir_post_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, /login, and /logout)

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

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• source_ids (list[str]) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

• source_names (list[str]) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

• policy (PolicyPost) –

• 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

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

api232_policies_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = 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, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyGetResponse

List policies

Displays a list of policies. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

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

api232_policies_members_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, member_types: 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, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberGetResponse

List policy members

Displays a list of policy members. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (list[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_types (list[str]) – Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include directories. Enter multiple member types in comma-separated format. For example, type01,type02.

• policy_ids (list[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (list[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_policies_nfs_client_rules_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_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 NFS client policy rules.

Deletes one or more NFS client policy rules. The policy_ids or policy_names parameter is required, but cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_policies_nfs_client_rules_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, /login, and /logout)

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

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• policy_ids (list[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (list[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

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

api232_policies_nfs_client_rules_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyRuleNfsClientGetResponse

List NFS client policy rules

Displays a list of NFS client policy rules. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_policies_nfs_client_rules_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (list[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (list[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_policies_nfs_client_rules_post_with_http_info(rules: Optional[PolicyRuleNfsClientPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyRuleNfsClientResponse

Create NFS client policy rules

Creates one or more NFS client policy rules. The policy_ids or policy_names parameter is required, but cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_policies_nfs_client_rules_post_with_http_info(rules, async_req=True) >>> result = thread.get()

Parameters

• rules (PolicyRuleNfsClientPost) – (required)

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

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

• policy_ids (list[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (list[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• 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

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

api232_policies_nfs_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, 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 NFS policies

Deletes one or more NFS policies. The ids or names parameter is required, but they cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_policies_nfs_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, /login, and /logout)

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

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

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

api232_policies_nfs_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = 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, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyNfsGetResponse

List NFS policies

Displays a list of NFS policies. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_policies_nfs_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_policies_nfs_members_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, member_types: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_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 NFS policies

Deletes one or more NFS policies from resources. The policy_ids or policy_names parameter is required, but cannot be set together. The member_ids or member_names parameter is required, but cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_policies_nfs_members_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, /login, and /logout)

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

• member_ids (list[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_types (list[str]) – Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include directories. Enter multiple member types in comma-separated format. For example, type01,type02.

• policy_ids (list[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (list[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

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

api232_policies_nfs_members_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, member_types: 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, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberExportGetResponse

List NFS policy members

Displays a list of NFS policy members. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_policies_nfs_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (list[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_types (list[str]) – Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include directories. Enter multiple member types in comma-separated format. For example, type01,type02.

• policy_ids (list[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (list[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_policies_nfs_members_post_with_http_info(members: Optional[PolicyMemberExportPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberExportResponse

Create NFS policies

Creates a membership between one or more resources and an NFS policy. Applicable resources are directories. The policy_ids or policy_names parameter is required, but cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_policies_nfs_members_post_with_http_info(members, async_req=True) >>> result = thread.get()

Parameters

• members (PolicyMemberExportPost) – (required)

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

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

• policy_ids (list[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (list[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• 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

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

api232_policies_nfs_patch_with_http_info(policy: Optional[PolicyNfsPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyNfsResponse

Modify NFS policies

Modifies one or more NFS policies. To enable a policy, set enabled=true. To disable a policy, set enabled=false. To rename a policy, set name to the new name. The ids or names parameter is required, but they cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_policies_nfs_patch_with_http_info(policy, async_req=True) >>> result = thread.get()

Parameters

• policy (PolicyNfsPatch) – (required)

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

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

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• 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

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

api232_policies_nfs_post_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, source_ids: Optional[List[str]] = None, source_names: Optional[List[str]] = None, policy: Optional[PolicyNfsPost] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyNfsResponse

Create NFS policies

Creates one or more NFS policies or copies an existing policy. To copy a policy, the source_names or source_ids parameter is required, but they cannot be set together. To create a policy, policy body is required. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_policies_nfs_post_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, /login, and /logout)

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

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• source_ids (list[str]) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

• source_names (list[str]) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

• policy (PolicyNfsPost) –

• 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

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

api232_policies_quota_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, 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 quota policies

Deletes one or more quota policies. The ids or names parameter is required, but they cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_policies_quota_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, /login, and /logout)

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

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

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

api232_policies_quota_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = 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, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyGetResponse

List quota policies

Displays a list of quota policies. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_policies_quota_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

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

api232_policies_quota_members_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, member_types: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_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 membership between quota policies and managed directories

Deletes a membership between one or more quota policies and managed directories. The policy_ids or policy_names parameter is required, but cannot be set together. The member_ids or member_names parameter is required, but cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_policies_quota_members_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, /login, and /logout)

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

• member_ids (list[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_types (list[str]) – Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include directories. Enter multiple member types in comma-separated format. For example, type01,type02.

• policy_ids (list[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (list[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

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

api232_policies_quota_members_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, member_types: 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, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberGetResponse

List quota policy members

Displays a list of quota policy members. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_policies_quota_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (list[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_types (list[str]) – Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include directories. Enter multiple member types in comma-separated format. For example, type01,type02.

• policy_ids (list[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (list[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_policies_quota_members_post_with_http_info(members: Optional[PolicyMemberPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, ignore_usage: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberResponse

Create a membership between a managed directory and a quota policy

Creates a membership between one or more managed directories and a quota policy. The policy_ids or policy_names parameter is required, but cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_policies_quota_members_post_with_http_info(members, async_req=True) >>> result = thread.get()

Parameters

• members (PolicyMemberPost) – (required)

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

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

• policy_ids (list[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (list[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• ignore_usage (bool) – Flag used to override checks for quota management operations. If set to true, directory usage is not checked against the quota_limits that are set. If set to false, the actual logical bytes in use are prevented from exceeding the limits set on the directory. Client operations might be impacted. If the limit exceeds the quota, the client operation is not allowed. If not specified, defaults to false.

• 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

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

api232_policies_quota_patch_with_http_info(policy: Optional[PolicyPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, ignore_usage: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyResponse

Modify quota policies

Modifies one or more quota policies. To enable a policy, set enabled=true. To disable a policy, set enabled=false. To rename a policy, set name to the new name. The ids or names parameter is required, but they cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_policies_quota_patch_with_http_info(policy, async_req=True) >>> result = thread.get()

Parameters

• policy (PolicyPatch) – (required)

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

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

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• ignore_usage (bool) – Flag used to override checks for quota management operations. If set to true, directory usage is not checked against the quota_limits that are set. If set to false, the actual logical bytes in use are prevented from exceeding the limits set on the directory. Client operations might be impacted. If the limit exceeds the quota, the client operation is not allowed. If not specified, defaults to false.

• 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

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

api232_policies_quota_post_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, source_ids: Optional[List[str]] = None, source_names: Optional[List[str]] = None, policy: Optional[PolicyPost] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyResponse

Create quota policies

Creates one or more quota policies. To copy a policy, the source_names or source_ids parameter is required, but they cannot be set together. To create a policy from scratch, policy body is required. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_policies_quota_post_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, /login, and /logout)

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

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• source_ids (list[str]) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

• source_names (list[str]) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

• policy (PolicyPost) –

• 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

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

api232_policies_quota_rules_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_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 quota policy rules

Deletes one or more quota policy rules. The policy_ids or policy_names parameter is required, but they cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_policies_quota_rules_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, /login, and /logout)

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

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• policy_ids (list[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (list[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

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

api232_policies_quota_rules_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyRuleQuotaGetResponse

List quota policy rules

Displays a list of quota policy rules. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_policies_quota_rules_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (list[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (list[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_policies_quota_rules_patch_with_http_info(rules: Optional[PolicyRuleQuotaPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, ignore_usage: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyRuleQuotaResponse

Modify quota policy rules

Modifies quota policy rules. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_policies_quota_rules_patch_with_http_info(rules, async_req=True) >>> result = thread.get()

Parameters

• rules (PolicyRuleQuotaPatch) – (required)

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

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

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• policy_ids (list[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (list[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• ignore_usage (bool) – Flag used to override checks for quota management operations. If set to true, directory usage is not checked against the quota_limits that are set. If set to false, the actual logical bytes in use are prevented from exceeding the limits set on the directory. Client operations might be impacted. If the limit exceeds the quota, the client operation is not allowed. If not specified, defaults to false.

• 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

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

api232_policies_quota_rules_post_with_http_info(rules: Optional[PolicyRuleQuotaPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, ignore_usage: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyRuleQuotaResponse

Create quota policy rules

Creates one or more quota policy rules. The policy_ids or policy_names parameter is required, but cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_policies_quota_rules_post_with_http_info(rules, async_req=True) >>> result = thread.get()

Parameters

• rules (PolicyRuleQuotaPost) – (required)

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

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

• policy_ids (list[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (list[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• ignore_usage (bool) – Flag used to override checks for quota management operations. If set to true, directory usage is not checked against the quota_limits that are set. If set to false, the actual logical bytes in use are prevented from exceeding the limits set on the directory. Client operations might be impacted. If the limit exceeds the quota, the client operation is not allowed. If not specified, defaults to false.

• 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

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

api232_policies_smb_client_rules_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_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 SMB client policy rules.

Deletes one or more SMB client policy rules. The policy_ids or policy_names parameter is required, but they cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_policies_smb_client_rules_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, /login, and /logout)

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

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• policy_ids (list[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (list[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

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

api232_policies_smb_client_rules_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyRuleSmbClientGetResponse

List SMB client policy rules

Displays a list of SMB client policy rules. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_policies_smb_client_rules_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (list[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (list[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_policies_smb_client_rules_post_with_http_info(rules: Optional[PolicyRuleSmbClientPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyRuleSmbClientResponse

Create SMB client policy rules

Creates one or more SMB client policy rules. The policy_ids or policy_names parameter is required, but cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_policies_smb_client_rules_post_with_http_info(rules, async_req=True) >>> result = thread.get()

Parameters

• rules (PolicyRuleSmbClientPost) – (required)

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

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

• policy_ids (list[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (list[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• 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

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

api232_policies_smb_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, 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 SMB policies

Deletes one or more SMB policies. The ids or names parameter is required, but they cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_policies_smb_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, /login, and /logout)

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

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

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

api232_policies_smb_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = 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, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicySmbGetResponse

List SMB policies

Displays a list of SMB policies. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_policies_smb_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_policies_smb_members_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, member_types: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_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 SMB policies

Deletes one or more SMB policies from resources. The policy_ids or policy_names parameter is required, but cannot be set together. The member_ids or member_names parameter is required, but cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_policies_smb_members_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, /login, and /logout)

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

• member_ids (list[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_types (list[str]) – Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include directories. Enter multiple member types in comma-separated format. For example, type01,type02.

• policy_ids (list[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (list[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

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

api232_policies_smb_members_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, member_types: 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, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberExportGetResponse

List SMB policy members

Displays a list of SMB policy members. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_policies_smb_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (list[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_types (list[str]) – Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include directories. Enter multiple member types in comma-separated format. For example, type01,type02.

• policy_ids (list[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (list[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_policies_smb_members_post_with_http_info(members: Optional[PolicyMemberExportPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberExportResponse

Create SMB policies

Creates a membership between one or more resources and an SMB policy. Applicable resources are directories. The policy_ids or policy_names parameter is required, but cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_policies_smb_members_post_with_http_info(members, async_req=True) >>> result = thread.get()

Parameters

• members (PolicyMemberExportPost) – (required)

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

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

• policy_ids (list[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (list[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• 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

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

api232_policies_smb_patch_with_http_info(policy: Optional[PolicySmbPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicySmbResponse

Modify SMB policies

Modifies one or more SMB policies. To enable a policy, set enabled=true. To disable a policy, set enabled=false. To enable access based enumeration, set access_based_enumeration_enabled=true. To disable access based enumeration, set access_based_enumeration_enabled=false. To rename a policy, set name to the new name. The ids or names parameter is required, but they cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_policies_smb_patch_with_http_info(policy, async_req=True) >>> result = thread.get()

Parameters

• policy (PolicySmbPatch) – (required)

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

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

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• 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

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

api232_policies_smb_post_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, source_ids: Optional[List[str]] = None, source_names: Optional[List[str]] = None, policy: Optional[PolicySmbPost] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicySmbResponse

Create SMB policies

Creates one or more SMB policies. To copy a policy, set one of either source_names or source_ids. Each policy can only have one entry. To create a policy from scratch, policy body is required. To create an SMB policy with access based enumeration enabled, set access_based_enumeration_enabled=true. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_policies_smb_post_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, /login, and /logout)

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

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• source_ids (list[str]) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

• source_names (list[str]) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

• policy (PolicySmbPost) –

• 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

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

api232_policies_snapshot_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, 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 snapshot policies

Deletes one or more snapshot policies. The ids or names parameter is required, but they cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_policies_snapshot_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, /login, and /logout)

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

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

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

api232_policies_snapshot_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = 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, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyGetResponse

List snapshot policies

Displays a list of snapshot policies. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_policies_snapshot_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

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

api232_policies_snapshot_members_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, member_types: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_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 snapshot policies

Deletes one or more snapshot policies from resources. The policy_ids or policy_names parameter is required, but cannot be set together. The member_ids or member_names parameter is required, but cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_policies_snapshot_members_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, /login, and /logout)

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

• member_ids (list[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_types (list[str]) – Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include directories. Enter multiple member types in comma-separated format. For example, type01,type02.

• policy_ids (list[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (list[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

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

api232_policies_snapshot_members_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, member_types: 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, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberGetResponse

List snapshot policy members

Displays a list of snapshot policy members. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_policies_snapshot_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (list[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_types (list[str]) – Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include directories. Enter multiple member types in comma-separated format. For example, type01,type02.

• policy_ids (list[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (list[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_policies_snapshot_members_post_with_http_info(members: Optional[PolicyMemberPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberResponse

Create snapshot policies

Creates a membership between one or more resources and a snapshot policy. Applicable resources are directories. The policy_ids or policy_names parameter is required, but cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_policies_snapshot_members_post_with_http_info(members, async_req=True) >>> result = thread.get()

Parameters

• members (PolicyMemberPost) – (required)

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

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

• policy_ids (list[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (list[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• 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

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

api232_policies_snapshot_patch_with_http_info(policy: Optional[PolicyPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyResponse

Modify snapshot policies

Modifies one or more snapshot policies. To enable a policy, set enabled=true. To disable a policy, set enabled=true. To rename a policy, set name to the new name. The ids or names parameter is required, but they cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_policies_snapshot_patch_with_http_info(policy, async_req=True) >>> result = thread.get()

Parameters

• policy (PolicyPatch) – (required)

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

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

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• 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

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

api232_policies_snapshot_post_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, source_ids: Optional[List[str]] = None, source_names: Optional[List[str]] = None, policy: Optional[PolicyPost] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyResponse

Create snapshot policies

Creates one or more snapshot policies. To copy a policy, set one of either source_names or source_ids. Each policy can only have one entry. To create a policy from scratch, policy body is required. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_policies_snapshot_post_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, /login, and /logout)

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

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• source_ids (list[str]) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

• source_names (list[str]) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

• policy (PolicyPost) –

• 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

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

api232_policies_snapshot_rules_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_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 snapshot policy rules

Deletes one or more snapshot policy rules. The policy_ids or policy_names parameter is required, but cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_policies_snapshot_rules_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, /login, and /logout)

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

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• policy_ids (list[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (list[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

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

api232_policies_snapshot_rules_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyRuleSnapshotGetResponse

List snapshot policy rules

Displays a list of snapshot policy rules. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_policies_snapshot_rules_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (list[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (list[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_policies_snapshot_rules_post_with_http_info(rules: Optional[PolicyRuleSnapshotPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyRuleSnapshotResponse

Create snapshot policy rules

Creates one or more snapshot policy rules. The policy_ids or policy_names parameter is required, but cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_policies_snapshot_rules_post_with_http_info(rules, async_req=True) >>> result = thread.get()

Parameters

• rules (PolicyRuleSnapshotPost) – (required)

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

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

• policy_ids (list[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (list[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• 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

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

pypureclient.flasharray.FA_2_32.api.ports_api module

FlashArray REST API

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

OpenAPI spec version: 2.32

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

class pypureclient.flasharray.FA_2_32.api.ports_api.PortsApi(api_client)

Bases: object

api232_ports_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PortGetResponse

List ports

Displays host name, iSCSI Qualified Names (IQNs), NVMe Qualified Names (NQNs), IPv4 address of the portal, Fibre Channel World Wide Names (WWNs), and failover ports, including those that were discovered by Purity//FA and those that have been manually assigned by system administrators. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_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, /login, and /logout)

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

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

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

api232_ports_initiators_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PortInitiatorsGetResponse

List port initiators

Displays host iSCSI Qualified Names (IQNs), NVMe Qualified Names (NQNs), and Fibre Channel World Wide Names (WWNs), including those that were discovered by Purity//FA and those that have been manually assigned by system administrators, along with the array ports (targets) on which they are eligible to communicate. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_ports_initiators_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, /login, and /logout)

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

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

pypureclient.flasharray.FA_2_32.api.protection_group_snapshots_api module

FlashArray REST API

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

OpenAPI spec version: 2.32

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

class pypureclient.flasharray.FA_2_32.api.protection_group_snapshots_api.ProtectionGroupSnapshotsApi(api_client)

Bases: object

api232_protection_group_snapshots_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, 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 a protection group snapshot

Deletes a protection group snapshot that has been destroyed and is pending eradication. Eradicating a protection group snapshot eradicates all of its protection group snapshots and cannot be recovered. Protection group snapshots are destroyed through the PATCH method. The names or ids parameter is required, but they cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_protection_group_snapshots_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, /login, and /logout)

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

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

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

api232_protection_group_snapshots_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, limit: Optional[int] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, source_names: Optional[List[str]] = None, source_ids: Optional[List[str]] = None, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ProtectionGroupSnapshotGetResponse

List protection group snapshots

Displays a list of protection group snapshots, including those pending eradication. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_protection_group_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• source_names (list[str]) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

• source_ids (list[str]) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• 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

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

api232_protection_group_snapshots_patch_with_http_info(protection_group_snapshot: Optional[ProtectionGroupSnapshotPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ProtectionGroupSnapshotResponse

Modify a protection group snapshot

Modifies a protection group snapshot so that it can be destroyed. To destroy a volume, set destroyed=true. To recover a volume that has been destroyed and is pending eradication, set destroyed=false. The names or ids parameter is required, but they cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_protection_group_snapshots_patch_with_http_info(protection_group_snapshot, async_req=True) >>> result = thread.get()

Parameters

• protection_group_snapshot (ProtectionGroupSnapshotPatch) – (required)

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

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

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• 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

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

api232_protection_group_snapshots_post_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, apply_retention: Optional[bool] = None, for_replication: Optional[bool] = None, replicate: Optional[bool] = None, replicate_now: Optional[bool] = None, allow_throttle: Optional[bool] = None, source_ids: Optional[List[str]] = None, source_names: Optional[List[str]] = None, protection_group_snapshot: Optional[ProtectionGroupSnapshotPost] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ProtectionGroupSnapshotResponse

Create a protection group snapshot

Creates a point-in-time snapshot of the contents of a protection group. The source_ids or source_names parameter is required, but they cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_protection_group_snapshots_post_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, /login, and /logout)

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

• apply_retention (bool) – If true, applies the local and remote retention policy to the snapshots.

• for_replication (bool) – If true, destroys and eradicates the snapshot after 1 hour.

• replicate (bool) – If set to true, queues up and begins replicating to each allowed target after all earlier replication sessions for the same protection group have been completed to that target. The replicate and replicate_now parameters cannot be used together.

• replicate_now (bool) – If set to true, replicates the snapshots to each allowed target. The replicate and replicate_now parameters cannot be used together.

• allow_throttle (bool) – If set to true, allows snapshot to fail if array health is not optimal.

• source_ids (list[str]) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

• source_names (list[str]) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

• protection_group_snapshot (ProtectionGroupSnapshotPost) –

• 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

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

api232_protection_group_snapshots_replica_post_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, convert_source_to_baseline: Optional[bool] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, on: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ProtectionGroupSnapshotReplicaResponse

Create an action to send protection group snapshots

Creates an action to send protection group snapshots to protection pgroup targets. When the on option is used, only specified targets will recieve the protection group snapshots. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_protection_group_snapshots_replica_post_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, /login, and /logout)

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

• convert_source_to_baseline (bool) – Set to true to have the snapshot be eradicated when it is no longer baseline on source.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• on (list[str]) – Performs the operation locally with the target names specified as the destinations of the operation. Enter multiple target names in comma-separated format. For example, targetName01,targetName02.

• 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

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

api232_protection_group_snapshots_test_post_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, apply_retention: Optional[bool] = None, for_replication: Optional[bool] = None, replicate: Optional[bool] = None, replicate_now: Optional[bool] = None, allow_throttle: Optional[bool] = None, source_ids: Optional[List[str]] = None, source_names: Optional[List[str]] = None, protection_group_snapshot: Optional[ProtectionGroupSnapshotPost] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → TestResultWithResourceWithIdPostResponse

Create an attempt to take protection group snapshot

Creates an attempt to take the protection group snapshot, without actually taking it, to test if the snapshot can be successfully taken. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_protection_group_snapshots_test_post_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, /login, and /logout)

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

• apply_retention (bool) – If true, applies the local and remote retention policy to the snapshots.

• for_replication (bool) – If true, destroys and eradicates the snapshot after 1 hour.

• replicate (bool) – If set to true, queues up and begins replicating to each allowed target after all earlier replication sessions for the same protection group have been completed to that target. The replicate and replicate_now parameters cannot be used together.

• replicate_now (bool) – If set to true, replicates the snapshots to each allowed target. The replicate and replicate_now parameters cannot be used together.

• allow_throttle (bool) – If set to true, allows snapshot to fail if array health is not optimal.

• source_ids (list[str]) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

• source_names (list[str]) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

• protection_group_snapshot (ProtectionGroupSnapshotPost) –

• 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

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

api232_protection_group_snapshots_transfer_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = 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, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ProtectionGroupSnapshotTransferGetResponse

List protection group snapshots with transfer statistics

Displays a list of protection group snapshots and corresponding transfer statistics. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_protection_group_snapshots_transfer_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• source_ids (list[str]) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

• source_names (list[str]) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• 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

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

pypureclient.flasharray.FA_2_32.api.protection_groups_api module

FlashArray REST API

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

OpenAPI spec version: 2.32

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

class pypureclient.flasharray.FA_2_32.api.protection_groups_api.ProtectionGroupsApi(api_client)

Bases: object

api232_protection_groups_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, 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 a protection group

Deletes a protection group that has been destroyed and is pending eradication. Eradicated protection groups cannot be recovered. Protection groups are destroyed through the PATCH method. The names parameter is required. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_protection_groups_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, /login, and /logout)

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

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

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

api232_protection_groups_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = 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, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ProtectionGroupGetResponse

List protection groups

Displays a list of protection groups, including their associated source arrays, replication targets, hosts, host groups, and volumes. The list includes protection groups that were created on the local array to replicate snapshot data to other arrays or offload targets, created on a remote array and replicated asynchronously to this array, or created inside a pod on a remote array and stretched to the local array. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_protection_groups_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• 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

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

api232_protection_groups_host_groups_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, group_ids: Optional[List[str]] = None, group_names: Optional[List[str]] = None, member_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 a host group from a protection group

Deletes a host group member from a protection group. After the member has been removed, it is no longer protected by the group. Protection group snapshots taken before the member was removed will not be affected. Removing a member from a protection group does not delete the member from the array, and the member can be added back to the protection group at any time. The group_names parameter represents the name of the protection group, and the member_names parameter represents the name of the host group. The group_names and member_names parameters are required and must be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_protection_groups_host_groups_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, /login, and /logout)

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

• group_ids (list[str]) – A comma-separated list of group IDs.

• group_names (list[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

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

api232_protection_groups_host_groups_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, group_ids: Optional[List[str]] = None, group_names: Optional[List[str]] = None, limit: Optional[int] = None, member_names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → MemberNoIdMemberGetResponse

List protection groups with host group members

Displays a list of protection groups that have host group members. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_protection_groups_host_groups_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• group_ids (list[str]) – A comma-separated list of group IDs.

• group_names (list[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_protection_groups_host_groups_post_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, group_ids: Optional[List[str]] = None, group_names: Optional[List[str]] = None, member_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → MemberNoIdMemberResponse

Creates an action to add a host group to a protection group

Creates an action to add a host group member to a protection group. Members that are already in the protection group are not affected. For asynchronous replication, only members of the same type can belong to a protection group. The group_names parameter represents the name of the protection group, and the member_names parameter represents the name of the host group. The group_names and member_names parameters are required and must be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_protection_groups_host_groups_post_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, /login, and /logout)

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

• group_ids (list[str]) – A comma-separated list of group IDs.

• group_names (list[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• 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

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

api232_protection_groups_hosts_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, group_ids: Optional[List[str]] = None, group_names: Optional[List[str]] = None, member_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 a host from a protection group

Deletes a host member from a protection group. After the member has been removed, it is no longer protected by the group. Any protection group snapshots that were taken before the member was removed will not be affected. Removing a member from a protection group does not delete the member from the array, and the member can be added back to the protection group at any time. The group_names parameter represents the name of the protection group, and the member_names parameter represents the name of the host. The group_names and member_names parameters are required and must be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_protection_groups_hosts_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, /login, and /logout)

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

• group_ids (list[str]) – A comma-separated list of group IDs.

• group_names (list[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

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

api232_protection_groups_hosts_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, group_ids: Optional[List[str]] = None, group_names: Optional[List[str]] = None, limit: Optional[int] = None, member_names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → MemberNoIdMemberGetResponse

List protection groups with host members

Displays a list of protection groups that have host members. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_protection_groups_hosts_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• group_ids (list[str]) – A comma-separated list of group IDs.

• group_names (list[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_protection_groups_hosts_post_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, group_ids: Optional[List[str]] = None, group_names: Optional[List[str]] = None, member_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → MemberNoIdMemberResponse

Create an action to add a host to a protection group

Creates an action to add a host member to a protection group. Members that are already in the protection group are not affected. For asynchronous replication, only members of the same type can belong to a protection group. The group_names parameter represents the name of the protection group, and the member_names parameter represents the name of the host. The group_names and member_names parameters are required and must be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_protection_groups_hosts_post_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, /login, and /logout)

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

• group_ids (list[str]) – A comma-separated list of group IDs.

• group_names (list[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• 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

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

api232_protection_groups_patch_with_http_info(protection_group: Optional[ProtectionGroup] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ProtectionGroupResponse

Modify a protection group

Modifies the protection group schedules to generate and replicate snapshots to another array or to an external storage system. Renames or destroys a protection group. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_protection_groups_patch_with_http_info(protection_group, async_req=True) >>> result = thread.get()

Parameters

• protection_group (ProtectionGroup) – (required)

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

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

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• 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

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

api232_protection_groups_performance_replication_by_array_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, end_time: Optional[int] = None, resolution: Optional[int] = None, start_time: Optional[int] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ProtectionGroupPerformanceArrayResponse

List protection group replication performance data with array details

Displays the total number of bytes of replication data transmitted and received per second. The data is grouped by protection group and includes the names of the source array and targets for each protection group. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_protection_groups_performance_replication_by_array_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, /login, and /logout)

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

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_protection_groups_performance_replication_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, end_time: Optional[int] = None, resolution: Optional[int] = None, start_time: Optional[int] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ProtectionGroupPerformanceResponse

List protection group replication performance data

Displays the total number of bytes of replication data transmitted and received per second. The data is grouped by protection group. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_protection_groups_performance_replication_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, /login, and /logout)

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

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_protection_groups_post_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, source_ids: Optional[List[str]] = None, source_names: Optional[List[str]] = None, overwrite: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ProtectionGroupResponse

Create a protection group

Creates a protection group on the local array for asynchronous replication. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_protection_groups_post_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, /login, and /logout)

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

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• source_ids (list[str]) – The id of the protection group or protection group snapshot to be copied into a new or existing protection group. If the destination protection group and all of its volumes already exist, include the overwrite parameter to overwrite all of the existing volumes with the snapshot contents. If including the overwrite parameter, the names of the volumes that are being overwritten must match the names of the volumes that are being restored. If the source is a protection group, the latest snapshot of the protection group will be used as the source during the copy operation.

• source_names (list[str]) – The name of the protection group or protection group snapshot to be copied into a new or existing protection group. If the destination protection group and all of its volumes already exist, include the overwrite parameter to overwrite all of the existing volumes with the snapshot contents. If including the overwrite parameter, the names of the volumes that are being overwritten must match the names of the volumes that are being restored. If the source is a protection group, the latest snapshot of the protection group will be used as the source during the copy operation.

• overwrite (bool) – If set to true, overwrites an existing object during an object copy operation. If set to false or not set at all and the target name is an existing object, the copy operation fails. Required if the source body parameter is set and the source overwrites an existing object during the copy operation.

• 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

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

api232_protection_groups_space_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, limit: Optional[int] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ResourceSpaceGetResponse

List protection group space information

Displays provisioned size and physical storage consumption data for each protection group. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_protection_groups_space_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, /login, and /logout)

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

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• 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

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

api232_protection_groups_targets_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, group_ids: Optional[List[str]] = None, group_names: Optional[List[str]] = None, member_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 a target from a protection group

Deletes an array or offload target from a protection group. The group_names parameter represents the name of the protection group. The member_names parameter represents the name of the array or offload target that is being removed from the protection group. The group_names and member_names parameters are required and must be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_protection_groups_targets_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, /login, and /logout)

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

• group_ids (list[str]) – A comma-separated list of group IDs.

• group_names (list[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

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

api232_protection_groups_targets_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, group_ids: Optional[List[str]] = None, group_names: Optional[List[str]] = None, limit: Optional[int] = None, member_names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ProtectionGroupTargetGetResponse

List protection groups with targets

Displays a list of protection groups that have target arrays or offload targets. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_protection_groups_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• group_ids (list[str]) – A comma-separated list of group IDs.

• group_names (list[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_protection_groups_targets_patch_with_http_info(target: Optional[TargetProtectionGroupPostPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, group_ids: Optional[List[str]] = None, group_names: Optional[List[str]] = None, member_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ProtectionGroupTargetResponse

Modify a protection group target

Modifies the source array to replicate protection group data to the target array, or disallows the source array from replicating protection group data to the target array. The allowed parameter must be set from the target array. The group_names parameter represents the name of the protection group. The allowed and group_names parameters are required and must be set together. Offload targets do not support the allowed parameter. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_protection_groups_targets_patch_with_http_info(target, async_req=True) >>> result = thread.get()

Parameters

• target (TargetProtectionGroupPostPatch) – (required)

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

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

• group_ids (list[str]) – A comma-separated list of group IDs.

• group_names (list[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• 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

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

api232_protection_groups_targets_post_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, group_ids: Optional[List[str]] = None, group_names: Optional[List[str]] = None, member_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ProtectionGroupTargetResponse

Create an action to add a target to a protection group

Creates an action to add an array or offload target to a protection group. The group_names parameter represents the name of the protection group. The member_names parameter represents the name of the array or offload target that is being added to the protection group. The group_names and member_names parameters are required and must be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_protection_groups_targets_post_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, /login, and /logout)

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

• group_ids (list[str]) – A comma-separated list of group IDs.

• group_names (list[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• 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

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

api232_protection_groups_volumes_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, group_ids: Optional[List[str]] = None, group_names: Optional[List[str]] = None, member_names: Optional[List[str]] = None, member_ids: 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 a volume from a protection group

Deletes a volume member from a protection group. After the member has been deleted, it is no longer protected by the group. Any protection group snapshots that were taken before the member was deleted are not affected. Deleting a member from a protection group does not delete the member from the array, and the member can be added back to the protection group at any time. The group_names parameter represents the name of the protection group, and the member_names and member_ids parameters represent the names or IDs of the volume. The group_names parameter, and either the member_names or member_ids parameters are required and must be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_protection_groups_volumes_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, /login, and /logout)

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

• group_ids (list[str]) – A comma-separated list of group IDs.

• group_names (list[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_ids (list[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

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

api232_protection_groups_volumes_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, group_ids: Optional[List[str]] = None, group_names: Optional[List[str]] = None, limit: Optional[int] = None, member_destroyed: Optional[bool] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ProtectionGroupsVolumesGetResponse

List protection groups with volume members

Displays a list of protection groups that have volume members. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_protection_groups_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• group_ids (list[str]) – Performs the operation on the unique group id specified. Provide multiple resource IDs in comma-separated format. The group_ids or names parameter is required, but they cannot be set together.

• group_names (list[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_destroyed (bool) – If true, returns only destroyed member objects. Returns an error if a name of a live member object is specified in the member_names query param. If false, returns only live member objects. Returns an error if a name of a destroyed member object is specified in the member_names query param.

• member_ids (list[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_protection_groups_volumes_post_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, group_ids: Optional[List[str]] = None, group_names: Optional[List[str]] = None, member_names: Optional[List[str]] = None, member_ids: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ProtectionGroupsVolumesResponse

Create a volume and add it to a protection group

Creates a volume member and adds it to a protection group. Members that are already in the protection group are not affected. For asynchronous replication, only members of the same type can belong to a protection group. The group_names parameter represents the name of the protection group, and the member_names and member_ids parameters represent the names or IDs of the volume. The group_names parameter, and either the member_names or member_ids parameters are required and must be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_protection_groups_volumes_post_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, /login, and /logout)

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

• group_ids (list[str]) – A comma-separated list of group IDs.

• group_names (list[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_ids (list[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• 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

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

pypureclient.flasharray.FA_2_32.api.remote_pods_api module

FlashArray REST API

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

OpenAPI spec version: 2.32

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

class pypureclient.flasharray.FA_2_32.api.remote_pods_api.RemotePodsApi(api_client)

Bases: object

api232_remote_pods_get_with_http_info(authorization: Optional[str] = None, x_request_id: 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, on: Optional[List[str]] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → RemotePodsResponse

List remote pods

Returns a list of pods that that are on connected arrays but not stretched to this array. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_remote_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, /login, and /logout)

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

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• on (list[str]) – Performs the operation on the target name specified. Enter multiple target names in comma-separated format. For example, targetName01,targetName02.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

pypureclient.flasharray.FA_2_32.api.remote_protection_group_snapshots_api module

FlashArray REST API

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

OpenAPI spec version: 2.32

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

class pypureclient.flasharray.FA_2_32.api.remote_protection_group_snapshots_api.RemoteProtectionGroupSnapshotsApi(api_client)

Bases: object

api232_remote_protection_group_snapshots_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, ids: Optional[List[str]] = None, on: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Delete a remote protection group snapshot

Deletes a remote protection group snapshot that has been destroyed and is pending eradication. Eradicated remote protection group snapshots cannot be recovered. Remote protection group snapshots are destroyed using the PATCH method. The names parameter represents the name of the protection group snapshot. The on parameter represents the name of the offload target. The names and on parameters are required and must be used together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_remote_protection_group_snapshots_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, /login, and /logout)

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

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• on (str) – Performs the operation on the target name specified. For example, targetName01.

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

api232_remote_protection_group_snapshots_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, limit: Optional[int] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, on: Optional[List[str]] = None, sort: Optional[List[str]] = None, source_ids: Optional[List[str]] = None, source_names: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → RemoteProtectionGroupSnapshotGetResponse

List remote protection group snapshots

Displays a list of remote protection group snapshots. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_remote_protection_group_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, /login, and /logout)

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

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• on (list[str]) – Performs the operation on the target name specified. Enter multiple target names in comma-separated format. For example, targetName01,targetName02.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• source_ids (list[str]) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

• source_names (list[str]) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_remote_protection_group_snapshots_patch_with_http_info(remote_protection_group_snapshot: Optional[DestroyedPatchPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, ids: Optional[List[str]] = None, on: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → RemoteProtectionGroupSnapshotResponse

Modify a remote protection group snapshot

Modifies a remote protection group snapshot, removing it from the offload target and destroying the snapshot. The on parameter represents the name of the offload target. The ids or names parameter and the on parameter are required and must be used together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_remote_protection_group_snapshots_patch_with_http_info(remote_protection_group_snapshot, async_req=True) >>> result = thread.get()

Parameters

• remote_protection_group_snapshot (DestroyedPatchPost) – (required)

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

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

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• on (str) – Performs the operation on the target name specified. For example, targetName01.

• 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

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

api232_remote_protection_group_snapshots_post_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, apply_retention: Optional[bool] = None, convert_source_to_baseline: Optional[bool] = None, for_replication: Optional[bool] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, replicate: Optional[bool] = None, replicate_now: Optional[bool] = None, allow_throttle: Optional[bool] = None, source_names: Optional[List[str]] = None, source_ids: Optional[List[str]] = None, on: Optional[str] = None, remote_protection_group_snapshot: Optional[RemoteProtectionGroupSnapshotPost] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → RemoteProtectionGroupSnapshotResponse

Create remote protection group snapshot

Creates remote protection group snapshots. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_remote_protection_group_snapshots_post_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, /login, and /logout)

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

• apply_retention (bool) – If true, applies the local and remote retention policy to the snapshots.

• convert_source_to_baseline (bool) – Set to true to have the snapshot be eradicated when it is no longer baseline on source.

• for_replication (bool) – If true, destroys and eradicates the snapshot after 1 hour.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• replicate (bool) – If set to true, queues up and begins replicating to each allowed target after all earlier replication sessions for the same protection group have been completed to that target. The replicate and replicate_now parameters cannot be used together.

• replicate_now (bool) – If set to true, replicates the snapshots to each allowed target. The replicate and replicate_now parameters cannot be used together.

• allow_throttle (bool) – If set to true, allows snapshot to fail if array health is not optimal.

• source_names (list[str]) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

• source_ids (list[str]) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

• on (str) – Performs the operation on the target name specified. For example, targetName01.

• remote_protection_group_snapshot (RemoteProtectionGroupSnapshotPost) –

• 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

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

api232_remote_protection_group_snapshots_test_post_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, apply_retention: Optional[bool] = None, convert_source_to_baseline: Optional[bool] = None, for_replication: Optional[bool] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, replicate: Optional[bool] = None, replicate_now: Optional[bool] = None, allow_throttle: Optional[bool] = None, source_ids: Optional[List[str]] = None, source_names: Optional[List[str]] = None, on: Optional[str] = None, remote_protection_group_snapshot: Optional[RemoteProtectionGroupSnapshotPost] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → TestResultWithResourceWithIdPostResponse

Create an attempt to take remote protection group snapshot

Create an attempt to take a remote protection group snapshot without actually taking it, to test if the snapshot can be successfully taken. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_remote_protection_group_snapshots_test_post_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, /login, and /logout)

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

• apply_retention (bool) – If true, applies the local and remote retention policy to the snapshots.

• convert_source_to_baseline (bool) – Set to true to have the snapshot be eradicated when it is no longer baseline on source.

• for_replication (bool) – If true, destroys and eradicates the snapshot after 1 hour.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• replicate (bool) – If set to true, queues up and begins replicating to each allowed target after all earlier replication sessions for the same protection group have been completed to that target. The replicate and replicate_now parameters cannot be used together.

• replicate_now (bool) – If set to true, replicates the snapshots to each allowed target. The replicate and replicate_now parameters cannot be used together.

• allow_throttle (bool) – If set to true, allows snapshot to fail if array health is not optimal.

• source_ids (list[str]) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

• source_names (list[str]) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

• on (str) – Performs the operation on the target name specified. For example, targetName01.

• remote_protection_group_snapshot (RemoteProtectionGroupSnapshotPost) –

• 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

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

api232_remote_protection_group_snapshots_transfer_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, limit: Optional[int] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, on: Optional[List[str]] = None, sort: Optional[List[str]] = None, source_ids: Optional[List[str]] = None, source_names: Optional[List[str]] = None, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → RemoteProtectionGroupSnapshotTransferGetResponse

List remote protection groups with transfer statistics

Displays a list of remote protection groups and their transfer statistics. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_remote_protection_group_snapshots_transfer_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, /login, and /logout)

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

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• on (list[str]) – Performs the operation on the target name specified. Enter multiple target names in comma-separated format. For example, targetName01,targetName02.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• source_ids (list[str]) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

• source_names (list[str]) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• 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

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

pypureclient.flasharray.FA_2_32.api.remote_protection_groups_api module

FlashArray REST API

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

OpenAPI spec version: 2.32

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

class pypureclient.flasharray.FA_2_32.api.remote_protection_groups_api.RemoteProtectionGroupsApi(api_client)

Bases: object

api232_remote_protection_groups_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, on: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Eradicate a remote protection group

Eradicates a remote protection group that has been destroyed and is pending eradication. Eradicated remote protection groups cannot be recovered. Remote protection groups are destroyed through the PATCH method. The on parameter represents the name of the offload target. The ids or names parameter and the on parameter are required and must be used together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_remote_protection_groups_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, /login, and /logout)

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

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• on (str) – Performs the operation on the target name specified. For example, targetName01.

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

api232_remote_protection_groups_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, on: Optional[List[str]] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → RemoteProtectionGroupGetResponse

List remote protection groups

Returns a list of remote protection groups. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_remote_protection_groups_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, /login, and /logout)

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

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• on (list[str]) – Performs the operation on the target name specified. Enter multiple target names in comma-separated format. For example, targetName01,targetName02.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_remote_protection_groups_patch_with_http_info(remote_protection_group: Optional[RemoteProtectionGroup] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, on: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → RemoteProtectionGroupResponse

Manage a remote protection group

Configures the snapshot retention schedule of a remote protection group. Also destroys a remote protection group from the offload target. Before the remote protection group can be destroyed, the offload target must first be removed from the protection group via the source array. The on parameter represents the name of the offload target. The ids or names parameter and the on parameter are required and must be used together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_remote_protection_groups_patch_with_http_info(remote_protection_group, async_req=True) >>> result = thread.get()

Parameters

• remote_protection_group (RemoteProtectionGroup) – (required)

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

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

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• on (str) – Performs the operation on the target name specified. For example, targetName01.

• 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

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

pypureclient.flasharray.FA_2_32.api.remote_volume_snapshots_api module

FlashArray REST API

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

OpenAPI spec version: 2.32

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

class pypureclient.flasharray.FA_2_32.api.remote_volume_snapshots_api.RemoteVolumeSnapshotsApi(api_client)

Bases: object

api232_remote_volume_snapshots_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, on: Optional[str] = None, replication_snapshot: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Delete a remote volume snapshot

Deletes (eradicates) a remote volume snapshot that has been destroyed and is pending eradication. Eradicated remote volume snapshots cannot be recovered. Remote volume snapshots are destroyed through the PATCH method. The names parameter represents the name of the volume snapshot. The on parameter represents the name of the offload target. The names and on parameters are required and must be used together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_remote_volume_snapshots_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, /login, and /logout)

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

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• on (str) – Performs the operation on the target name specified. For example, targetName01.

• replication_snapshot (bool) – If set to true, allow destruction/eradication of snapshots in use by replication. If set to false, allow destruction/eradication of snapshots not in use by replication. If not specified, defaults to false.

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

api232_remote_volume_snapshots_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, on: Optional[List[str]] = None, sort: Optional[List[str]] = None, source_ids: Optional[List[str]] = None, source_names: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → RemoteVolumeSnapshotGetResponse

List remote volume snapshots

Displays a list of remote volume snapshots. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_remote_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, /login, and /logout)

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

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• on (list[str]) – Performs the operation on the target name specified. Enter multiple target names in comma-separated format. For example, targetName01,targetName02.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• source_ids (list[str]) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

• source_names (list[str]) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_remote_volume_snapshots_patch_with_http_info(remote_volume_snapshot: Optional[DestroyedPatchPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, on: Optional[str] = None, replication_snapshot: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → RemoteVolumeSnapshotResponse

Modify a remote volume snapshot

Modifies a remote volume snapshot by destroying or recovering it from the offload target. The on parameter represents the name of the offload target. The names parameter and the on parameter are required and must be used together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_remote_volume_snapshots_patch_with_http_info(remote_volume_snapshot, async_req=True) >>> result = thread.get()

Parameters

• remote_volume_snapshot (DestroyedPatchPost) – (required)

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

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

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• on (str) – Performs the operation on the target name specified. For example, targetName01.

• replication_snapshot (bool) – If set to true, allow destruction/eradication of snapshots in use by replication. If set to false, allow destruction/eradication of snapshots not in use by replication. If not specified, defaults to false.

• 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

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

api232_remote_volume_snapshots_post_with_http_info(remote_volume_snapshot: Optional[RemoteVolumeSnapshotPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, source_ids: Optional[List[str]] = None, source_names: Optional[List[str]] = None, on: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → RemoteVolumeSnapshotResponse

Create a volume snapshot on a connected remote target or offload target

Creates a volume snapshot on the specified connected remote target or offload target. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_remote_volume_snapshots_post_with_http_info(remote_volume_snapshot, async_req=True) >>> result = thread.get()

Parameters

• remote_volume_snapshot (RemoteVolumeSnapshotPost) – (required)

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

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

• source_ids (list[str]) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

• source_names (list[str]) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

• on (str) – Performs the operation on the target name specified. For example, targetName01.

• 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

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

api232_remote_volume_snapshots_transfer_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, offset: Optional[int] = None, on: Optional[List[str]] = None, sort: Optional[List[str]] = None, source_ids: Optional[List[str]] = None, source_names: Optional[List[str]] = None, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → RemoteVolumeSnapshotTransferGetResponse

List remote volume snapshots with transfer statistics

Returns a list of remote volume snapshots and their transfer statistics. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_remote_volume_snapshots_transfer_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, /login, and /logout)

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

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• on (list[str]) – Performs the operation on the target name specified. Enter multiple target names in comma-separated format. For example, targetName01,targetName02.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• source_ids (list[str]) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

• source_names (list[str]) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• 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

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

pypureclient.flasharray.FA_2_32.api.saml2_sso_api module

FlashArray REST API

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

OpenAPI spec version: 2.32

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

class pypureclient.flasharray.FA_2_32.api.saml2_sso_api.SAML2SSOApi(api_client)

Bases: object

api232_sso_saml2_idps_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, 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 SAML2 SSO configurations

Deletes SAML2 SSO configurations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_sso_saml2_idps_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, /login, and /logout)

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

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

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

api232_sso_saml2_idps_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, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → Saml2SsoGetResponse

List SAML2 SSO configurations

Displays the SAML2 SSO service provider and identity provider configuration settings in the array. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_sso_saml2_idps_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_sso_saml2_idps_patch_with_http_info(idp: Optional[Saml2SsoPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → Saml2SsoResponse

Modify SAML2 SSO configurations

Modifies one or more attributes of SAML2 SSO configurations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_sso_saml2_idps_patch_with_http_info(idp, async_req=True) >>> result = thread.get()

Parameters

• idp (Saml2SsoPatch) – (required)

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

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

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• 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

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

api232_sso_saml2_idps_post_with_http_info(names: Optional[List[str]] = None, idp: Optional[Saml2SsoPost] = None, authorization: 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) → Saml2SsoResponse

Create SAML2 SSO configurations

Creates SAML2 SSO configurations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_sso_saml2_idps_post_with_http_info(names, idp, async_req=True) >>> result = thread.get()

Parameters

• names (list[str]) – Performs the operation on the unique name specified. For example, name01. Enter multiple names in comma-separated format. (required)

• idp (Saml2SsoPost) – (required)

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

• 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

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

api232_sso_saml2_idps_test_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, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → TestResultWithResourceResponse

List existing SAML2 SSO configurations

Displays the existing SAML2 SSO configurations in the array. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_sso_saml2_idps_test_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_sso_saml2_idps_test_patch_with_http_info(idp: Optional[Saml2SsoPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → TestResultWithResourcePatchResponse

Modify provided SAML2 SSO configurations

Modifies the provided SAML2 SSO configurations. If the configurations with the specified ids or names exist, the provided configurations will overwrite the existing configurations, but will not be persisted in the array. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_sso_saml2_idps_test_patch_with_http_info(idp, async_req=True) >>> result = thread.get()

Parameters

• idp (Saml2SsoPost) – (required)

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

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

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• 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

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

pypureclient.flasharray.FA_2_32.api.sessions_api module

FlashArray REST API

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

OpenAPI spec version: 2.32

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

class pypureclient.flasharray.FA_2_32.api.sessions_api.SessionsApi(api_client)

Bases: object

api232_sessions_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, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SessionGetResponse

List session data

Displays session data for user login events performed in the Purity//FA GUI, CLI, and REST API. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_sessions_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, /login, and /logout)

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

pypureclient.flasharray.FA_2_32.api.smi_s_api module

FlashArray REST API

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

OpenAPI spec version: 2.32

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

class pypureclient.flasharray.FA_2_32.api.smi_s_api.SMISApi(api_client)

Bases: object

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

List SMI-S settings

Displays the SMI-S settings, including whether SLP and WBEM-HTTPS are enabled. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_smi_s_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, /login, and /logout)

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

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_smi_s_patch_with_http_info(smi_s: Optional[Smis] = None, authorization: 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) → SmisResponse

Modify SLP and SMI-S

Modifies the Service Location Protocol (SLP) and the SMI-S provider, enabling or disabling them. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_smi_s_patch_with_http_info(smi_s, async_req=True) >>> result = thread.get()

Parameters

• smi_s (Smis) – (required)

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

• 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

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

pypureclient.flasharray.FA_2_32.api.smtp_api module

FlashArray REST API

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

OpenAPI spec version: 2.32

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

class pypureclient.flasharray.FA_2_32.api.smtp_api.SMTPApi(api_client)

Bases: object

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

List SMTP server attributes

Displays SMTP server attributes. Values include user_name, password, relay_host, sender_domain, and name. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_smtp_servers_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, /login, and /logout)

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

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_smtp_servers_patch_with_http_info(smtp: Optional[SmtpServer] = None, authorization: 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) → SmtpServerResponse

Modify SMTP server attributes

Modifies SMTP server attributes. Values include user_name, password, relay_host, sender_domain, and name. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_smtp_servers_patch_with_http_info(smtp, async_req=True) >>> result = thread.get()

Parameters

• smtp (SmtpServer) – (required)

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

• 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

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

pypureclient.flasharray.FA_2_32.api.snmp_agents_api module

FlashArray REST API

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

OpenAPI spec version: 2.32

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

class pypureclient.flasharray.FA_2_32.api.snmp_agents_api.SNMPAgentsApi(api_client)

Bases: object

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

List SNMP agent

Displays the SNMP agent name and protocol attributes. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_snmp_agents_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, /login, and /logout)

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

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

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

List SNMP agent MIB text

Displays the SNMP MIB text. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_snmp_agents_mib_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, /login, and /logout)

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

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

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

api232_snmp_agents_patch_with_http_info(snmp_agent: Optional[SnmpAgentPatch] = None, authorization: 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) → SnmpAgentResponse

Modify SNMP agent

Modifies the name or the protocol attributes of the SNMP agent. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_snmp_agents_patch_with_http_info(snmp_agent, async_req=True) >>> result = thread.get()

Parameters

• snmp_agent (SnmpAgentPatch) – (required)

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

• 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

SnmpAgentResponse If the method is called asynchronously, returns the request thread.

pypureclient.flasharray.FA_2_32.api.snmp_managers_api module

FlashArray REST API

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: 2.32

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.flasharray.FA_2_32.api.snmp_managers_api.SNMPManagersApi(api_client)

Bases: object

api232_snmp_managers_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, 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 SNMP manager

Deletes the SNMP manager object and stops communication with specified managers. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_snmp_managers_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, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• 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.

api232_snmp_managers_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, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SnmpManagerGetResponse

List SNMP managers

Displays designated SNMP managers and their communication and security attributes. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_snmp_managers_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, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

SnmpManagerGetResponse If the method is called asynchronously, returns the request thread.

api232_snmp_managers_patch_with_http_info(snmp_manager: Optional[SnmpManagerPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SnmpManagerResponse

Modify SNMP manager

Modifies the name or the protocol attributes of the specified SNMP manager. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_snmp_managers_patch_with_http_info(snmp_manager, async_req=True) >>> result = thread.get()

Parameters

• snmp_manager (SnmpManagerPatch) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• 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

SnmpManagerResponse If the method is called asynchronously, returns the request thread.

api232_snmp_managers_post_with_http_info(snmp_manager: Optional[SnmpManagerPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SnmpManagerResponse

Create SNMP manager

Creates a Purity SNMP manager object that identifies a host (SNMP manager) and specifies the protocol attributes for communicating with it. Once a manager object is created, the transmission of SNMP traps is immediately enabled. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_snmp_managers_post_with_http_info(snmp_manager, async_req=True) >>> result = thread.get()

Parameters

• snmp_manager (SnmpManagerPost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• 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

SnmpManagerResponse If the method is called asynchronously, returns the request thread.

api232_snmp_managers_test_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → TestResultWithResourceGetResponse

List SNMP manager test results

Displays SNMP manager test results (traps or informs). This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_snmp_managers_test_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, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

TestResultWithResourceGetResponse If the method is called asynchronously, returns the request thread.

pypureclient.flasharray.FA_2_32.api.software_api module

FlashArray REST API

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: 2.32

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.flasharray.FA_2_32.api.software_api.SoftwareApi(api_client)

Bases: object

api232_software_bundle_get_with_http_info(x_request_id: 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, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SoftwareBundleGetResponse

List software-bundle

Displays a list of software bundles. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_software_bundle_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• x_request_id (str) – Supplied by client during request or generated by server.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

SoftwareBundleGetResponse If the method is called asynchronously, returns the request thread.

api232_software_bundle_post_with_http_info(source: Optional[SoftwareBundlePost] = 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) → SoftwareBundleResponse

Create software-bundle

Creates and initiates a software bundle download. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_software_bundle_post_with_http_info(source, async_req=True) >>> result = thread.get()

Parameters

• source (SoftwareBundlePost) – (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

SoftwareBundleResponse If the method is called asynchronously, returns the request thread.

api232_software_check_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, software_versions: Optional[List[str]] = None, software_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 a software check task

Deletes a software check task specified by software name and version. The check task must be queued. If the check task is running or passed/failed then the task cannot be deleted. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_software_check_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, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• software_versions (list[str]) – A comma-separated list of target software versions.

• software_names (list[str]) – A comma-separated list of software names.

• 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.

api232_software_check_get_with_http_info(authorization: Optional[str] = None, x_request_id: 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, software_versions: Optional[List[str]] = None, software_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SoftwareChecksGetResponse

List software check tasks

Displays a list of software check tasks. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_software_check_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, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• software_versions (list[str]) – A comma-separated list of target software versions.

• software_names (list[str]) – A comma-separated list of software names.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

SoftwareChecksGetResponse If the method is called asynchronously, returns the request thread.

api232_software_check_post_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, software_versions: Optional[List[str]] = None, software_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SoftwareChecksResponse

Create a software check task

Creates a software check task. If there are no previously queued or running software check tasks, the new task immediately starts. Otherwise, it is queued and starts once all previously queued or running software check tasks finish. To create a task, use a software name and version. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_software_check_post_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, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• software_versions (list[str]) – A comma-separated list of target software versions.

• software_names (list[str]) – A comma-separated list of software names.

• 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

SoftwareChecksResponse If the method is called asynchronously, returns the request thread.

api232_software_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, software_versions: 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 a software package

Deletes a software package specified by software name and version. A software package being used for an installation can be deleted if the installation is downloading, downloaded, aborted, or finished. If the software package is currently downloading, the download will be cancelled. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_software_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, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• software_versions (list[str]) – A comma-separated list of target software versions.

• 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.

api232_software_get_with_http_info(authorization: Optional[str] = None, x_request_id: 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, total_item_count: Optional[bool] = None, versions: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SoftwareGetResponse

List software packages

Displays a list of available software packages. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_software_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, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• versions (list[str]) – A comma-separated list of versions.

• 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

SoftwareGetResponse If the method is called asynchronously, returns the request thread.

api232_software_installation_steps_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, software_installation_ids: Optional[List[str]] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SoftwareInstallationStepsGetResponse

List software upgrade steps

Displays a list of currently running and completed software upgrade steps. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_software_installation_steps_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, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• software_installation_ids (list[str]) – A comma-separated list of software installation IDs.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

SoftwareInstallationStepsGetResponse If the method is called asynchronously, returns the request thread.

api232_software_installations_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, software_ids: Optional[List[str]] = None, software_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SoftwareInstallationsGetResponse

List software upgrades

Displays a list of software upgrades, including currently running and past upgrades. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_software_installations_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, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• software_ids (list[str]) – A comma-separated list of software IDs.

• software_names (list[str]) – A comma-separated list of software names.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

SoftwareInstallationsGetResponse If the method is called asynchronously, returns the request thread.

api232_software_installations_patch_with_http_info(command: Optional[str] = None, current_step_id: Optional[str] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, software_installations: Optional[SoftwareInstallationPatch] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SoftwareInstallationsResponse

Modify software upgrade

Modifies a software upgrade by continuing, retrying, or aborting it. All override_checks are updated before the command being issued if add_override_checks is present. The override_checks parameter is valid when command is continue or retry. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_software_installations_patch_with_http_info(command, current_step_id, async_req=True) >>> result = thread.get()

Parameters

• command (str) – A user command that interacts with the upgrade. Commands may only be issued when the upgrade is paused. Valid values are continue, retry, and abort. The continue command continues a paused upgrade. The retry command retries the previous step. The abort command aborts the upgrade. (required)

• current_step_id (str) – The current step id of the installation. (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• software_installations (SoftwareInstallationPatch) –

• 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

SoftwareInstallationsResponse If the method is called asynchronously, returns the request thread.

api232_software_installations_post_with_http_info(software_ids: Optional[List[str]] = None, software_installations: Optional[SoftwareInstallationPost] = None, authorization: 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) → SoftwareInstallationsResponse

Create a software upgrade

Creates and initiates a software upgrade. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_software_installations_post_with_http_info(software_ids, software_installations, async_req=True) >>> result = thread.get()

Parameters

• software_ids (list[str]) – A comma-separated list of software IDs. (required)

• software_installations (SoftwareInstallationPost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• 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

SoftwareInstallationsResponse If the method is called asynchronously, returns the request thread.

api232_software_patches_catalog_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SoftwarePatchesGetResponse

List available software patches

Displays a list of available software patches. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_software_patches_catalog_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, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

SoftwarePatchesGetResponse If the method is called asynchronously, returns the request thread.

api232_software_patches_get_with_http_info(authorization: Optional[str] = None, x_request_id: 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, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SoftwarePatchesGetResponse

List software patches

Displays a list of software patches. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_software_patches_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, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

SoftwarePatchesGetResponse If the method is called asynchronously, returns the request thread.

api232_software_patches_post_with_http_info(name: Optional[str] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, allow_ha_reduction: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SoftwarePatchesResponse

Create a software patch

Creates software patch download and installation. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_software_patches_post_with_http_info(name, async_req=True) >>> result = thread.get()

Parameters

• name (str) – Name of software patch to install (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_ha_reduction (bool) – If Software Patch has ha_reduction_required set to true, allow_ha_reduction must be set to true for Software Patch installation.

• 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

SoftwarePatchesResponse If the method is called asynchronously, returns the request thread.

api232_software_post_with_http_info(software: Optional[SoftwarePost] = None, authorization: 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) → SoftwareResponse

Create a software package

Creates a software package download. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_software_post_with_http_info(software, async_req=True) >>> result = thread.get()

Parameters

• software (SoftwarePost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• 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

SoftwareResponse If the method is called asynchronously, returns the request thread.

api232_software_versions_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SoftwareVersionsGetResponse

List software versions

Displays a list of software versions. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_software_versions_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, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

SoftwareVersionsGetResponse If the method is called asynchronously, returns the request thread.

pypureclient.flasharray.FA_2_32.api.subnets_api module

FlashArray REST API

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: 2.32

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.flasharray.FA_2_32.api.subnets_api.SubnetsApi(api_client)

Bases: object

api232_subnets_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, 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 subnet

Deletes subnets. A subnet can only be deleted if it has no interfaces. Interfaces must be removed by using the network-interfaces endpoint. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_subnets_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, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• 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.

api232_subnets_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, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SubnetGetResponse

List subnets

Displays a list of subnets with statuses and attributes. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_subnets_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, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

SubnetGetResponse If the method is called asynchronously, returns the request thread.

api232_subnets_patch_with_http_info(subnet: Optional[SubnetPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SubnetResponse

Modify subnet

Modifies one or more specified subnet properties. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_subnets_patch_with_http_info(subnet, async_req=True) >>> result = thread.get()

Parameters

• subnet (SubnetPatch) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• 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

SubnetResponse If the method is called asynchronously, returns the request thread.

api232_subnets_post_with_http_info(names: Optional[List[str]] = None, subnet: Optional[SubnetPost] = None, authorization: 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) → SubnetResponse

Create subnet

Creates a subnet with the specified parameters. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_subnets_post_with_http_info(names, subnet, async_req=True) >>> result = thread.get()

Parameters

• names (list[str]) – Performs the operation on the unique name specified. For example, name01. Enter multiple names in comma-separated format. (required)

• subnet (SubnetPost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• 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

SubnetResponse If the method is called asynchronously, returns the request thread.

pypureclient.flasharray.FA_2_32.api.subscription_assets_api module

FlashArray REST API

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: 2.32

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.flasharray.FA_2_32.api.subscription_assets_api.SubscriptionAssetsApi(api_client)

Bases: object

api232_subscription_assets_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, names: Optional[List[str]] = None, ids: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SubscriptionAssetGetResponse

List subscription assets

Displays information about subscription assets. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_subscription_assets_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, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

SubscriptionAssetGetResponse If the method is called asynchronously, returns the request thread.

pypureclient.flasharray.FA_2_32.api.subscriptions_api module

FlashArray REST API

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: 2.32

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.flasharray.FA_2_32.api.subscriptions_api.SubscriptionsApi(api_client)

Bases: object

api232_subscriptions_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, ids: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SubscriptionGetResponse

List subscriptions

Displays information about subscriptions. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_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, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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.flasharray.FA_2_32.api.support_api module

FlashArray REST API

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: 2.32

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.flasharray.FA_2_32.api.support_api.SupportApi(api_client)

Bases: object

api232_support_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, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SupportGetResponse

List connection paths

Displays connection paths between the current array and each connected array. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_support_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, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

SupportGetResponse If the method is called asynchronously, returns the request thread.

api232_support_patch_with_http_info(support: Optional[SupportPatch] = None, authorization: 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) → SupportResponse

Create connection path

Creates a connection path from the array to another array. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_support_patch_with_http_info(support, async_req=True) >>> result = thread.get()

Parameters

• support (SupportPatch) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• 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

SupportResponse If the method is called asynchronously, returns the request thread.

api232_support_test_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, test_type: Optional[str] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → TestResultGetResponse

List Pure Storage Support connection data

Displays information about whether the array can connect to Pure Storage Support by establishing a secure shell or secure HTTP connection and verifies that messages can be exchanged. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_support_test_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, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• test_type (str) – Specifies the type of test. Valid values are all, phonehome, and remote-assist. If not specified, defaults to all.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

TestResultGetResponse If the method is called asynchronously, returns the request thread.

pypureclient.flasharray.FA_2_32.api.syslog_api module

FlashArray REST API

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: 2.32

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.flasharray.FA_2_32.api.syslog_api.SyslogApi(api_client)

Bases: object

api232_syslog_servers_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, 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 syslog server

Deletes a configured syslog server and stop forwarding syslog messages. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_syslog_servers_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, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• 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.

api232_syslog_servers_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, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SyslogServerGetResponse

List syslog servers

Displays a list of configured syslog servers. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_syslog_servers_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, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

SyslogServerGetResponse If the method is called asynchronously, returns the request thread.

api232_syslog_servers_patch_with_http_info(syslog_server: Optional[SyslogServer] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SyslogServerResponse

Modify syslog server

Modifies the URI of a configured syslog server. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_syslog_servers_patch_with_http_info(syslog_server, async_req=True) >>> result = thread.get()

Parameters

• syslog_server (SyslogServer) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• 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

SyslogServerResponse If the method is called asynchronously, returns the request thread.

api232_syslog_servers_post_with_http_info(syslog_server: Optional[SyslogServer] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SyslogServerResponse

Create syslog server

Creates a new syslog server. Transmission of syslog messages is enabled immediately. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_syslog_servers_post_with_http_info(syslog_server, async_req=True) >>> result = thread.get()

Parameters

• syslog_server (SyslogServer) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• 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

SyslogServerResponse If the method is called asynchronously, returns the request thread.

api232_syslog_servers_settings_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SyslogServerSettingsGetResponse

List syslog settings

Displays syslog settings. Values include continuation_token, items, more_items_remaining, and total_item_count. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_syslog_servers_settings_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, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

SyslogServerSettingsGetResponse If the method is called asynchronously, returns the request thread.

api232_syslog_servers_settings_patch_with_http_info(syslog_server_settings: Optional[SyslogServerSettings] = None, authorization: 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) → SyslogServerSettingsResponse

Modify syslog settings

Modifies syslog settings. Values include continuation_token, items, more_items_remaining, and total_item_count. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_syslog_servers_settings_patch_with_http_info(syslog_server_settings, async_req=True) >>> result = thread.get()

Parameters

• syslog_server_settings (SyslogServerSettings) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• 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

SyslogServerSettingsResponse If the method is called asynchronously, returns the request thread.

api232_syslog_servers_test_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → TestResultWithResourceGetResponse

List syslog server test results

Displays syslog server test results, which indicate whether the syslog is working and configured correctly. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_syslog_servers_test_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, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

TestResultWithResourceGetResponse If the method is called asynchronously, returns the request thread.

pypureclient.flasharray.FA_2_32.api.vchosts_api module

FlashArray REST API

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: 2.32

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.flasharray.FA_2_32.api.vchosts_api.VchostsApi(api_client)

Bases: object

api232_vchosts_certificates_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, vchost_names: Optional[List[str]] = None, vchost_ids: Optional[List[str]] = None, certificate_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 a vchost certificate

Deletes an existing vchost certificate. The ids query parameter alone, or the certificate_names query parameter together with one of vchost_names or vchost_ids, is required. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_vchosts_certificates_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, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• vchost_names (list[str]) – Performs the operation on the unique vchost name specified. Enter multiple names in a comma-separated format. For example, vchost01,vchost02.

• vchost_ids (list[str]) – Performs the operation on the unique vchost IDs specified. Enter multiple vchost IDs in a comma-separated format. For example, vchostid01,vchostid02.

• certificate_names (list[str]) – The names of one or more certificates. Enter multiple names in comma-separated format. For example, cert01,cert02.

• 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.

api232_vchosts_certificates_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, ids: Optional[List[str]] = None, vchost_names: Optional[List[str]] = None, vchost_ids: Optional[List[str]] = None, certificate_names: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → VchostCertificateGetResponse

List vchost certificates

Displays certificates that are attached to configured vchosts on at least one endpoint. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_vchosts_certificates_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, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• vchost_names (list[str]) – Performs the operation on the unique vchost name specified. Enter multiple names in a comma-separated format. For example, vchost01,vchost02.

• vchost_ids (list[str]) – Performs the operation on the unique vchost IDs specified. Enter multiple vchost IDs in a comma-separated format. For example, vchostid01,vchostid02.

• certificate_names (list[str]) – The names of one or more certificates. Enter multiple names in comma-separated format. For example, cert01,cert02.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

VchostCertificateGetResponse If the method is called asynchronously, returns the request thread.

api232_vchosts_certificates_patch_with_http_info(certificate: Optional[VchostCertificatePatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, vchost_names: Optional[List[str]] = None, vchost_ids: Optional[List[str]] = None, certificate_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → VchostCertificateResponse

Modify a vchost certificate

Modifies an existing vchost certificate. The ids query parameter alone, or the certificate_names query parameter together with one of vchost_names or vchost_ids, is required. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_vchosts_certificates_patch_with_http_info(certificate, async_req=True) >>> result = thread.get()

Parameters

• certificate (VchostCertificatePatch) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• vchost_names (list[str]) – Performs the operation on the unique vchost name specified. Enter multiple names in a comma-separated format. For example, vchost01,vchost02.

• vchost_ids (list[str]) – Performs the operation on the unique vchost IDs specified. Enter multiple vchost IDs in a comma-separated format. For example, vchostid01,vchostid02.

• certificate_names (list[str]) – The names of one or more certificates. Enter multiple names in comma-separated format. For example, cert01,cert02.

• 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

VchostCertificateResponse If the method is called asynchronously, returns the request thread.

api232_vchosts_certificates_post_with_http_info(certificate: Optional[VchostCertificatePost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, vchost_names: Optional[List[str]] = None, vchost_ids: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → VchostCertificateResponse

Create a vchost certificate

Creates an association between a certificate and vchost on one or more endpoints. The vchost_names or vchost_ids query parameter is required. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_vchosts_certificates_post_with_http_info(certificate, async_req=True) >>> result = thread.get()

Parameters

• certificate (VchostCertificatePost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• vchost_names (list[str]) – Performs the operation on the unique vchost name specified. Enter multiple names in a comma-separated format. For example, vchost01,vchost02.

• vchost_ids (list[str]) – Performs the operation on the unique vchost IDs specified. Enter multiple vchost IDs in a comma-separated format. For example, vchostid01,vchostid02.

• 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

VchostCertificateResponse If the method is called asynchronously, returns the request thread.

api232_vchosts_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, ids: 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 a vchost

Deletes an existing vchost. The names or ids query parameter is required. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_vchosts_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, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• 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.

api232_vchosts_endpoints_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, vchost_names: Optional[List[str]] = None, vchost_ids: Optional[List[str]] = None, endpoints: 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 a vchost endpoint

Deletes an existing vchost endpoint The ids query parameter alone, or the endpoints query parameter together with one of vchost_names or vchost_ids, is required. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_vchosts_endpoints_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, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• vchost_names (list[str]) – Performs the operation on the unique vchost name specified. Enter multiple names in a comma-separated format. For example, vchost01,vchost02.

• vchost_ids (list[str]) – Performs the operation on the unique vchost IDs specified. Enter multiple vchost IDs in a comma-separated format. For example, vchostid01,vchostid02.

• endpoints (list[str]) – Performs the operation on the unique endpoints specified. Enter multiple endpoints in a comma-separated format.

• 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.

api232_vchosts_endpoints_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, ids: Optional[List[str]] = None, vchost_names: Optional[List[str]] = None, vchost_ids: Optional[List[str]] = None, endpoints: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → VchostEndpointGetResponse

List vchost endpoints

Displays a list of vchost endpoints with their associated vchosts and certificates. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_vchosts_endpoints_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, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• vchost_names (list[str]) – Performs the operation on the unique vchost name specified. Enter multiple names in a comma-separated format. For example, vchost01,vchost02.

• vchost_ids (list[str]) – Performs the operation on the unique vchost IDs specified. Enter multiple vchost IDs in a comma-separated format. For example, vchostid01,vchostid02.

• endpoints (list[str]) – Performs the operation on the unique endpoints specified. Enter multiple endpoints in a comma-separated format.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

VchostEndpointGetResponse If the method is called asynchronously, returns the request thread.

api232_vchosts_endpoints_patch_with_http_info(endpoint: Optional[VchostEndpointPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, vchost_names: Optional[List[str]] = None, vchost_ids: Optional[List[str]] = None, endpoints: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → VchostEndpointResponse

Modify a vchost endpoint

Modifies an existing vchost endpoint. The ids query parameter alone, or the endpoints query parameter together with one of vchost_names or vchost_ids, is required. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_vchosts_endpoints_patch_with_http_info(endpoint, async_req=True) >>> result = thread.get()

Parameters

• endpoint (VchostEndpointPatch) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• vchost_names (list[str]) – Performs the operation on the unique vchost name specified. Enter multiple names in a comma-separated format. For example, vchost01,vchost02.

• vchost_ids (list[str]) – Performs the operation on the unique vchost IDs specified. Enter multiple vchost IDs in a comma-separated format. For example, vchostid01,vchostid02.

• endpoints (list[str]) – Performs the operation on the unique endpoints specified. Enter multiple endpoints in a comma-separated format.

• 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

VchostEndpointResponse If the method is called asynchronously, returns the request thread.

api232_vchosts_endpoints_post_with_http_info(endpoint: Optional[VchostEndpointPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, vchost_names: Optional[List[str]] = None, vchost_ids: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → VchostEndpointResponse

Create a vchost endpoint

Creates a vchost endpoint. Either the vchost_names or vchost_ids query parameter is required. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_vchosts_endpoints_post_with_http_info(endpoint, async_req=True) >>> result = thread.get()

Parameters

• endpoint (VchostEndpointPost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• vchost_names (list[str]) – Performs the operation on the unique vchost name specified. Enter multiple names in a comma-separated format. For example, vchost01,vchost02.

• vchost_ids (list[str]) – Performs the operation on the unique vchost IDs specified. Enter multiple vchost IDs in a comma-separated format. For example, vchostid01,vchostid02.

• 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

VchostEndpointResponse If the method is called asynchronously, returns the request thread.

api232_vchosts_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, names: Optional[List[str]] = None, ids: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → VchostGetResponse

List vchosts

Displays a list of vchosts. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_vchosts_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, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

VchostGetResponse If the method is called asynchronously, returns the request thread.

api232_vchosts_patch_with_http_info(vchost: Optional[VchostPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, ids: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → VchostResponse

Modify a vchost

Modifies an existing vchost. The names or ids query parameter is required. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_vchosts_patch_with_http_info(vchost, async_req=True) >>> result = thread.get()

Parameters

• vchost (VchostPatch) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• 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

VchostResponse If the method is called asynchronously, returns the request thread.

api232_vchosts_post_with_http_info(vchost: Optional[VchostPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → VchostResponse

Create a vchost

Creates a vchost. The names query parameter is required. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_vchosts_post_with_http_info(vchost, async_req=True) >>> result = thread.get()

Parameters

• vchost (VchostPost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• 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

VchostResponse If the method is called asynchronously, returns the request thread.

pypureclient.flasharray.FA_2_32.api.virtual_machines_api module

FlashArray REST API

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: 2.32

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.flasharray.FA_2_32.api.virtual_machines_api.VirtualMachinesApi(api_client)

Bases: object

api232_virtual_machine_snapshots_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, vm_type: Optional[str] = None, vm_ids: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → VirtualMachineGetResponse

List Virtual Machine Snapshots

Displays a list of virtual machine snapshots, including those pending eradication. If vm_type is vvol, the recovery_context in the response will represent a protection group snapshot containing the virtual machine. This must be used as the source in the POST /virtual-machine method when recovering or overwriting a virtual machine from a snapshot. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_virtual_machine_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, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• vm_type (str) – The type of virtual machine. The only valid value is vvol.

• vm_ids (list[str]) – Performs the operation on the unique virtual machine IDs specified. Enter multiple resource IDs in a comma-separated format.

• 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

VirtualMachineGetResponse If the method is called asynchronously, returns the request thread.

api232_virtual_machines_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, vm_type: Optional[str] = None, vm_ids: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → VirtualMachineGetResponse

List Virtual Machines

Displays a list of virtual machines, including those pending eradication. If vm_type is vvol, the recovery_context in the response will represent the most recent snapshot of the config vVol. This must be used as the source in the PATCH method when recovering a virtual machine from the destroyed state. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_virtual_machines_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, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• vm_type (str) – The type of virtual machine. The only valid value is vvol.

• vm_ids (list[str]) – Performs the operation on the unique virtual machine IDs specified. Enter multiple virtual machine IDs in a comma-separated format.

• 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

VirtualMachineGetResponse If the method is called asynchronously, returns the request thread.

api232_virtual_machines_patch_with_http_info(virtual_machine: Optional[VirtualMachinePost] = None, authorization: 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) → VirtualMachineResponse

Update a virtual machine

Updates a virtual machine, recovering it from the destroyed state. If the virtual machine is of type vvol, the source property of the request body must be a recovery_context value retrieved from the GET /virtual-machines endpoint. If recovering the virtual machine will cause a conflict with an existing virtual machine, the operation will fail. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_virtual_machines_patch_with_http_info(virtual_machine, async_req=True) >>> result = thread.get()

Parameters

• virtual_machine (VirtualMachinePost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• 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

VirtualMachineResponse If the method is called asynchronously, returns the request thread.

api232_virtual_machines_post_with_http_info(virtual_machine: Optional[VirtualMachinePost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, overwrite: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → VirtualMachineResponse

Create a virtual machine

Creates one or more virtual machines from a protection group snapshot. If the virtual machine is of type vvol, the source property of the request body must be a recovery_context value retrieved from the GET /virtual-machine-snapshots endpoint. If overwrite is specified, an existing virtual machine will have its volumes overwritten by the snapshot. Otherwise, a new virtual machine will be created from the snapshot. If creating the new virtual machine will cause a conflict with an existing virtual machine, the operation will fail. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_virtual_machines_post_with_http_info(virtual_machine, async_req=True) >>> result = thread.get()

Parameters

• virtual_machine (VirtualMachinePost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• overwrite (bool) – If set to true, overwrites an existing object during an object copy operation. If set to false or not set at all and the target name is an existing object, the copy operation fails. Required if the source body parameter is set and the source overwrites an existing object during the copy operation.

• 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

VirtualMachineResponse If the method is called asynchronously, returns the request thread.

pypureclient.flasharray.FA_2_32.api.volume_groups_api module

FlashArray REST API

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: 2.32

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.flasharray.FA_2_32.api.volume_groups_api.VolumeGroupsApi(api_client)

Bases: object

api232_volume_groups_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, eradicate_contents: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Delete a volume group

Deletes a volume group that has been destroyed and is pending eradication. Eradicated volume groups cannot be recovered. Volume groups are destroyed through the PATCH method. The ids or names parameter is required, but they cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_volume_groups_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, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• eradicate_contents (bool) – Set to true to eradicate contents (e.g., volumes, protection groups, snapshots) and containers (e.g., pods, volume groups). This enables you to eradicate containers with contents.

• 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.

api232_volume_groups_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = 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, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → VolumeGroupGetResponse

List volume groups

Displays a list of volume groups, including those pending eradication. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_volume_groups_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, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• 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

VolumeGroupGetResponse If the method is called asynchronously, returns the request thread.

api232_volume_groups_patch_with_http_info(volume_group: Optional[VolumeGroupPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, destroy_contents: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → VolumeGroupResponse

Modify a volume group

Modifies a volume group. You can rename, destroy, recover, or set QoS limits for a volume group. To rename a volume group, set name to the new name. To destroy a volume group, set destroyed=true. To recover a volume group that has been destroyed and is pending eradication, set destroyed=false. Sets the bandwidth and IOPs limits of a volume group through the respective bandwidth_limit and iops_limit parameter. The ids or names parameter is required, but they cannot be set together. Sets the priority adjustment for a volume group using the priority_adjustment_operator and priority_adjustment_value fields. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_volume_groups_patch_with_http_info(volume_group, async_req=True) >>> result = thread.get()

Parameters

• volume_group (VolumeGroupPatch) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• destroy_contents (bool) – Set to true to destroy contents (e.g., volumes, protection groups, snapshots) and containers (e.g., pods, volume groups). This enables you to destroy containers with contents.

• 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

VolumeGroupResponse If the method is called asynchronously, returns the request thread.

api232_volume_groups_performance_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, end_time: Optional[int] = None, resolution: Optional[int] = None, start_time: Optional[int] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ResourcePerformanceGetResponse

List volume group performance data

Returns real-time and historical performance data, real-time latency data, and average I/O sizes for each volume group and and as a total of all volume groups across the entire array. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_volume_groups_performance_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, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• 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

ResourcePerformanceGetResponse If the method is called asynchronously, returns the request thread.

api232_volume_groups_post_with_http_info(volume_group: Optional[VolumeGroupPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → VolumeGroupResponse

Create a volume group

Creates a volume group. The volume group itself does not contain any meaningful content; instead, it acts as a container that is used to organize volumes. Once a volume group has been created, volumes can be created inside the volume group or moved into and out of the volume group. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_volume_groups_post_with_http_info(volume_group, async_req=True) >>> result = thread.get()

Parameters

• volume_group (VolumeGroupPost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• 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

VolumeGroupResponse If the method is called asynchronously, returns the request thread.

api232_volume_groups_space_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, end_time: Optional[int] = None, resolution: Optional[int] = None, start_time: Optional[int] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ResourceSpaceGetResponse

List volume group space information

Displays the provisioned size and physical storage consumption data for each volume group. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_volume_groups_space_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, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• 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

ResourceSpaceGetResponse If the method is called asynchronously, returns the request thread.

api232_volume_groups_volumes_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, group_ids: Optional[List[str]] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, group_names: Optional[List[str]] = None, member_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → MemberGetResponse

List volume groups with volumes

Returns a list of volume groups that contain volumes. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_volume_groups_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, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• group_ids (list[str]) – A comma-separated list of group IDs.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (list[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• group_names (list[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• 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

MemberGetResponse If the method is called asynchronously, returns the request thread.

pypureclient.flasharray.FA_2_32.api.volume_snapshots_api module

FlashArray REST API

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: 2.32

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.flasharray.FA_2_32.api.volume_snapshots_api.VolumeSnapshotsApi(api_client)

Bases: object

api232_volume_snapshots_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, replication_snapshot: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Delete a volume snapshot

Deletes a volume snapshot that has been destroyed and is pending eradication. Eradicated volume snapshots cannot be recovered. Volume snapshots are destroyed by using the PATCH method. The ids or names parameter is required, but they cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_volume_snapshots_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, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• replication_snapshot (bool) – If set to true, allow destruction/eradication of snapshots in use by replication. If set to false, allow destruction/eradication of snapshots not in use by replication. If not specified, defaults to false.

• 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.

api232_volume_snapshots_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = 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, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → VolumeSnapshotGetResponse

List volume snapshots

Displays a list of volume snapshots, including those pending eradication. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_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, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• source_ids (list[str]) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

• source_names (list[str]) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• 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.

api232_volume_snapshots_patch_with_http_info(volume_snapshot: Optional[VolumeSnapshotPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, replication_snapshot: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → VolumeSnapshotResponse

Modify a volume snapshot

Modifies a volume snapshot by renaming, destroying, or recovering it. To rename the suffix of a volume snapshot, set name to the new suffix name. To recover a volume snapshot that has been destroyed and is pending eradication, set destroyed=true. The ids or names parameter is required, but they cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_volume_snapshots_patch_with_http_info(volume_snapshot, async_req=True) >>> result = thread.get()

Parameters

• volume_snapshot (VolumeSnapshotPatch) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• replication_snapshot (bool) – If set to true, allow destruction/eradication of snapshots in use by replication. If set to false, allow destruction/eradication of snapshots not in use by replication. If not specified, defaults to false.

• 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

VolumeSnapshotResponse If the method is called asynchronously, returns the request thread.

api232_volume_snapshots_post_with_http_info(volume_snapshot: Optional[VolumeSnapshotPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, on: Optional[str] = None, allow_throttle: Optional[bool] = 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) → VolumeSnapshotResponse

Create a volume snapshot

Creates a point-in-time snapshot of the contents of a volume. The source_ids or source_names parameter is required, but they cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_volume_snapshots_post_with_http_info(volume_snapshot, async_req=True) >>> result = thread.get()

Parameters

• volume_snapshot (VolumeSnapshotPost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• on (str) – Performs the operation on the target name specified. For example, targetName01.

• allow_throttle (bool) – If set to true, allows snapshot to fail if array health is not optimal.

• source_ids (list[str]) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

• source_names (list[str]) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

• 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

VolumeSnapshotResponse If the method is called asynchronously, returns the request thread.

api232_volume_snapshots_tags_batch_put_with_http_info(tag: Optional[List[Tag]] = None, authorization: Optional[str] = None, x_request_id: Optional[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

Update tags

Updates tags. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_volume_snapshots_tags_batch_put_with_http_info(tag, async_req=True) >>> result = thread.get()

Parameters

• tag (list[Tag]) – A list of tags to be created or modified. (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• resource_ids (list[str]) – A comma-separated list of resource IDs. The resource_ids or resource_names parameter is required, but they cannot be set together.

• resource_names (list[str]) – A comma-separated list of resource names. The resource_ids or resource_names parameter is required, but they cannot be set together.

• 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.

api232_volume_snapshots_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 tags

Deletes specified tags. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_volume_snapshots_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, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• keys (list[str]) – A comma-separated list of tag keys.

• namespaces (list[str]) – A comma-separated list of namespaces. Only one namespace is allowed per delete request.

• resource_ids (list[str]) – A comma-separated list of resource IDs. The resource_ids or resource_names parameter is required, but they cannot be set together.

• resource_names (list[str]) – A comma-separated list of resource names. The resource_ids or resource_names parameter is required, but they cannot be set together.

• 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.

api232_volume_snapshots_tags_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, namespaces: Optional[List[str]] = None, offset: Optional[int] = None, resource_destroyed: Optional[bool] = None, resource_ids: Optional[List[str]] = None, resource_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → TagGetResponse

List tags

Displays the list of tags. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_volume_snapshots_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, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• namespaces (list[str]) – A comma-separated list of namespaces.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• resource_destroyed (bool) – If set to true, returns only objects from destroyed resources. Returns an error if the name of a live resource is specified in the resource_names query parameter. If set to false, returns only objects from live resources. Returns an error if the name of a destroyed resource is specified in the resource_names query parameter.

• resource_ids (list[str]) – A comma-separated list of resource IDs. The resource_ids or resource_names parameter is required, but they cannot be set together.

• resource_names (list[str]) – A comma-separated list of resource names. The resource_ids or resource_names parameter is required, but they cannot be set together.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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.

api232_volume_snapshots_test_post_with_http_info(volume_snapshot: Optional[VolumeSnapshotPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, on: Optional[str] = None, allow_throttle: Optional[bool] = 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) → TestResultWithResourcePostResponse

Create the volume snapshot path

Creates the volume snapshot path without actually taking a volume snapshot. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_volume_snapshots_test_post_with_http_info(volume_snapshot, async_req=True) >>> result = thread.get()

Parameters

• volume_snapshot (VolumeSnapshotPost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• on (str) – Performs the operation on the target name specified. For example, targetName01.

• allow_throttle (bool) – If set to true, allows snapshot to fail if array health is not optimal.

• source_ids (list[str]) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

• source_names (list[str]) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

• 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

TestResultWithResourcePostResponse If the method is called asynchronously, returns the request thread.

api232_volume_snapshots_transfer_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, source_ids: Optional[List[str]] = None, source_names: Optional[List[str]] = None, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → VolumeSnapshotTransferGetResponse

List volume snapshots with transfer statistics

Displays a list of volume snapshots and their transfer statistics. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_volume_snapshots_transfer_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, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• source_ids (list[str]) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

• source_names (list[str]) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• 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

VolumeSnapshotTransferGetResponse If the method is called asynchronously, returns the request thread.

pypureclient.flasharray.FA_2_32.api.volumes_api module

FlashArray REST API

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: 2.32

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.flasharray.FA_2_32.api.volumes_api.VolumesApi(api_client)

Bases: object

api232_volumes_batch_post_with_http_info(volume: Optional[List[VolumeBatchPost]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, allow_throttle: Optional[bool] = None, overwrite: Optional[bool] = None, with_default_protection: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → VolumesBatchResponse

Create or copy volumes and upsert tags

Creates or copies virtual storage volumes of different sizes in different vgroups and upserts tags. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_volumes_batch_post_with_http_info(volume, async_req=True) >>> result = thread.get()

Parameters

• volume (list[VolumeBatchPost]) – A list of volumes to be created or copied. (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_throttle (bool) – If set to true, allows operation to fail if array health is not optimal.

• overwrite (bool) – If set to true, overwrites an existing object during an object copy operation. If set to false or not set at all and the target name is an existing object, the copy operation fails. Required if the source body parameter is set and the source overwrites an existing object during the copy operation.

• with_default_protection (bool) – If specified as true, the initial protection of the newly created volumes will be the union of the container default protection configuration and add_to_protection_group_names. If specified as false, the default protection of the container will not be applied automatically. The initial protection of the newly created volumes will be configured by add_to_protection_group_names. If not specified, defaults to true.

• 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

VolumesBatchResponse If the method is called asynchronously, returns the request thread.

api232_volumes_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, 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 a volume

Deletes a volume that has been destroyed and is pending eradication. Eradicated volumes cannot be recovered. Volumes are destroyed using the PATCH method. The ids or names parameter is required, but they cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_volumes_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, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• 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.

api232_volumes_diff_get_with_http_info(segment_length: Optional[int] = None, block_size: Optional[int] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, names: Optional[List[str]] = None, ids: Optional[List[str]] = None, base_name: Optional[str] = None, base_id: Optional[str] = None, segment_offset: Optional[int] = None, next_allocated_block_hint: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → VolumesDiffGetResponse

List volume diffs

Displays block differences for the specified volumes. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_volumes_diff_get_with_http_info(segment_length, block_size, async_req=True) >>> result = thread.get()

Parameters

• segment_length (int) – Length of the segment, in bytes, to compare. (required)

• block_size (int) – Granularity at which to compare, in bytes. Must be a multiple of 512. (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• base_name (str) – Name of the volume or volume snapshot that the diff comparison is based on. If a base volume or volume snapshot is not specified, all mapped blocks for the volume or volume snapshot are displayed. The base_name or base_id parameter is required, but they cannot be set together.

• base_id (str) – ID of the volume or volume snapshot that the diff comparison is based on. If a base volume or volume snapshot is not specified, all mapped blocks for the volume or volume snapshot are displayed. The base_name or base_id parameter is required, but they cannot be set together.

• segment_offset (int) – Absolute offset, in bytes, of the segment to compare. Must be a multiple of block_size.

• next_allocated_block_hint (bool) – If set to true, appends offset of the next allocated block in bytes for the volume specified in names or ids to the output items. base_name or base_id must not be specified if this is set to true. If not specified, defaults to false.

• 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

VolumesDiffGetResponse If the method is called asynchronously, returns the request thread.

api232_volumes_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = 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, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → VolumeGetResponse

List volumes

Displays a list of volumes, including those pending eradication. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_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, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• 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.

api232_volumes_patch_with_http_info(volume: Optional[VolumePatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, add_to_protection_group_ids: Optional[List[str]] = None, add_to_protection_group_names: Optional[List[str]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, remove_from_protection_group_ids: Optional[List[str]] = None, remove_from_protection_group_names: Optional[List[str]] = None, truncate: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → VolumeResponse

Modify a volume

Modifies a volume by renaming, destroying, or resizing it. To rename a volume, set name to the new name. To destroy a volume, set destroyed=true. To recover a volume that has been destroyed and is pending eradication, set destroyed=false. Set the bandwidth and IOPs limits of a volume through the respective bandwidth_limit and iops_limit parameter. This moves the volume into a pod or volume group through the respective pod or volume_group parameter. The ids or names parameter is required, but they cannot be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_volumes_patch_with_http_info(volume, async_req=True) >>> result = thread.get()

Parameters

• volume (VolumePatch) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• add_to_protection_group_ids (list[str]) – The volumes will be added to the specified protection groups along with creation or movement across pods and array. When a volume is moved, the specified protection groups must be in the target pod or array. Enter multiple ids in comma-separated format.

• add_to_protection_group_names (list[str]) – The volumes will be added to the specified protection groups along with creation or movement across pods and array. When a volume is moved, the specified protection groups must be in the target pod or array. Enter multiple names in a comma-separated format.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• remove_from_protection_group_ids (list[str]) – The volumes will be removed from the specified protection groups in the source pod or array along with the move. This can only be used when moving volumes across pods and arrays and must include all protection groups that the volumes are members of before the move. Enter multiple ids in a comma-separated format.

• remove_from_protection_group_names (list[str]) – The volumes will be removed from the specified protection groups in the source pod or array along with the move. This can only be used when moving volumes across pods and arrays and must include all protection groups that the volumes are members of before the move. Enter multiple names in a comma-separated format.

• truncate (bool) – If set to true, reduces the size of a volume during a volume resize operation. When a volume is truncated, Purity automatically takes an undo snapshot, providing a 24-hour window during which the previous contents can be retrieved. After truncating a volume, its provisioned size can be subsequently increased, but the data in truncated sectors cannot be retrieved. If set to false or not set at all and the volume is being reduced in size, the volume copy operation fails. Required if the provisioned parameter is set to a volume size that is smaller than the original size.

• 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

VolumeResponse If the method is called asynchronously, returns the request thread.

api232_volumes_performance_by_array_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, end_time: Optional[int] = None, resolution: Optional[int] = None, start_time: Optional[int] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ResourcePerformanceByArrayGetResponse

List volume performance data by array

Return real-time and historical performance data, real-time latency data, and average I/O size data. The data returned is for each volume on the current array and for each volume on any remote arrays that are visible to the current array. The data is grouped by individual volumes and as a total across all volumes on each array. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_volumes_performance_by_array_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, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• 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

ResourcePerformanceByArrayGetResponse If the method is called asynchronously, returns the request thread.

api232_volumes_performance_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, end_time: Optional[int] = None, resolution: Optional[int] = None, start_time: Optional[int] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ResourcePerformanceGetResponse

List volume performance data

Returns real-time and historical performance data, real-time latency data, and average I/O sizes for each volume and and as a total of all volumes across the entire array. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_volumes_performance_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, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• 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

ResourcePerformanceGetResponse If the method is called asynchronously, returns the request thread.

api232_volumes_post_with_http_info(volume: Optional[VolumePost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, add_to_protection_group_ids: Optional[List[str]] = None, add_to_protection_group_names: Optional[List[str]] = None, allow_throttle: Optional[bool] = None, names: Optional[List[str]] = None, overwrite: Optional[bool] = None, with_default_protection: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → VolumeResponse

Create a volume

Creates one or more virtual storage volumes of the specified size. If provisioned is not specified, the size of the new volume defaults to 1 MB. The names query parameter is required. The add_to_protection_group_names query parameter specifies a list of protection group names that will compose the initial protection for the volume. The with_default_protection query parameter specifies whether to use the container default protection configuration for the volume. The add_to_protection_group_names and with_default_protection query parameters cannot be provided when overwrite is true. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_volumes_post_with_http_info(volume, async_req=True) >>> result = thread.get()

Parameters

• volume (VolumePost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• add_to_protection_group_ids (list[str]) – The volumes will be added to the specified protection groups along with creation or movement across pods and array. When a volume is moved, the specified protection groups must be in the target pod or array. Enter multiple ids in comma-separated format.

• add_to_protection_group_names (list[str]) – The volumes will be added to the specified protection groups along with creation or movement across pods and array. When a volume is moved, the specified protection groups must be in the target pod or array. Enter multiple names in a comma-separated format.

• allow_throttle (bool) – If set to true, allows operation to fail if array health is not optimal.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• overwrite (bool) – If set to true, overwrites an existing object during an object copy operation. If set to false or not set at all and the target name is an existing object, the copy operation fails. Required if the source body parameter is set and the source overwrites an existing object during the copy operation.

• with_default_protection (bool) – If specified as true, the initial protection of the newly created volumes will be the union of the container default protection configuration and add_to_protection_group_names. If specified as false, the default protection of the container will not be applied automatically. The initial protection of the newly created volumes will be configured by add_to_protection_group_names. If not specified, defaults to true.

• 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

VolumeResponse If the method is called asynchronously, returns the request thread.

api232_volumes_protection_groups_delete_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, group_ids: Optional[List[str]] = None, group_names: Optional[List[str]] = None, member_names: Optional[List[str]] = None, member_ids: 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 a volume from a protection group

Deletes a volume member from a protection group. After the member has been deleted, it is no longer protected by the group. Any protection group snapshots that were taken before the member was deleted are not affected. Deleting a member from a protection group does not delete the member from the array, and the member can be added back to the protection group at any time. The group_names parameter represents the name of the protection group, and the member_names and member_ids parameters represent the names or IDs of the volume. The group_names and only one of member_names or member_ids parameters are required and must be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_volumes_protection_groups_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, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• group_ids (list[str]) – A comma-separated list of group IDs.

• group_names (list[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_ids (list[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• 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.

api232_volumes_protection_groups_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, group_ids: Optional[List[str]] = None, group_names: Optional[List[str]] = None, limit: Optional[int] = None, member_destroyed: Optional[bool] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ProtectionGroupsVolumesGetResponse

List volumes that are members of protection groups

Displays a list of volume members that belong to one or more protection groups. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_volumes_protection_groups_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, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• group_ids (list[str]) – A comma-separated list of group IDs.

• group_names (list[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_destroyed (bool) – If true, returns only destroyed member objects. Returns an error if a name of a live member object is specified in the member_names query param. If false, returns only live member objects. Returns an error if a name of a destroyed member object is specified in the member_names query param.

• member_ids (list[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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

ProtectionGroupsVolumesGetResponse If the method is called asynchronously, returns the request thread.

api232_volumes_protection_groups_post_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, group_ids: Optional[List[str]] = None, group_names: Optional[List[str]] = None, member_names: Optional[List[str]] = None, member_ids: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ProtectionGroupsVolumesResponse

Create a volume and add it to a protection group

Creates a volume member and adds it to a protection group. Members that are already in the protection group are not affected. For asynchronous replication, only members of the same type can belong to a protection group. The group_names parameter represents the name of the protection group, and the member_names and member_ids parameters represent the names or IDs of the volume. The group_names and only one of member_names or member_ids parameters are required and must be set together. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_volumes_protection_groups_post_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, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• group_ids (list[str]) – A comma-separated list of group IDs.

• group_names (list[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_ids (list[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• 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

ProtectionGroupsVolumesResponse If the method is called asynchronously, returns the request thread.

api232_volumes_space_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, end_time: Optional[int] = None, resolution: Optional[int] = None, start_time: Optional[int] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → VolumeSpaceGetResponse

List volume space information

Displays the provisioned size and physical storage consumption data for each volume. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_volumes_space_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, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• ids (list[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• 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

VolumeSpaceGetResponse If the method is called asynchronously, returns the request thread.

api232_volumes_tags_batch_put_with_http_info(tag: Optional[List[Tag]] = None, authorization: Optional[str] = None, x_request_id: Optional[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

Update tags

Updates tags. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_volumes_tags_batch_put_with_http_info(tag, async_req=True) >>> result = thread.get()

Parameters

• tag (list[Tag]) – A list of tags to be created or, if already existing, updated. (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• resource_ids (list[str]) – A comma-separated list of resource IDs. The resource_ids or resource_names parameter is required, but they cannot be set together.

• resource_names (list[str]) – A comma-separated list of resource names. The resource_ids or resource_names parameter is required, but they cannot be set together.

• 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.

api232_volumes_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 tags

Deletes specified tags. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_volumes_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, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• keys (list[str]) – A comma-separated list of tag keys.

• namespaces (list[str]) – A comma-separated list of namespaces. Only one namespace is allowed per delete request.

• resource_ids (list[str]) – A comma-separated list of resource IDs. The resource_ids or resource_names parameter is required, but they cannot be set together.

• resource_names (list[str]) – A comma-separated list of resource names. The resource_ids or resource_names parameter is required, but they cannot be set together.

• 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.

api232_volumes_tags_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, namespaces: Optional[List[str]] = None, offset: Optional[int] = None, resource_destroyed: Optional[bool] = None, resource_ids: Optional[List[str]] = None, resource_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → TagGetResponse

List tags

Displays the list of tags. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_volumes_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, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• namespaces (list[str]) – A comma-separated list of namespaces.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• resource_destroyed (bool) – If set to true, returns only objects from destroyed resources. Returns an error if the name of a live resource is specified in the resource_names query parameter. If set to false, returns only objects from live resources. Returns an error if the name of a destroyed resource is specified in the resource_names query parameter.

• resource_ids (list[str]) – A comma-separated list of resource IDs. The resource_ids or resource_names parameter is required, but they cannot be set together.

• resource_names (list[str]) – A comma-separated list of resource names. The resource_ids or resource_names parameter is required, but they cannot be set together.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• 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.

api232_volumes_test_post_with_http_info(volume: Optional[VolumePost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, add_to_protection_group_ids: Optional[List[str]] = None, add_to_protection_group_names: Optional[List[str]] = None, allow_throttle: Optional[bool] = None, names: Optional[List[str]] = None, overwrite: Optional[bool] = None, with_default_protection: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → TestResultWithResourceWithIdPostResponse

Make an attempt to copy a volume

Makes an attempt to create a volume by copying it from a source volume on the local array without actually creating it, to test if the volume can be successfully created. Only available for creating a volume via a copy, not direct volume creation. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_volumes_test_post_with_http_info(volume, async_req=True) >>> result = thread.get()

Parameters

• volume (VolumePost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• add_to_protection_group_ids (list[str]) – The volumes will be added to the specified protection groups along with creation or movement across pods and array. When a volume is moved, the specified protection groups must be in the target pod or array. Enter multiple ids in comma-separated format.

• add_to_protection_group_names (list[str]) – The volumes will be added to the specified protection groups along with creation or movement across pods and array. When a volume is moved, the specified protection groups must be in the target pod or array. Enter multiple names in a comma-separated format.

• allow_throttle (bool) – If set to true, allows operation to fail if array health is not optimal.

• names (list[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• overwrite (bool) – If set to true, overwrites an existing object during an object copy operation. If set to false or not set at all and the target name is an existing object, the copy operation fails. Required if the source body parameter is set and the source overwrites an existing object during the copy operation.

• with_default_protection (bool) – If specified as true, the initial protection of the newly created volumes will be the union of the container default protection configuration and add_to_protection_group_names. If specified as false, the default protection of the container will not be applied automatically. The initial protection of the newly created volumes will be configured by add_to_protection_group_names. If not specified, defaults to true.

• 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

TestResultWithResourceWithIdPostResponse If the method is called asynchronously, returns the request thread.

api232_volumes_volume_groups_get_with_http_info(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, group_ids: Optional[List[str]] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, group_names: Optional[List[str]] = None, member_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → MemberGetResponse

List volumes that are in volume groups

Returns a list of volumes that are in a volume group. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api232_volumes_volume_groups_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, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• group_ids (list[str]) – A comma-separated list of group IDs.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (list[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (list[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• group_names (list[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• member_names (list[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• 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

MemberGetResponse If the method is called asynchronously, returns the request thread.

Module contents