pypureclient.flashblade.FB_2_8.api package

Submodules

pypureclient.flashblade.FB_2_8.api.active_directory_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.8, developed by Pure Storage, Inc. (http://www.purestorage.com/).

OpenAPI spec version: 2.8

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

class pypureclient.flashblade.FB_2_8.api.active_directory_api.ActiveDirectoryApi(api_client)

Bases: object

api28_active_directory_delete_with_http_info(ids: Optional[List[str]] = None, local_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) → None

DELETE active-directory

Delete an 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.api28_active_directory_delete_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

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

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.

api28_active_directory_get_with_http_info(continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ActiveDirectoryGetResponse

GET active-directory

List an Active Directory account and its configuration. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_active_directory_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

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

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

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

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_active_directory_patch_with_http_info(active_directory: Optional[ActiveDirectoryPatch] = 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) → ActiveDirectoryResponse

PATCH active-directory

Modify the configuration of an 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.api28_active_directory_patch_with_http_info(active_directory, async_req=True) >>> result = thread.get()

Parameters

• active_directory (ActiveDirectoryPatch) – (required)

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.

api28_active_directory_post_with_http_info(active_directory: Optional[ActiveDirectoryPost] = None, names: Optional[List[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

POST active-directory

Join an Active Directory domain and generate keytabs for the registered SPNs and supported encryption types. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_active_directory_post_with_http_info(active_directory, async_req=True) >>> result = thread.get()

Parameters

• active_directory (ActiveDirectoryPost) – (required)

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• 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 to a pre-existing account must have permissions to ‘read attributes from’ and ‘reset the password of’ the pre-existing account. service_principal_names, encryption_types, and 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.

api28_active_directory_test_get_with_http_info(filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → TestResultGetResponse

GET active-directory/test

Testing if the configuration of an Active Directory account is valid. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_active_directory_test_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

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

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

pypureclient.flashblade.FB_2_8.api.administrators_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.8, developed by Pure Storage, Inc. (http://www.purestorage.com/).

OpenAPI spec version: 2.8

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

class pypureclient.flashblade.FB_2_8.api.administrators_api.AdministratorsApi(api_client)

Bases: object

api28_admins_api_tokens_delete_with_http_info(admin_ids: Optional[List[str]] = None, admin_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 admins/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.api28_admins_api_tokens_delete_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• admin_ids (list[str]) – A comma-separated list of admin IDs. If after filtering, there is not at least one admin resource that matches each of the elements, then an error is returned. This cannot be provided together with the admin_names query parameter.

• admin_names (list[str]) – A comma-separated list of admin names. If there is not at least one admin resource that matches each of the elements, then an error is returned. This cannot be provided together with admin_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.

api28_admins_api_tokens_get_with_http_info(admin_ids: Optional[List[str]] = None, admin_names: Optional[List[str]] = None, continuation_token: Optional[str] = None, expose_api_token: Optional[bool] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → AdminApiTokenGetResponse

GET admins/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.api28_admins_api_tokens_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• admin_ids (list[str]) – A comma-separated list of admin IDs. If after filtering, there is not at least one admin resource that matches each of the elements, then an error is returned. This cannot be provided together with the admin_names query parameter.

• admin_names (list[str]) – A comma-separated list of admin names. If there is not at least one admin resource that matches each of the elements, then an error is returned. This cannot be provided together with admin_ids query parameter.

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

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

• filter (str) – Exclude resources that don’t match the specified criteria.

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

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

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

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_admins_api_tokens_post_with_http_info(admin_ids: Optional[List[str]] = None, admin_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

POST admins/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.api28_admins_api_tokens_post_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• admin_ids (list[str]) – A comma-separated list of admin IDs. If after filtering, there is not at least one admin resource that matches each of the elements, then an error is returned. This cannot be provided together with the admin_names query parameter.

• admin_names (list[str]) – A comma-separated list of admin names. If there is not at least one admin resource that matches each of the elements, then an error is returned. This cannot be provided together with admin_ids query parameter.

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

api28_admins_cache_delete_with_http_info(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 admins/cache

Delete cached administrator role information by name or ID. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_admins_cache_delete_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.

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

GET admins/cache

List cached administrator information used to determine role based access control privileges. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_admins_cache_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

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

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

• refresh (bool) – Whether to refresh the user info from directory service. If not specified, defaults to false.

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

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_admins_get_with_http_info(continuation_token: Optional[str] = None, expose_api_token: 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, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → AdminGetResponse

GET admins

List the administrator’s attributes, including the API token and public key. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_admins_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

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

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

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

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

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

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_admins_patch_with_http_info(admin: Optional[AdminPatch] = 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) → AdminResponse

PATCH admins

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

Parameters

• admin (AdminPatch) – (required)

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.

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

List global admin settings

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

Parameters

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

• filter (str) – Exclude resources that don’t match the specified criteria.

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

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

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

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_admins_settings_patch_with_http_info(admin_setting: Optional[AdminSetting] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → AdminSettingsResponse

Update global admin settings

Update properties for global admin settings. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_admins_settings_patch_with_http_info(admin_setting, async_req=True) >>> result = thread.get()

Parameters

• admin_setting (AdminSetting) – (required)

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

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.flashblade.FB_2_8.api.alert_watchers_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.8, developed by Pure Storage, Inc. (http://www.purestorage.com/).

OpenAPI spec version: 2.8

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

class pypureclient.flashblade.FB_2_8.api.alert_watchers_api.AlertWatchersApi(api_client)

Bases: object

api28_alert_watchers_delete_with_http_info(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 alert-watchers

Delete an alert watcher. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_alert_watchers_delete_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.

api28_alert_watchers_get_with_http_info(continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → AlertWatcherGetResponse

GET alert-watchers

List alert watchers that are configured to receive alert messages. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_alert_watchers_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

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

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

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

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_alert_watchers_patch_with_http_info(alert_watcher: Optional[AlertWatcher] = 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) → AlertWatcherResponse

PATCH alert-watchers

Modify an alert watcher’s configuration. Enable or disable an alert watcher privilege and select the level of alert notification of an alert watcher. Alert notification levels are info, warning, or critical. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_alert_watchers_patch_with_http_info(alert_watcher, async_req=True) >>> result = thread.get()

Parameters

• alert_watcher (AlertWatcher) – (required)

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.

api28_alert_watchers_post_with_http_info(names: Optional[List[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

POST alert-watchers

Create an alert watcher to receive array alert messages. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_alert_watchers_post_with_http_info(names, async_req=True) >>> result = thread.get()

Parameters

• names (list[str]) – A comma-separated list of resource names. (required)

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

api28_alert_watchers_test_get_with_http_info(filter: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → TestResultResponse

GET alert-watchers/test

Test an alert watcher’s contact information to verify alerts can be sent and received. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_alert_watchers_test_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

pypureclient.flashblade.FB_2_8.api.alerts_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.8, developed by Pure Storage, Inc. (http://www.purestorage.com/).

OpenAPI spec version: 2.8

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

class pypureclient.flashblade.FB_2_8.api.alerts_api.AlertsApi(api_client)

Bases: object

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

GET alerts

Returns a list of alerts which have been generated by the array. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_alerts_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

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

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

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

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_alerts_patch_with_http_info(alerts_settings: Optional[Alert] = 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

PATCH alerts

Make changes to an alert. This is currently limited to the alert’s flagged property. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_alerts_patch_with_http_info(alerts_settings, async_req=True) >>> result = thread.get()

Parameters

• alerts_settings (Alert) – (required)

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.

pypureclient.flashblade.FB_2_8.api.api_clients_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.8, developed by Pure Storage, Inc. (http://www.purestorage.com/).

OpenAPI spec version: 2.8

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

class pypureclient.flashblade.FB_2_8.api.api_clients_api.APIClientsApi(api_client)

Bases: object

api28_api_clients_delete_with_http_info(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 api-clients

Delete the API client. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_api_clients_delete_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.

api28_api_clients_get_with_http_info(continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ApiClientsResponse

GET api-clients

List an API client and its configuration attributes. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_api_clients_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

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

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

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

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_api_clients_patch_with_http_info(api_clients: Optional[ApiClient] = 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) → ApiClientsResponse

PATCH api-clients

Modify an API client. Newly created API clients can be enabled by setting the enabled parameter to true. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_api_clients_patch_with_http_info(api_clients, async_req=True) >>> result = thread.get()

Parameters

• api_clients (ApiClient) – (required)

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_api_clients_post_with_http_info(api_client: Optional[ApiClientsPost] = 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) → ApiClientsResponse

POST api-clients

Create an API client to authorize Access Token or Bearer Tokens for use on the array. Required fields include issuer, public_key, and access_token_ttl_in_ms. After creating an API client, it can only be enabled by an authorized user. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_api_clients_post_with_http_info(api_client, async_req=True) >>> result = thread.get()

Parameters

• api_client (ApiClientsPost) – (required)

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

pypureclient.flashblade.FB_2_8.api.array_connections_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.8, developed by Pure Storage, Inc. (http://www.purestorage.com/).

OpenAPI spec version: 2.8

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

class pypureclient.flashblade.FB_2_8.api.array_connections_api.ArrayConnectionsApi(api_client)

Bases: object

api28_array_connections_connection_key_get_with_http_info(continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ArrayConnectionKeyGetResponse

GET array-connections/connection-key

List connection keys used to authenticate the connection from one array to another. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_array_connections_connection_key_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

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

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

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

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_array_connections_connection_key_post_with_http_info(async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ArrayConnectionKeyResponse

POST array-connections/connection-key

Create an array connection key allowing one array to connect to another for replication. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_array_connections_connection_key_post_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_array_connections_delete_with_http_info(ids: Optional[List[str]] = None, remote_ids: Optional[List[str]] = None, remote_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

DELETE array-connections

Delete a connection to an array. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_array_connections_delete_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• 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 there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with remote_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.

api28_array_connections_get_with_http_info(continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, offset: Optional[int] = None, remote_ids: Optional[List[str]] = None, remote_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ArrayConnectionGetResponse

GET array-connections

List connected arrays for replication. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_array_connections_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

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

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

• 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 there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with remote_ids query parameter.

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

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_array_connections_patch_with_http_info(array_connection: Optional[ArrayConnection] = None, ids: Optional[List[str]] = None, remote_ids: Optional[List[str]] = None, remote_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

PATCH array-connections

Modify the configuration of 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.api28_array_connections_patch_with_http_info(array_connection, async_req=True) >>> result = thread.get()

Parameters

• array_connection (ArrayConnection) – (required)

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• 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 there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with remote_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

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

api28_array_connections_path_get_with_http_info(continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, offset: Optional[int] = None, remote_ids: Optional[List[str]] = None, remote_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ArrayConnectionPathGetResponse

GET array-connections/path

List network path details 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.api28_array_connections_path_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

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

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

• 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 there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with remote_ids query parameter.

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

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_array_connections_performance_replication_get_with_http_info(continuation_token: Optional[str] = None, end_time: Optional[int] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, offset: Optional[int] = None, remote_ids: Optional[List[str]] = None, remote_names: Optional[List[str]] = None, resolution: Optional[int] = None, sort: Optional[List[str]] = None, start_time: Optional[int] = None, total_only: Optional[bool] = None, type: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ConnectionRelationshipPerformanceReplicationGetResp

GET array-connections/performance/replication

List performance metrics of file systems or objects being replicated from one array to another. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_array_connections_performance_replication_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• end_time (int) – When the time window ends (in milliseconds since epoch).

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

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

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

• 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 there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with remote_ids query parameter.

• resolution (int) – The desired ms between samples. Available resolutions may depend on data type, start_time and end_time. In general 1000, 30000, 300000, 1800000, 7200000, and 86400000 are possible values.

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

• start_time (int) – When the time window starts (in milliseconds since epoch).

• total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. The items list will be empty.

• type (str) – Display the metric of a specified object type. Valid values are all, file-system, and object-store. If not specified, defaults to all.

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_array_connections_post_with_http_info(array_connection: Optional[ArrayConnectionPost] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ArrayConnectionResponse

POST array-connections

Create a connection to an array for replication and configure network settings. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_array_connections_post_with_http_info(array_connection, async_req=True) >>> result = thread.get()

Parameters

• array_connection (ArrayConnectionPost) – (required)

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

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.flashblade.FB_2_8.api.arrays_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.8, developed by Pure Storage, Inc. (http://www.purestorage.com/).

OpenAPI spec version: 2.8

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

class pypureclient.flashblade.FB_2_8.api.arrays_api.ArraysApi(api_client)

Bases: object

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

GET arrays/eula

List 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.api28_arrays_eula_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• filter (str) – Exclude resources that don’t match the specified criteria.

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

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

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

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

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

PATCH arrays/eula

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.api28_arrays_eula_patch_with_http_info(eula, async_req=True) >>> result = thread.get()

Parameters

• eula (Eula) – (required)

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

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.

api28_arrays_factory_reset_token_delete_with_http_info(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 any 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.api28_arrays_factory_reset_token_delete_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.

api28_arrays_factory_reset_token_get_with_http_info(continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → 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.api28_arrays_factory_reset_token_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• filter (str) – Exclude resources that don’t match the specified criteria.

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

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

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

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_arrays_factory_reset_token_post_with_http_info(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 file systems, buckets, and snapshots must first be eradicated). After a token has been created, operations that would take the array out of the prepared state (e.g., creating file systems) are disabled 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.api28_arrays_factory_reset_token_post_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.

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

GET arrays

List array attributes such as the array name, ID, version, 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.api28_arrays_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• filter (str) – Exclude resources that don’t match the specified criteria.

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

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

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

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_arrays_http_specific_performance_get_with_http_info(end_time: Optional[int] = None, resolution: Optional[int] = None, start_time: Optional[int] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ArrayHttpSpecificPerformanceGet

GET arrays/http-specific-performance

List the HTTP performance metrics of the array. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_arrays_http_specific_performance_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• end_time (int) – When the time window ends (in milliseconds since epoch).

• resolution (int) – The desired ms between samples. Available resolutions may depend on data type, start_time and end_time. In general 1000, 30000, 300000, 1800000, 7200000, and 86400000 are possible values.

• start_time (int) – When the time window starts (in milliseconds since epoch).

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_arrays_nfs_specific_performance_get_with_http_info(end_time: Optional[int] = None, resolution: Optional[int] = None, start_time: Optional[int] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ArrayNfsSpecificPerformanceGet

GET arrays/nfs-specific-performance

List the NFS performance metrics of the array. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_arrays_nfs_specific_performance_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• end_time (int) – When the time window ends (in milliseconds since epoch).

• resolution (int) – The desired ms between samples. Available resolutions may depend on data type, start_time and end_time. In general 1000, 30000, 300000, 1800000, 7200000, and 86400000 are possible values.

• start_time (int) – When the time window starts (in milliseconds since epoch).

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_arrays_patch_with_http_info(array: Optional[list] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ArrayResponse

PATCH arrays

Modify the general configuration of the array including banner text, array name, NTP servers, and time zone. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_arrays_patch_with_http_info(array, async_req=True) >>> result = thread.get()

Parameters

• array (Array) – (required)

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

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.

api28_arrays_performance_get_with_http_info(end_time: Optional[int] = None, protocol: Optional[str] = None, resolution: Optional[int] = None, start_time: Optional[int] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ArrayPerformanceGetResponse

GET arrays/performance

Lists the overall performance metrics of the array. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_arrays_performance_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• end_time (int) – When the time window ends (in milliseconds since epoch).

• protocol (str) – Display the performance of a specified protocol. Valid values are all, HTTP, SMB, NFS, and S3. If not specified, defaults to all, which will provide the combined performance of all available protocols.

• resolution (int) – The desired ms between samples. Available resolutions may depend on data type, start_time and end_time. In general 1000, 30000, 300000, 1800000, 7200000, and 86400000 are possible values.

• start_time (int) – When the time window starts (in milliseconds since epoch).

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

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.

api28_arrays_performance_replication_get_with_http_info(end_time: Optional[int] = None, resolution: Optional[int] = None, start_time: Optional[int] = None, type: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ArrayPerformanceReplicationGetResp

GET arrays/performance/replication

List replication performance metrics. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_arrays_performance_replication_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• end_time (int) – When the time window ends (in milliseconds since epoch).

• resolution (int) – The desired ms between samples. Available resolutions may depend on data type, start_time and end_time. In general 1000, 30000, 300000, 1800000, 7200000, and 86400000 are possible values.

• start_time (int) – When the time window starts (in milliseconds since epoch).

• type (str) – Display the metric of a specified object type. Valid values are all, file-system, and object-store. If not specified, defaults to all.

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_arrays_s3_specific_performance_get_with_http_info(end_time: Optional[int] = None, resolution: Optional[int] = None, start_time: Optional[int] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ArrayS3SpecificPerformanceGetResp

GET arrays/s3-specific-performance

List the S3 performance metrics of the array. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_arrays_s3_specific_performance_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• end_time (int) – When the time window ends (in milliseconds since epoch).

• resolution (int) – The desired ms between samples. Available resolutions may depend on data type, start_time and end_time. In general 1000, 30000, 300000, 1800000, 7200000, and 86400000 are possible values.

• start_time (int) – When the time window starts (in milliseconds since epoch).

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_arrays_space_get_with_http_info(end_time: Optional[int] = None, resolution: Optional[int] = None, start_time: Optional[int] = None, type: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ArraySpaceGetResponse

GET arrays/space

List available and used storage space 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.api28_arrays_space_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• end_time (int) – When the time window ends (in milliseconds since epoch).

• resolution (int) – The desired ms between samples. Available resolutions may depend on data type, start_time and end_time. In general 1000, 30000, 300000, 1800000, 7200000, and 86400000 are possible values.

• start_time (int) – When the time window starts (in milliseconds since epoch).

• type (str) – Display the metric of a specified object type. Valid values are array, file-system, and object-store. If not specified, defaults to 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

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

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

GET arrays/supported-time-zones

List supported time zones 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.api28_arrays_supported_time_zones_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• filter (str) – Exclude resources that don’t match the specified criteria.

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

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

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

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

pypureclient.flashblade.FB_2_8.api.audits_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.8, developed by Pure Storage, Inc. (http://www.purestorage.com/).

OpenAPI spec version: 2.8

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

class pypureclient.flashblade.FB_2_8.api.audits_api.AuditsApi(api_client)

Bases: object

api28_audits_get_with_http_info(continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → AuditGetResponse

GET audits

List the array audit trail to view activities that were performed 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.api28_audits_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

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

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

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

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

pypureclient.flashblade.FB_2_8.api.authorization_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.8, developed by Pure Storage, Inc. (http://www.purestorage.com/).

OpenAPI spec version: 2.8

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

class pypureclient.flashblade.FB_2_8.api.authorization_api.AuthorizationApi(api_client)

Bases: object

api_api_version_get_with_http_info(async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ApiVersion

GET api_version

Get 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

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api_login_banner_get_with_http_info(async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → LoginBannerGetResponse

GET login_banner

Get the login banner for the array. 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_login_banner_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api_login_post_with_http_info(async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → Login

POST login

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

Parameters

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api_logout_post_with_http_info(async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

POST logout

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

Parameters

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

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.

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.flashblade.FB_2_8.api.blades_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.8, developed by Pure Storage, Inc. (http://www.purestorage.com/).

OpenAPI spec version: 2.8

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

class pypureclient.flashblade.FB_2_8.api.blades_api.BladesApi(api_client)

Bases: object

api28_blades_get_with_http_info(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_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → BladeGetResponse

GET blades

List array blade information. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_blades_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

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

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

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

• total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. 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

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

pypureclient.flashblade.FB_2_8.api.bucket_replica_links_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.8, developed by Pure Storage, Inc. (http://www.purestorage.com/).

OpenAPI spec version: 2.8

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

class pypureclient.flashblade.FB_2_8.api.bucket_replica_links_api.BucketReplicaLinksApi(api_client)

Bases: object

api28_bucket_replica_links_delete_with_http_info(ids: Optional[List[str]] = None, local_bucket_ids: Optional[List[str]] = None, local_bucket_names: Optional[List[str]] = None, remote_bucket_names: Optional[List[str]] = None, remote_ids: Optional[List[str]] = None, remote_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 bucket-replica-links

Delete a bucket replica link. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_bucket_replica_links_delete_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• local_bucket_ids (list[str]) – A comma-separated list of local bucket 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_bucket_names query parameter.

• local_bucket_names (list[str]) – A comma-separated list of local bucket names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with local_bucket_ids query parameter.

• remote_bucket_names (list[str]) – A comma-separated list of remote bucket names. If 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 there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with remote_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.

api28_bucket_replica_links_get_with_http_info(continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, local_bucket_ids: Optional[List[str]] = None, local_bucket_names: Optional[List[str]] = None, offset: Optional[int] = None, remote_bucket_names: Optional[List[str]] = None, remote_ids: Optional[List[str]] = None, remote_names: Optional[List[str]] = None, sort: Optional[List[str]] = 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) → BucketReplicaLinkGetResponse

GET bucket-replica-links

List bucket replica links for object replication. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_bucket_replica_links_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

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

• local_bucket_ids (list[str]) – A comma-separated list of local bucket 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_bucket_names query parameter.

• local_bucket_names (list[str]) – A comma-separated list of local bucket names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with local_bucket_ids query parameter.

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

• remote_bucket_names (list[str]) – A comma-separated list of remote bucket names. If 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 there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with remote_ids query parameter.

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

• total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. 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

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

api28_bucket_replica_links_patch_with_http_info(bucket_replica_link: Optional[BucketReplicaLink] = None, ids: Optional[List[str]] = None, local_bucket_ids: Optional[List[str]] = None, local_bucket_names: Optional[List[str]] = None, remote_bucket_names: Optional[List[str]] = None, remote_ids: Optional[List[str]] = None, remote_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → BucketReplicaLinkResponse

PATCH bucket-replica-links

Modify the configuration of a bucket replica link including whether the link is paused and the object store remote credentials used. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_bucket_replica_links_patch_with_http_info(bucket_replica_link, async_req=True) >>> result = thread.get()

Parameters

• bucket_replica_link (BucketReplicaLink) – (required)

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• local_bucket_ids (list[str]) – A comma-separated list of local bucket 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_bucket_names query parameter.

• local_bucket_names (list[str]) – A comma-separated list of local bucket names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with local_bucket_ids query parameter.

• remote_bucket_names (list[str]) – A comma-separated list of remote bucket names. If 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 there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with remote_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

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

api28_bucket_replica_links_post_with_http_info(bucket_replica_link: Optional[BucketReplicaLinkPost] = None, local_bucket_names: Optional[List[str]] = None, local_bucket_ids: Optional[List[str]] = None, remote_bucket_names: Optional[List[str]] = None, remote_credentials_names: Optional[List[str]] = None, remote_credentials_ids: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → BucketReplicaLinkResponse

POST bucket-replica-links

Create a bucket replica link for object replication. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_bucket_replica_links_post_with_http_info(bucket_replica_link, async_req=True) >>> result = thread.get()

Parameters

• bucket_replica_link (BucketReplicaLinkPost) – (required)

• local_bucket_names (list[str]) – A comma-separated list of local bucket names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with local_bucket_ids query parameter.

• local_bucket_ids (list[str]) – A comma-separated list of local bucket 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_bucket_names query parameter.

• remote_bucket_names (list[str]) – A comma-separated list of remote bucket names. If there is not at least one resource that matches each of the elements, then an error is returned.

• remote_credentials_names (list[str]) – A comma-separated list of remote credentials names. If 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_credentials_ids query parameter.

• remote_credentials_ids (list[str]) – A comma-separated list of remote credentials 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_credentials_names 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

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

pypureclient.flashblade.FB_2_8.api.buckets_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.8, developed by Pure Storage, Inc. (http://www.purestorage.com/).

OpenAPI spec version: 2.8

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

class pypureclient.flashblade.FB_2_8.api.buckets_api.BucketsApi(api_client)

Bases: object

api28_buckets_delete_with_http_info(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 buckets

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

Parameters

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.

api28_buckets_get_with_http_info(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_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → BucketGetResponse

GET buckets

List object store bucket attributes such as creation time and space usage. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_buckets_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• 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. If not set, lists both objects that are destroyed and those that are not destroyed. If object name(s) are specified in the names parameter, then each object referenced must exist. If destroyed is set to true, then each object referenced must also be destroyed. If destroyed is set to false, then each object referenced must also not be destroyed. An error is returned if any of these conditions are not met.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

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

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

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

• total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. 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

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

api28_buckets_patch_with_http_info(bucket: Optional[BucketPatch] = None, ids: Optional[List[str]] = None, ignore_usage: 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) → BucketResponse

PATCH buckets

Modify object store bucket attributes such as destroyed and versioning. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_buckets_patch_with_http_info(bucket, async_req=True) >>> result = thread.get()

Parameters

• bucket (BucketPatch) – (required)

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• ignore_usage (bool) – Allow update operations that lead to a hard_limit_enabled object store account, bucket, or file system with usage over its limiting value. For object store accounts and buckets, the limiting value is that of quota_limit, and for file systems it is that of provisioned. The operation can be either setting hard_limit_enabled when usage is higher than the limiting value, or modifying the limiting value to a value under usage when hard_limit_enabled is true.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_buckets_performance_get_with_http_info(continuation_token: Optional[str] = None, end_time: Optional[int] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, resolution: Optional[int] = None, sort: Optional[List[str]] = None, start_time: Optional[int] = 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) → BucketPerformanceGetResponse

GET buckets/performance

List performance metrics for a bucket. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_buckets_performance_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• end_time (int) – When the time window ends (in milliseconds since epoch).

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

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

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

• resolution (int) – The desired ms between samples. Available resolutions may depend on data type, start_time and end_time. In general 1000, 30000, 300000, 1800000, 7200000, and 86400000 are possible values.

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

• start_time (int) – When the time window starts (in milliseconds since epoch).

• total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. 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

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

api28_buckets_post_with_http_info(names: Optional[List[str]] = None, bucket: Optional[BucketPost] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → BucketResponse

POST buckets

Create a new object store bucket. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_buckets_post_with_http_info(names, bucket, async_req=True) >>> result = thread.get()

Parameters

• names (list[str]) – A comma-separated list of resource names. (required)

• bucket (BucketPost) – (required)

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_buckets_s3_specific_performance_get_with_http_info(continuation_token: Optional[str] = None, end_time: Optional[int] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, resolution: Optional[int] = None, sort: Optional[List[str]] = None, start_time: Optional[int] = 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) → BucketS3SpecificPerformanceGetResp

GET buckets/s3-specific-performance

List performance metrics specific to S3 operations for a bucket. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_buckets_s3_specific_performance_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• end_time (int) – When the time window ends (in milliseconds since epoch).

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

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

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

• resolution (int) – The desired ms between samples. Available resolutions may depend on data type, start_time and end_time. In general 1000, 30000, 300000, 1800000, 7200000, and 86400000 are possible values.

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

• start_time (int) – When the time window starts (in milliseconds since epoch).

• total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. 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

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

pypureclient.flashblade.FB_2_8.api.certificate_groups_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.8, developed by Pure Storage, Inc. (http://www.purestorage.com/).

OpenAPI spec version: 2.8

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

class pypureclient.flashblade.FB_2_8.api.certificate_groups_api.CertificateGroupsApi(api_client)

Bases: object

api28_certificate_groups_certificates_delete_with_http_info(certificate_ids: Optional[List[str]] = None, certificate_group_ids: Optional[List[str]] = None, certificate_group_names: 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 certificate-groups/certificates

Delete one or more certificate groups. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_certificate_groups_certificates_delete_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• certificate_ids (list[str]) – A comma-separated list of certificate ids. If there is not at least one resource that matches each of the elements of certificate_ids, then an error is returned. This cannot be provided in conjunction with the certificate_names parameter.

• certificate_group_ids (list[str]) – A comma-separated list of certificate group ids. If there is not at least one resource that matches each of the elements of certificate_group_ids, then an error is returned. This cannot be provided in conjunction with the certificate_group_names parameter.

• certificate_group_names (list[str]) – A comma-separated list of certificate group names. If there is not at least one resource that matches each of the elements of certificate_group_names, then an error is returned. This cannot be provided in conjunction with the certificate_group_ids parameter.

• certificate_names (list[str]) – A comma-separated list of certificate names. If there is not at least one resource that matches each of the elements of certificate_names, then an error is returned. This cannot be provided in conjunction with the certificate_ids 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.

api28_certificate_groups_certificates_get_with_http_info(continuation_token: Optional[str] = None, certificate_ids: Optional[List[str]] = None, certificate_group_ids: Optional[List[str]] = None, certificate_group_names: Optional[List[str]] = None, certificate_names: Optional[List[str]] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → CertificateGroupCertificateGetResp

GET certificate-groups/certificates

List membership associations between groups and certificates 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.api28_certificate_groups_certificates_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• certificate_ids (list[str]) – A comma-separated list of certificate ids. If there is not at least one resource that matches each of the elements of certificate_ids, then an error is returned. This cannot be provided in conjunction with the certificate_names parameter.

• certificate_group_ids (list[str]) – A comma-separated list of certificate group ids. If there is not at least one resource that matches each of the elements of certificate_group_ids, then an error is returned. This cannot be provided in conjunction with the certificate_group_names parameter.

• certificate_group_names (list[str]) – A comma-separated list of certificate group names. If there is not at least one resource that matches each of the elements of certificate_group_names, then an error is returned. This cannot be provided in conjunction with the certificate_group_ids parameter.

• certificate_names (list[str]) – A comma-separated list of certificate names. If there is not at least one resource that matches each of the elements of certificate_names, then an error is returned. This cannot be provided in conjunction with the certificate_ids parameter.

• filter (str) – Exclude resources that don’t match the specified criteria.

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

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

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

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_certificate_groups_certificates_post_with_http_info(certificate_ids: Optional[List[str]] = None, certificate_group_ids: Optional[List[str]] = None, certificate_group_names: 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) → CertificateGroupCertificateResponse

POST certificate-groups/certificates

Add one or more certificates to one or more certificate groups 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.api28_certificate_groups_certificates_post_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• certificate_ids (list[str]) – A comma-separated list of certificate ids. If there is not at least one resource that matches each of the elements of certificate_ids, then an error is returned. This cannot be provided in conjunction with the certificate_names parameter.

• certificate_group_ids (list[str]) – A comma-separated list of certificate group ids. If there is not at least one resource that matches each of the elements of certificate_group_ids, then an error is returned. This cannot be provided in conjunction with the certificate_group_names parameter.

• certificate_group_names (list[str]) – A comma-separated list of certificate group names. If there is not at least one resource that matches each of the elements of certificate_group_names, then an error is returned. This cannot be provided in conjunction with the certificate_group_ids parameter.

• certificate_names (list[str]) – A comma-separated list of certificate names. If there is not at least one resource that matches each of the elements of certificate_names, then an error is returned. This cannot be provided in conjunction with the certificate_ids 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

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

api28_certificate_groups_delete_with_http_info(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 certificate-groups

Delete one or more certificate groups from the array. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_certificate_groups_delete_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.

api28_certificate_groups_get_with_http_info(continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → CertificateGroupGetResponse

GET certificate-groups

Display all array certificate groups. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_certificate_groups_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

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

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

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

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_certificate_groups_post_with_http_info(names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → CertificateGroupResponse

POST certificate-groups

Create one or more certificate groups 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.api28_certificate_groups_post_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_certificate_groups_uses_get_with_http_info(continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → CertificateGroupUseGetResponse

GET certificate-groups/uses

List how certificate groups are being used and by what. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_certificate_groups_uses_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

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

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

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

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

pypureclient.flashblade.FB_2_8.api.certificates_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.8, developed by Pure Storage, Inc. (http://www.purestorage.com/).

OpenAPI spec version: 2.8

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

class pypureclient.flashblade.FB_2_8.api.certificates_api.CertificatesApi(api_client)

Bases: object

api28_certificates_certificate_groups_delete_with_http_info(certificate_ids: Optional[List[str]] = None, certificate_group_ids: Optional[List[str]] = None, certificate_group_names: 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 certificates/certificate-groups

Remove one or more certificates from one or more certificate groups. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_certificates_certificate_groups_delete_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• certificate_ids (list[str]) – A comma-separated list of certificate ids. If there is not at least one resource that matches each of the elements of certificate_ids, then an error is returned. This cannot be provided in conjunction with the certificate_names parameter.

• certificate_group_ids (list[str]) – A comma-separated list of certificate group ids. If there is not at least one resource that matches each of the elements of certificate_group_ids, then an error is returned. This cannot be provided in conjunction with the certificate_group_names parameter.

• certificate_group_names (list[str]) – A comma-separated list of certificate group names. If there is not at least one resource that matches each of the elements of certificate_group_names, then an error is returned. This cannot be provided in conjunction with the certificate_group_ids parameter.

• certificate_names (list[str]) – A comma-separated list of certificate names. If there is not at least one resource that matches each of the elements of certificate_names, then an error is returned. This cannot be provided in conjunction with the certificate_ids 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.

api28_certificates_certificate_groups_get_with_http_info(continuation_token: Optional[str] = None, certificate_ids: Optional[List[str]] = None, certificate_group_ids: Optional[List[str]] = None, certificate_group_names: Optional[List[str]] = None, certificate_names: Optional[List[str]] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → CertificateCertificateGroupGetResp

GET certificates/certificate-groups

List membership associations between groups and certificates. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_certificates_certificate_groups_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• certificate_ids (list[str]) – A comma-separated list of certificate ids. If there is not at least one resource that matches each of the elements of certificate_ids, then an error is returned. This cannot be provided in conjunction with the certificate_names parameter.

• certificate_group_ids (list[str]) – A comma-separated list of certificate group ids. If there is not at least one resource that matches each of the elements of certificate_group_ids, then an error is returned. This cannot be provided in conjunction with the certificate_group_names parameter.

• certificate_group_names (list[str]) – A comma-separated list of certificate group names. If there is not at least one resource that matches each of the elements of certificate_group_names, then an error is returned. This cannot be provided in conjunction with the certificate_group_ids parameter.

• certificate_names (list[str]) – A comma-separated list of certificate names. If there is not at least one resource that matches each of the elements of certificate_names, then an error is returned. This cannot be provided in conjunction with the certificate_ids parameter.

• filter (str) – Exclude resources that don’t match the specified criteria.

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

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

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

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_certificates_certificate_groups_post_with_http_info(certificate_ids: Optional[List[str]] = None, certificate_group_ids: Optional[List[str]] = None, certificate_group_names: 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) → CertificateCertificateGroupResponse

POST certificates/certificate-groups

Add one or more certificates to one or more certificate groups. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_certificates_certificate_groups_post_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• certificate_ids (list[str]) – A comma-separated list of certificate ids. If there is not at least one resource that matches each of the elements of certificate_ids, then an error is returned. This cannot be provided in conjunction with the certificate_names parameter.

• certificate_group_ids (list[str]) – A comma-separated list of certificate group ids. If there is not at least one resource that matches each of the elements of certificate_group_ids, then an error is returned. This cannot be provided in conjunction with the certificate_group_names parameter.

• certificate_group_names (list[str]) – A comma-separated list of certificate group names. If there is not at least one resource that matches each of the elements of certificate_group_names, then an error is returned. This cannot be provided in conjunction with the certificate_group_ids parameter.

• certificate_names (list[str]) – A comma-separated list of certificate names. If there is not at least one resource that matches each of the elements of certificate_names, then an error is returned. This cannot be provided in conjunction with the certificate_ids 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

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

api28_certificates_delete_with_http_info(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 certificates

Delete a CA certificate from the array. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_certificates_delete_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.

api28_certificates_get_with_http_info(continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → CertificateGetResponse

GET certificates

List array certificates and their attributes. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_certificates_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

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

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

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

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_certificates_patch_with_http_info(certificate: Optional[CertificatePatch] = 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) → CertificateResponse

PATCH certificates

Modify SSL certificate attributes such as passphrases and intermediate certificates. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_certificates_patch_with_http_info(certificate, async_req=True) >>> result = thread.get()

Parameters

• certificate (CertificatePatch) – (required)

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.

api28_certificates_post_with_http_info(certificate: Optional[CertificatePost] = 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

POST certificates

Upload a CA certificate 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.api28_certificates_post_with_http_info(certificate, async_req=True) >>> result = thread.get()

Parameters

• certificate (CertificatePost) – (required)

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.

api28_certificates_uses_get_with_http_info(continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → CertificateUseGetResponse

GET certificates/uses

List how certificates are being used and by what. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_certificates_uses_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

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

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

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

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

pypureclient.flashblade.FB_2_8.api.clients_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.8, developed by Pure Storage, Inc. (http://www.purestorage.com/).

OpenAPI spec version: 2.8

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

class pypureclient.flashblade.FB_2_8.api.clients_api.ClientsApi(api_client)

Bases: object

api28_arrays_clients_performance_get_with_http_info(filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, sort: Optional[List[str]] = 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) → ClientPerformanceGetResponse

GET clients-performance

List NFS client I/O performance metrics. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_arrays_clients_performance_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• filter (str) – Exclude resources that don’t match the specified criteria.

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

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

• total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. 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

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

pypureclient.flashblade.FB_2_8.api.directory_services_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.8, developed by Pure Storage, Inc. (http://www.purestorage.com/).

OpenAPI spec version: 2.8

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

class pypureclient.flashblade.FB_2_8.api.directory_services_api.DirectoryServicesApi(api_client)

Bases: object

api28_directory_services_get_with_http_info(continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → DirectoryServiceGetResponse

GET directory-services

List directory service configuration information 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.api28_directory_services_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

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

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

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

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_directory_services_patch_with_http_info(directory_service: Optional[DirectoryService] = 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) → DirectoryServiceResponse

PATCH directory-services

Modifies and tests 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.api28_directory_services_patch_with_http_info(directory_service, async_req=True) >>> result = thread.get()

Parameters

• directory_service (DirectoryService) – (required)

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.

api28_directory_services_roles_get_with_http_info(continuation_token: Optional[str] = None, ids: Optional[List[str]] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, role_ids: Optional[List[str]] = None, role_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → DirectoryServiceRolesGetResponse

GET directory-service/roles

Return array’s RBAC group 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.api28_directory_services_roles_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the role_names or role_ids query parameters.

• filter (str) – Exclude resources that don’t match the specified criteria.

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

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

• role_ids (list[str]) – A comma-separated list of role_ids. If after filtering, there is not at least one resource that matches each of the elements of role_ids, then an error is returned. This cannot be provided together with the ids or role_names query parameters.

• role_names (list[str]) – A comma-separated list of role_names. If there is not at least one resource that matches each of the elements of role_names, then an error is returned. This cannot be provided together with the ids or role_ids query parameters.

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

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_directory_services_roles_patch_with_http_info(directory_service_roles: Optional[DirectoryServiceRole] = None, ids: Optional[List[str]] = None, role_ids: Optional[List[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) → DirectoryServiceRolesResponse

PATCH directory-service/roles

Update an RBAC group configuration setting for manageability. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_directory_services_roles_patch_with_http_info(directory_service_roles, async_req=True) >>> result = thread.get()

Parameters

• directory_service_roles (DirectoryServiceRole) – (required)

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the role_names or role_ids query parameters.

• role_ids (list[str]) – A comma-separated list of role_ids. If after filtering, there is not at least one resource that matches each of the elements of role_ids, then an error is returned. This cannot be provided together with the ids or role_names query parameters.

• role_names (list[str]) – A comma-separated list of role_names. If there is not at least one resource that matches each of the elements of role_names, then an error is returned. This cannot be provided together with the ids or role_ids query parameters.

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_directory_services_test_get_with_http_info(filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → TestResultGetResponse

GET directory-services/test

Test the configured directory services 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.api28_directory_services_test_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

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

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_directory_services_test_patch_with_http_info(filter: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, sort: Optional[List[str]] = None, directory_service: Optional[DirectoryService] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → TestResultResponse

PATCH directory-service/test

Test the configured directory services on the array. Optionally, provide modifications which will be used to perform the tests, but will not be applied to the current configuration. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_directory_services_test_patch_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

• directory_service (DirectoryService) – An optional directory service configuration that, if provided, will be used to overwrite aspects of the existing directory service objects when performing tests.

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

pypureclient.flashblade.FB_2_8.api.dns_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.8, developed by Pure Storage, Inc. (http://www.purestorage.com/).

OpenAPI spec version: 2.8

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

class pypureclient.flashblade.FB_2_8.api.dns_api.DNSApi(api_client)

Bases: object

api28_dns_get_with_http_info(continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → DnsGetResponse

GET dns

List DNS attributes for the array’s administrative network. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_dns_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

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

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

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

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_dns_patch_with_http_info(dns: Optional[Dns] = 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) → DnsResponse

PATCH dns

Modify DNS attributes. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_dns_patch_with_http_info(dns, async_req=True) >>> result = thread.get()

Parameters

• dns (Dns) – (required)

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.flashblade.FB_2_8.api.drives_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.8, developed by Pure Storage, Inc. (http://www.purestorage.com/).

OpenAPI spec version: 2.8

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

class pypureclient.flashblade.FB_2_8.api.drives_api.DrivesApi(api_client)

Bases: object

api28_drives_get_with_http_info(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_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → DriveGetResponse

GET drives

List array drive information. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_drives_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

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

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

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

• total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. 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

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

pypureclient.flashblade.FB_2_8.api.file_system_replica_links_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.8, developed by Pure Storage, Inc. (http://www.purestorage.com/).

OpenAPI spec version: 2.8

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

class pypureclient.flashblade.FB_2_8.api.file_system_replica_links_api.FileSystemReplicaLinksApi(api_client)

Bases: object

api28_file_system_replica_links_get_with_http_info(continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, local_file_system_ids: Optional[List[str]] = None, local_file_system_names: Optional[List[str]] = None, offset: Optional[int] = None, remote_file_system_ids: Optional[List[str]] = None, remote_file_system_names: Optional[List[str]] = None, remote_ids: Optional[List[str]] = None, remote_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → FileSystemReplicaLinkGetResponse

GET file-system-replica-links

List file system replication link. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_file_system_replica_links_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

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

• local_file_system_ids (list[str]) – A comma-separated list of local file system 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_file_system_names query parameter.

• local_file_system_names (list[str]) – A comma-separated list of local file system names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with local_file_system_ids query parameter.

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

• remote_file_system_ids (list[str]) – A comma-separated list of remote file system IDs. If 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_file_system_names query parameter.

• remote_file_system_names (list[str]) – A comma-separated list of remote file system names. If 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_file_system_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 there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with remote_ids query parameter.

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

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_file_system_replica_links_policies_delete_with_http_info(local_file_system_ids: Optional[List[str]] = None, local_file_system_names: Optional[List[str]] = None, member_ids: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, remote_ids: Optional[List[str]] = None, remote_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-replica-links/policies

Remove a policy from a file system replication link. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_file_system_replica_links_policies_delete_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• local_file_system_ids (list[str]) – A comma-separated list of local file system 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_file_system_names query parameter.

• local_file_system_names (list[str]) – A comma-separated list of local file system names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with local_file_system_ids query parameter.

• member_ids (list[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• policy_ids (list[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (list[str]) – A comma-separated list of policy names.

• 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 there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with remote_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.

api28_file_system_replica_links_policies_get_with_http_info(continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, local_file_system_ids: Optional[List[str]] = None, local_file_system_names: Optional[List[str]] = None, member_ids: Optional[List[str]] = None, offset: Optional[int] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, remote_ids: Optional[List[str]] = None, remote_file_system_ids: Optional[List[str]] = None, remote_file_system_names: Optional[List[str]] = None, remote_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberWithRemoteGetResponse

GET file-system-replica-links/policies

List file system replication link policies. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_file_system_replica_links_policies_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• filter (str) – Exclude resources that don’t match the specified criteria.

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

• local_file_system_ids (list[str]) – A comma-separated list of local file system 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_file_system_names query parameter.

• local_file_system_names (list[str]) – A comma-separated list of local file system names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with local_file_system_ids query parameter.

• member_ids (list[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

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

• policy_ids (list[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (list[str]) – A comma-separated list of policy names.

• 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_file_system_ids (list[str]) – A comma-separated list of remote file system IDs. If 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_file_system_names query parameter.

• remote_file_system_names (list[str]) – A comma-separated list of remote file system names. If 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_file_system_ids query parameter.

• remote_names (list[str]) – A comma-separated list of remote array names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with remote_ids query parameter.

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

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_file_system_replica_links_policies_post_with_http_info(local_file_system_ids: Optional[List[str]] = None, local_file_system_names: Optional[List[str]] = None, member_ids: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, remote_ids: Optional[List[str]] = None, remote_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberWithRemoteResponse

POST file-system-replica-links/policies

Add a policy to a file system replication link. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_file_system_replica_links_policies_post_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• local_file_system_ids (list[str]) – A comma-separated list of local file system 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_file_system_names query parameter.

• local_file_system_names (list[str]) – A comma-separated list of local file system names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with local_file_system_ids query parameter.

• member_ids (list[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• policy_ids (list[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (list[str]) – A comma-separated list of policy names.

• 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 there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with remote_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

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

api28_file_system_replica_links_post_with_http_info(file_system_replica_link: Optional[FileSystemReplicaLink] = None, ids: Optional[List[str]] = None, local_file_system_ids: Optional[List[str]] = None, local_file_system_names: Optional[List[str]] = None, remote_file_system_names: Optional[List[str]] = None, remote_ids: Optional[List[str]] = None, remote_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → FileSystemReplicaLinkResponse

POST file-system-replica-links

Create a file system replication link. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_file_system_replica_links_post_with_http_info(file_system_replica_link, async_req=True) >>> result = thread.get()

Parameters

• file_system_replica_link (FileSystemReplicaLink) – (required)

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• local_file_system_ids (list[str]) – A comma-separated list of local file system 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_file_system_names query parameter.

• local_file_system_names (list[str]) – A comma-separated list of local file system names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with local_file_system_ids query parameter.

• remote_file_system_names (list[str]) – A comma-separated list of remote file system names. If 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_file_system_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 there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with remote_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

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

api28_file_system_replica_links_transfer_get_with_http_info(continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names_or_owner_names: Optional[List[str]] = None, offset: Optional[int] = None, remote_ids: Optional[List[str]] = None, remote_names: Optional[List[str]] = None, sort: Optional[List[str]] = 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) → FileSystemSnapshotGetTransferResponse

GET file-system-replica-links/transfer

List the transfer status details for file system replication. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_file_system_replica_links_transfer_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

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

• names_or_owner_names (list[str]) – A comma-separated list of resource names. Either the names of the snapshots or the owning file systems.

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

• 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 there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with remote_ids query parameter.

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

• total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. 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

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

pypureclient.flashblade.FB_2_8.api.file_system_snapshots_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.8, developed by Pure Storage, Inc. (http://www.purestorage.com/).

OpenAPI spec version: 2.8

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

class pypureclient.flashblade.FB_2_8.api.file_system_snapshots_api.FileSystemSnapshotsApi(api_client)

Bases: object

api28_file_system_snapshots_delete_with_http_info(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-snapshots

Delete a file system snapshot. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_file_system_snapshots_delete_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.

api28_file_system_snapshots_get_with_http_info(continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names_or_owner_names: Optional[List[str]] = None, offset: Optional[int] = None, owner_ids: Optional[List[str]] = None, sort: Optional[List[str]] = 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) → FileSystemSnapshotGetResponse

GET file-system-snapshots

List file system snapshots. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_file_system_snapshots_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• 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. If not set, lists both objects that are destroyed and those that are not destroyed. If object name(s) are specified in the names parameter, then each object referenced must exist. If destroyed is set to true, then each object referenced must also be destroyed. If destroyed is set to false, then each object referenced must also not be destroyed. An error is returned if any of these conditions are not met.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

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

• names_or_owner_names (list[str]) – A comma-separated list of resource names. Either the names of the snapshots or the owning file systems.

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

• owner_ids (list[str]) – A comma-separated list of owning file system IDs. If after filtering, there is not at least one resource that matches each of the elements of owner IDs, then an error is returned. This cannot be provided together with the ids, names_or_owner_names, or names_or_sources query parameters.

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

• total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. 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

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

api28_file_system_snapshots_patch_with_http_info(file_system_snapshot: Optional[FileSystemSnapshot] = None, ids: Optional[List[str]] = None, latest_replica: 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) → FileSystemSnapshotResponse

PATCH file-system-snapshots

Modify file system snapshot attributes. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_file_system_snapshots_patch_with_http_info(file_system_snapshot, async_req=True) >>> result = thread.get()

Parameters

• file_system_snapshot (FileSystemSnapshot) – (required)

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• latest_replica (bool) – Used when destroying a snapshot. If not present or false, and the snapshot is the latest replicated snapshot, then destroy will fail. If true or the snapshot is not the latest replicated snapshot, then destroy will be successful.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_file_system_snapshots_policies_delete_with_http_info(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 file-system-snapshots/policies

Remove snapshot scheduling policies from a file system. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_file_system_snapshots_policies_delete_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• member_ids (list[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• member_names (list[str]) – A comma-separated list of member names.

• policy_ids (list[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (list[str]) – A comma-separated list of policy 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.

api28_file_system_snapshots_policies_get_with_http_info(continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, offset: Optional[int] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyFileSystemSnapshotGetResponse

GET file-system-snapshots/policies

List file system snapshots mapped to snapshot scheduling policies. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_file_system_snapshots_policies_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• filter (str) – Exclude resources that don’t match the specified criteria.

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

• member_ids (list[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• member_names (list[str]) – A comma-separated list of member names.

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

• policy_ids (list[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (list[str]) – A comma-separated list of policy names.

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

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_file_system_snapshots_post_with_http_info(source_ids: Optional[List[str]] = None, source_names: Optional[List[str]] = None, send: Optional[bool] = None, targets: Optional[List[str]] = None, file_system_snapshot: Optional[FileSystemSnapshotPost] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → FileSystemSnapshotResponse

POST file-system-snapshots

Create a snapshot for a specified source file system. If a source file system is not specified, creates snapshots for all file systems 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.api28_file_system_snapshots_post_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• source_ids (list[str]) – A comma-separated list of source file system IDs. If after filtering, there is not at least one resource that matches each of the elements of source_ids, then an error is returned. This cannot be provided together with the names_or_sources or sources query parameters.

• source_names (list[str]) – A comma-separated list of names for the source of the object. If there is not at least one resource that matches each of the elements of source_names, an error is returned.

• send (bool) – Whether to replicate created snapshots immediately to other arrays. If it’s false, created snapshots may still be replicated to other arrays according to policy.

• targets (list[str]) – The target arrays to replicate created snapshots to. Only valid when send is true.

• file_system_snapshot (FileSystemSnapshotPost) –

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_file_system_snapshots_transfer_delete_with_http_info(ids: Optional[List[str]] = None, names: Optional[List[str]] = None, remote_names: Optional[List[str]] = None, remote_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 file-system-snapshots/transfer

Delete file system snapshot transfers from the source array to the target array. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_file_system_snapshots_transfer_delete_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• remote_names (list[str]) – A comma-separated list of remote array names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with remote_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.

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

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.

api28_file_system_snapshots_transfer_get_with_http_info(continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names_or_owner_names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = 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) → FileSystemSnapshotGetTransferResponse

GET file-system-snapshots/transfer

List file system snapshot transfers from the source array to the target array. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_file_system_snapshots_transfer_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

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

• names_or_owner_names (list[str]) – A comma-separated list of resource names. Either the names of the snapshots or the owning file systems.

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

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

• total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. 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

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

pypureclient.flashblade.FB_2_8.api.file_systems_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.8, developed by Pure Storage, Inc. (http://www.purestorage.com/).

OpenAPI spec version: 2.8

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

class pypureclient.flashblade.FB_2_8.api.file_systems_api.FileSystemsApi(api_client)

Bases: object

api28_file_systems_delete_with_http_info(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-systems

Deletes a file system. Deleting a file system is equivalent to eradication. A file system’s destroyed parameter must be set to true before a file system can be deleted. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_file_systems_delete_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.

api28_file_systems_get_with_http_info(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_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → FileSystemGetResponse

GET file-systems

List one or more file systems 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.api28_file_systems_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• 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. If not set, lists both objects that are destroyed and those that are not destroyed. If object name(s) are specified in the names parameter, then each object referenced must exist. If destroyed is set to true, then each object referenced must also be destroyed. If destroyed is set to false, then each object referenced must also not be destroyed. An error is returned if any of these conditions are not met.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

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

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

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

• total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. 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

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

api28_file_systems_groups_performance_get_with_http_info(file_system_ids: Optional[List[str]] = None, file_system_names: Optional[List[str]] = None, filter: Optional[str] = None, gids: Optional[List[str]] = None, group_names: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, sort: Optional[List[str]] = 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) → FileSystemGroupsPerformanceGetResponse

GET file-systems/groups/performance

List a group’s I/O performance metrics on a file system. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_file_systems_groups_performance_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• file_system_ids (list[str]) – A comma-separated list of file system IDs. If after filtering, there is not at least one resource that matches each of the elements of file_system_ids, then an error is returned. This cannot be provided together with the file_system_names query parameter.

• file_system_names (list[str]) – A comma-separated list of file system names. If there is not at least one resource that matches each of the elements of file_system_names, then an error is returned.

• filter (str) – Exclude resources that don’t match the specified criteria.

• gids (list[str]) – A comma-separated list of group IDs. This cannot be provided together with group_names query parameter.

• group_names (list[str]) – A comma-separated list of group names. This cannot be provided together with gids query parameter.

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

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

• total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. 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

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

api28_file_systems_locks_clients_get_with_http_info(continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → FileSystemClientsGetResponse

Get a list of clients that hold active file locks

Lists all clients that hold active file locks. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_file_systems_locks_clients_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• filter (str) – Exclude resources that don’t match the specified criteria.

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

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_file_systems_locks_delete_with_http_info(client_names: 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

Invalidate file locks

Invalidates file locks. Both parameters are exclusive. It can be used to either delete an individual lock by name or all locks held by a client. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_file_systems_locks_delete_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• client_names (list[str]) – A comma-separated list of ip addresses of clients that hold file locks. For IPv6 both the extended format (x:x:x:x:x:x:x:x) and the shortened format are supported.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.

api28_file_systems_locks_get_with_http_info(continuation_token: Optional[str] = None, client_names: Optional[List[str]] = None, file_system_ids: Optional[List[str]] = None, file_system_names: Optional[List[str]] = None, filter: Optional[str] = None, inodes: Optional[List[float]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, paths: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → FileLockGetResponse

Get a list of active file locks

Lists all active file locks that satisfy the conditions specified by the parameters. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_file_systems_locks_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• client_names (list[str]) – A comma-separated list of ip addresses of clients that hold file locks. For IPv6 both the extended format (x:x:x:x:x:x:x:x) and the shortened format are supported.

• file_system_ids (list[str]) – A comma-separated list of file system IDs. If after filtering, there is not at least one resource that matches each of the elements of file_system_ids, then an error is returned. This cannot be provided together with the file_system_names query parameter.

• file_system_names (list[str]) – A comma-separated list of file system names. If there is not at least one resource that matches each of the elements of file_system_names, then an error is returned.

• filter (str) – Exclude resources that don’t match the specified criteria.

• inodes (list[float]) – Used for filtering file locks query by inodes. This may only be specified if file_system_ids or file_system_names is also specified. This cannot be provided together with the paths query parameter.

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

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• paths (list[str]) – Used for filtering file locks query by file paths. This may only be specified if file_system_ids or file_system_names is also specified. This cannot be provided together with the inodes 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

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

api28_file_systems_locks_nlm_reclamations_post_with_http_info(async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → FileLockNlmReclamationResponse

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.api28_file_systems_locks_nlm_reclamations_post_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_file_systems_patch_with_http_info(file_system: Optional[FileSystemPatch] = None, delete_link_on_eradication: Optional[bool] = None, discard_detailed_permissions: Optional[bool] = None, discard_non_snapshotted_data: Optional[bool] = None, ids: Optional[List[str]] = None, ignore_usage: 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) → FileSystemResponse

PATCH file-systems

Modify a file system’s attributes including its export protocols and limits. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_file_systems_patch_with_http_info(file_system, async_req=True) >>> result = thread.get()

Parameters

• file_system (FileSystemPatch) – (required)

• delete_link_on_eradication (bool) – If set to true, the file system can be destroyed, even if it has a replica link. If set to false, the file system cannot be destroyed if it has a replica link. Defaults to false.

• discard_detailed_permissions (bool) – This parameter must be set to true in order to change a file system’s access_control_style from a style that supports more detailed access control lists to a style that only supports less detailed mode bits as a form of permission control. This parameter may not be set to true any other time. Setting this parameter to true is acknowledgement that any more detailed access control lists currently set within the file system will be lost, and NFS permission controls will only be enforced at the granularity level of NFS mode bits.

• discard_non_snapshotted_data (bool) – This parameter must be set to true in order to restore a file system from a snapshot or to demote a file system (which restores the file system from the common baseline snapshot). Setting this parameter to true is acknowledgement that any non-snapshotted data currently in the file system will be irretrievably lost.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• ignore_usage (bool) – Allow update operations that lead to a hard_limit_enabled object store account, bucket, or file system with usage over its limiting value. For object store accounts and buckets, the limiting value is that of quota_limit, and for file systems it is that of provisioned. The operation can be either setting hard_limit_enabled when usage is higher than the limiting value, or modifying the limiting value to a value under usage when hard_limit_enabled is true.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.

api28_file_systems_performance_get_with_http_info(continuation_token: Optional[str] = None, end_time: Optional[int] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, protocol: Optional[str] = None, resolution: Optional[int] = None, sort: Optional[List[str]] = None, start_time: Optional[int] = 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) → FileSystemPerformanceGetResponse

GET file-systems/performance

Displays the performance metrics for a file system. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_file_systems_performance_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• end_time (int) – When the time window ends (in milliseconds since epoch).

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

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

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

• protocol (str) – Display the performance of a specified protocol. Valid values are all, HTTP, SMB, NFS, and S3. If not specified, defaults to all, which will provide the combined performance of all available protocols.

• resolution (int) – The desired ms between samples. Available resolutions may depend on data type, start_time and end_time. In general 1000, 30000, 300000, 1800000, 7200000, and 86400000 are possible values.

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

• start_time (int) – When the time window starts (in milliseconds since epoch).

• total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. 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

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

api28_file_systems_policies_all_get_with_http_info(continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, offset: Optional[int] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberGetResponse

GET file-systems/policies-all

List file system policies. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_file_systems_policies_all_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• filter (str) – Exclude resources that don’t match the specified criteria.

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

• member_ids (list[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• member_names (list[str]) – A comma-separated list of member names.

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

• policy_ids (list[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (list[str]) – A comma-separated list of policy names.

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

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_file_systems_policies_delete_with_http_info(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 file-systems/policies

Remove a snapshot scheduling policy from a file system. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_file_systems_policies_delete_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• member_ids (list[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• member_names (list[str]) – A comma-separated list of member names.

• policy_ids (list[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (list[str]) – A comma-separated list of policy 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.

api28_file_systems_policies_get_with_http_info(continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, offset: Optional[int] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberGetResponse

GET file-systems/policies

List file system snapshot scheduling policies. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_file_systems_policies_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• filter (str) – Exclude resources that don’t match the specified criteria.

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

• member_ids (list[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• member_names (list[str]) – A comma-separated list of member names.

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

• policy_ids (list[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (list[str]) – A comma-separated list of policy names.

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

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_file_systems_policies_post_with_http_info(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) → PolicyMemberResponse

POST file-systems/policies

Apply a snapshot scheduling policy to a file system. Only one file system can be mapped to a policy 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.api28_file_systems_policies_post_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• member_ids (list[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• member_names (list[str]) – A comma-separated list of member names.

• policy_ids (list[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (list[str]) – A comma-separated list of policy 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

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

api28_file_systems_post_with_http_info(names: Optional[List[str]] = None, file_system: Optional[FileSystemPost] = None, discard_non_snapshotted_data: Optional[bool] = None, overwrite: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → FileSystemResponse

POST file-systems

Create a file system on 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.api28_file_systems_post_with_http_info(names, file_system, async_req=True) >>> result = thread.get()

Parameters

• names (list[str]) – A comma-separated list of resource names. (required)

• file_system (FileSystemPost) – (required)

• discard_non_snapshotted_data (bool) – This parameter must be set to true in order to restore a file system from a snapshot or to demote a file system (which restores the file system from the common baseline snapshot). Setting this parameter to true is acknowledgement that any non-snapshotted data currently in the file system will be irretrievably lost.

• overwrite (bool) – When used for snapshot restore, overwrites (true) an existing file 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

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

api28_file_systems_users_performance_get_with_http_info(file_system_ids: Optional[List[str]] = None, file_system_names: Optional[List[str]] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, sort: Optional[List[str]] = None, total_only: Optional[bool] = None, uids: Optional[List[int]] = None, user_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → FileSystemUsersPerformanceGetResponse

GET file-systems/users/performance

List a user’s I/O performance metrics on a file system. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_file_systems_users_performance_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• file_system_ids (list[str]) – A comma-separated list of file system IDs. If after filtering, there is not at least one resource that matches each of the elements of file_system_ids, then an error is returned. This cannot be provided together with the file_system_names query parameter.

• file_system_names (list[str]) – A comma-separated list of file system names. If there is not at least one resource that matches each of the elements of file_system_names, then an error is returned.

• filter (str) – Exclude resources that don’t match the specified criteria.

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

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

• total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. The items list will be empty.

• uids (list[int]) – A comma-separated list of user IDs. This cannot be provided together with user_names query parameter.

• user_names (list[str]) – A comma-separated list of user names. This cannot be provided together with uids 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

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

pypureclient.flashblade.FB_2_8.api.hardware_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.8, developed by Pure Storage, Inc. (http://www.purestorage.com/).

OpenAPI spec version: 2.8

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

class pypureclient.flashblade.FB_2_8.api.hardware_api.HardwareApi(api_client)

Bases: object

api28_hardware_get_with_http_info(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, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → HardwareGetResponse

GET hardware

List hardware slots and bays and the 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.api28_hardware_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• filter (str) – Exclude resources that don’t match the specified criteria.

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

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

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

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.

api28_hardware_patch_with_http_info(hardware: Optional[Hardware] = 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) → HardwareResponse

PATCH hardware

Controls the visual identification light of the specified hardware component. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_hardware_patch_with_http_info(hardware, async_req=True) >>> result = thread.get()

Parameters

• hardware (Hardware) – (required)

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.flashblade.FB_2_8.api.hardware_connectors_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.8, developed by Pure Storage, Inc. (http://www.purestorage.com/).

OpenAPI spec version: 2.8

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

class pypureclient.flashblade.FB_2_8.api.hardware_connectors_api.HardwareConnectorsApi(api_client)

Bases: object

api28_hardware_connectors_get_with_http_info(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, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → HardwareConnectorGetResponse

GET hardware-connectors

List array connection information. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_hardware_connectors_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• filter (str) – Exclude resources that don’t match the specified criteria.

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

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

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

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_hardware_connectors_patch_with_http_info(hardware_connector: Optional[HardwareConnector] = 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) → HardwareConnectorResponse

PATCH hardware-connectors

Modify array connection information. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_hardware_connectors_patch_with_http_info(hardware_connector, async_req=True) >>> result = thread.get()

Parameters

• hardware_connector (HardwareConnector) – (required)

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_hardware_connectors_performance_get_with_http_info(end_time: Optional[int] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, resolution: Optional[int] = None, sort: Optional[List[str]] = None, start_time: Optional[int] = 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) → HardwareConnectorPerformanceGetResponse

GET hardware-connectors/performance

Displays network statistics, historical bandwidth, and error reporting for all specified hardware connectors. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_hardware_connectors_performance_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• end_time (int) – When the time window ends (in milliseconds since epoch).

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

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

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

• resolution (int) – The desired ms between samples. Available resolutions may depend on data type, start_time and end_time. In general 1000, 30000, 300000, 1800000, 7200000, and 86400000 are possible values.

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

• start_time (int) – When the time window starts (in milliseconds since epoch).

• total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. 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

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

pypureclient.flashblade.FB_2_8.api.keytabs_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.8, developed by Pure Storage, Inc. (http://www.purestorage.com/).

OpenAPI spec version: 2.8

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

class pypureclient.flashblade.FB_2_8.api.keytabs_api.KeytabsApi(api_client)

Bases: object

api28_keytabs_delete_with_http_info(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 keytabs

Delete a Kerberos keytab file. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_keytabs_delete_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.

api28_keytabs_download_get_with_http_info(keytab_ids: Optional[List[str]] = None, keytab_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → KeytabFileResponse

GET keytabs/download

Download a Kerberos keytab file. The file can be downloaded in the native binary format or a base64 encoded format. If not specified, defaults to binary. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_keytabs_download_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• keytab_ids (list[str]) – A comma-separated list of keytab 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 keytab_names query parameter.

• keytab_names (list[str]) – A comma-separated list of keytab names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with keytab_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

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

api28_keytabs_get_with_http_info(continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → KeytabGetResponse

GET keytabs

List a Kerberos keytab file and its configuration information. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_keytabs_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

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

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

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

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_keytabs_post_with_http_info(keytab: Optional[KeytabPost] = None, name_prefixes: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → KeytabResponse

POST keytabs

Import a Kerberos keytab file from a Key Distribution Center. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_keytabs_post_with_http_info(keytab, async_req=True) >>> result = thread.get()

Parameters

• keytab (KeytabPost) – (required)

• name_prefixes (str) – The prefix to use for the names of all Kerberos keytab objects that are being created.

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_keytabs_upload_post_with_http_info(keytab_file: models.ERRORUNKNOWN = None, name_prefixes: str = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → models.KeytabFileResponse

POST keytabs/upload

Upload a Kerberos keytab file to the array. The file can be uploaded in the native binary format or a base64 encoded format. If not specified, defaults to binary. The procedure to upload a file may vary depending on the type of REST client. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_keytabs_upload_post_with_http_info(keytab_file, async_req=True) >>> result = thread.get()

Parameters

• keytab_file (ERRORUNKNOWN) – The keytab file to upload. (required)

• name_prefixes (str) – The prefix to use for the names of all Kerberos keytab objects that are being created.

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

pypureclient.flashblade.FB_2_8.api.kmip_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.8, developed by Pure Storage, Inc. (http://www.purestorage.com/).

OpenAPI spec version: 2.8

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

class pypureclient.flashblade.FB_2_8.api.kmip_api.KMIPApi(api_client)

Bases: object

api28_kmip_delete_with_http_info(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 KMIP server configuration

Deletes a KMIP server configuration. A server can only be deleted when not in use by the array. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_kmip_delete_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

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

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.

api28_kmip_get_with_http_info(names: Optional[List[str]] = None, ids: Optional[List[str]] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, continuation_token: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → KmipServerResponse

List KMIP server configurations

Displays a list of KMIP server configurations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_kmip_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• filter (str) – Exclude resources that don’t match the specified criteria.

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

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

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

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

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_kmip_patch_with_http_info(kmip_server: Optional[KmipServer] = 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) → KmipServerResponse

Modify a KMIP server configuration

Modifies KMIP server properties - URI, certificate, certificate group. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_kmip_patch_with_http_info(kmip_server, async_req=True) >>> result = thread.get()

Parameters

• kmip_server (KmipServer) – (required)

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_kmip_post_with_http_info(kmip_server: Optional[KmipServer] = 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) → KmipServerResponse

Create a KMIP server configuration

Creates a KMIP server configuration. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_kmip_post_with_http_info(kmip_server, async_req=True) >>> result = thread.get()

Parameters

• kmip_server (KmipServer) – (required)

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_kmip_test_get_with_http_info(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) → TestResultResponse

Displays KMIP server test results

Displays a detailed result of of KMIP server test. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_kmip_test_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

pypureclient.flashblade.FB_2_8.api.lifecycle_rules_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.8, developed by Pure Storage, Inc. (http://www.purestorage.com/).

OpenAPI spec version: 2.8

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

class pypureclient.flashblade.FB_2_8.api.lifecycle_rules_api.LifecycleRulesApi(api_client)

Bases: object

api28_lifecycle_rules_delete_with_http_info(bucket_ids: Optional[List[str]] = None, bucket_names: Optional[List[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 lifecycle-rules

Deletes individual lifecycle rules by name or id, or deletes all rules for a bucket. If ids is specified, bucket_names or bucket_ids is also required. If bucket_names or bucket_ids are specified without ids, delete all the rules for the bucket. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_lifecycle_rules_delete_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• bucket_ids (list[str]) – A comma-separated list of bucket IDs. If after filtering, there is not at least one resource that matches each of the elements of bucket_ids, then an error is returned. This cannot be provided together with the bucket_names query parameter. This can be provided with the ids query parameter but not with names.

• bucket_names (list[str]) – A comma-separated list of bucket names. If there is not at least one resource that matches each of the elements of bucket_names, then an error is returned. This cannot be provided together with the bucket_ids query parameter. This can be provided with the ids query parameter but not with names.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.

api28_lifecycle_rules_get_with_http_info(bucket_ids: Optional[List[str]] = None, bucket_names: Optional[List[str]] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → LifecycleRuleGetResponse

GET lifecycle-rules

Returns a list of lifecycle rules. If names is specified, list the individual rules. If ids is specified, bucket_names or bucket_ids is also required. If bucket_names or bucket_ids are specified without ids, list all the rules for the bucket. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_lifecycle_rules_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• bucket_ids (list[str]) – A comma-separated list of bucket IDs. If after filtering, there is not at least one resource that matches each of the elements of bucket_ids, then an error is returned. This cannot be provided together with the bucket_names query parameter. This can be provided with the ids query parameter but not with names.

• bucket_names (list[str]) – A comma-separated list of bucket names. If there is not at least one resource that matches each of the elements of bucket_names, then an error is returned. This cannot be provided together with the bucket_ids query parameter. This can be provided with the ids query parameter but not with names.

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

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

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

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

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

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_lifecycle_rules_patch_with_http_info(lifecycle: Optional[LifecycleRulePatch] = None, bucket_ids: Optional[List[str]] = None, bucket_names: Optional[List[str]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, confirm_date: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → LifecycleRuleResponse

PATCH lifecycle-rules

Modify an existing lifecycle rule by name or id. If ids is specified, bucket_names or bucket_ids is also required. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_lifecycle_rules_patch_with_http_info(lifecycle, async_req=True) >>> result = thread.get()

Parameters

• lifecycle (LifecycleRulePatch) – (required)

• bucket_ids (list[str]) – A comma-separated list of bucket IDs. If after filtering, there is not at least one resource that matches each of the elements of bucket_ids, then an error is returned. This cannot be provided together with the bucket_names query parameter. This can be provided with the ids query parameter but not with names.

• bucket_names (list[str]) – A comma-separated list of bucket names. If there is not at least one resource that matches each of the elements of bucket_names, then an error is returned. This cannot be provided together with the bucket_ids query parameter. This can be provided with the ids query parameter but not with names.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• confirm_date (bool) – If set to true, then confirm the date of keep_current_version_until is correct.

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_lifecycle_rules_post_with_http_info(rule: Optional[LifecycleRulePost] = None, confirm_date: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → LifecycleRuleResponse

POST lifecycle-rules

Creates a lifecycle rule. bucket and keep_previous_version_for are required. If rule_id is not specified, it will be automatically generated in the format “fbRuleIdX”. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_lifecycle_rules_post_with_http_info(rule, async_req=True) >>> result = thread.get()

Parameters

• rule (LifecycleRulePost) – (required)

• confirm_date (bool) – If set to true, then confirm the date of keep_current_version_until is correct.

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

pypureclient.flashblade.FB_2_8.api.link_aggregation_groups_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.8, developed by Pure Storage, Inc. (http://www.purestorage.com/).

OpenAPI spec version: 2.8

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

class pypureclient.flashblade.FB_2_8.api.link_aggregation_groups_api.LinkAggregationGroupsApi(api_client)

Bases: object

api28_link_aggregation_groups_delete_with_http_info(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 link-aggregation-groups

Remove a link aggregation group to unbind the ports. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_link_aggregation_groups_delete_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.

api28_link_aggregation_groups_get_with_http_info(continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → LinkAggregationGroupGetResponse

GET link-aggregation-groups

List the status and attributes of the Ethernet ports in the configured link aggregation groups. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_link_aggregation_groups_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

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

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

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

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_link_aggregation_groups_patch_with_http_info(link_aggregation_group: Optional[Linkaggregationgroup] = 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) → LinkAggregationGroupResponse

PATCH link-aggregation-groups

Modify link aggregation groups by adding and removing Ethernet ports. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_link_aggregation_groups_patch_with_http_info(link_aggregation_group, async_req=True) >>> result = thread.get()

Parameters

• link_aggregation_group (Linkaggregationgroup) – (required)

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_link_aggregation_groups_post_with_http_info(link_aggregation_group: Optional[LinkAggregationGroup] = 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) → LinkAggregationGroupResponse

POST link-aggregation-groups

Create a link aggregation group of Ethernet ports 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.api28_link_aggregation_groups_post_with_http_info(link_aggregation_group, names, async_req=True) >>> result = thread.get()

Parameters

• link_aggregation_group (LinkAggregationGroup) – (required)

• names (list[str]) – A comma-separated list of resource names. (required)

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

pypureclient.flashblade.FB_2_8.api.logs_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.8, developed by Pure Storage, Inc. (http://www.purestorage.com/).

OpenAPI spec version: 2.8

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

class pypureclient.flashblade.FB_2_8.api.logs_api.LogsApi(api_client)

Bases: object

api28_logs_async_download_get_with_http_info(names: List[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → models.file

GET logs-async/download

Download the files which contain a history of log events from the array to provide to Pure Technical Services for analysis. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_logs_async_download_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_logs_async_get_with_http_info(continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → LogsAsyncGetResponse

GET logs-async

List the attributes and status of preparation for a history of log events from the array to provide to Pure Technical Services for analysis. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_logs_async_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

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

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

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

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_logs_async_patch_with_http_info(logs_async: Optional[LogsAsync] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → LogsAsyncResponse

PATCH logs-async

Start the preparation for a history of log events from the array to provide to Pure Technical Services for analysis. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_logs_async_patch_with_http_info(logs_async, async_req=True) >>> result = thread.get()

Parameters

• logs_async (LogsAsync) – (required)

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_logs_get_with_http_info(end_time: int = None, start_time: int = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → models.file

GET logs

Download a history of log events from the array to provide to Pure Technical Services for analysis. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_logs_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• end_time (int) – When the time window ends (in milliseconds since epoch).

• start_time (int) – When the time window starts (in milliseconds since epoch).

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

pypureclient.flashblade.FB_2_8.api.network_interfaces_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.8, developed by Pure Storage, Inc. (http://www.purestorage.com/).

OpenAPI spec version: 2.8

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

class pypureclient.flashblade.FB_2_8.api.network_interfaces_api.NetworkInterfacesApi(api_client)

Bases: object

api28_network_interfaces_delete_with_http_info(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 network-interfaces

Remove a data VIP. Once removed, any clients connected through the data VIP will lose their connection to the file system. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_network_interfaces_delete_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.

api28_network_interfaces_get_with_http_info(continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → NetworkInterfaceGetResponse

GET network-interfaces

List network interfaces and their attributes. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_network_interfaces_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

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

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

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

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_network_interfaces_patch_with_http_info(network_interface: Optional[NetworkInterfacePatch] = 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) → NetworkInterfaceResponse

PATCH network-interfaces

Modify the attributes of a data VIP. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_network_interfaces_patch_with_http_info(network_interface, async_req=True) >>> result = thread.get()

Parameters

• network_interface (NetworkInterfacePatch) – (required)

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.

api28_network_interfaces_ping_get_with_http_info(destination: Optional[str] = None, packet_size: Optional[int] = None, count: Optional[int] = None, component_name: Optional[str] = None, source: Optional[str] = None, print_latency: Optional[bool] = None, resolve_hostname: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → NetworkInterfacePingGetResponse

GET network-interfaces/ping

Display network interface ping result. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_network_interfaces_ping_get_with_http_info(destination, async_req=True) >>> result = thread.get()

Parameters

• destination (str) – A destination specified by user to run the network diagnosis against. Can be a hostname or an IP. (required)

• packet_size (int) – Used by ping to specify the number of data bytes to be sent per packet. If not specified, defaults to 56.

• count (int) – Used by ping to specify the number of packets to send. If not specified, defaults to 1.

• component_name (str) – Used by ping and trace to specify where to run the operation. Valid values are controllers and blades from hardware list. If not specified, defaults to all available controllers and selected blades.

• source (str) – Used by ping and trace to specify the property where to start to run the specified operation. The property can be subnet or IP.

• print_latency (bool) – Used by ping to specify whether or not to print the full user-to-user latency. If not specified, defaults to false.

• resolve_hostname (bool) – Used by ping and trace to specify whether or not to map IP addresses to host 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

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

api28_network_interfaces_post_with_http_info(network_interface: Optional[NetworkInterface] = 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

POST network-interfaces

Create a data VIP to export a file system. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_network_interfaces_post_with_http_info(network_interface, names, async_req=True) >>> result = thread.get()

Parameters

• network_interface (NetworkInterface) – (required)

• names (list[str]) – A comma-separated list of resource names. (required)

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

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.

api28_network_interfaces_trace_get_with_http_info(destination: Optional[str] = None, fragment_packet: Optional[bool] = None, method: Optional[str] = None, discover_mtu: Optional[bool] = None, component_name: Optional[str] = None, source: Optional[str] = None, port: Optional[str] = None, resolve_hostname: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → NetworkInterfaceTraceGetResponse

GET network-interfaces/trace

Display network interface trace result. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_network_interfaces_trace_get_with_http_info(destination, async_req=True) >>> result = thread.get()

Parameters

• destination (str) – A destination specified by user to run the network diagnosis against. Can be a hostname or an IP. (required)

• fragment_packet (bool) – Used by trace to specify whether or not to fragment packets. If not specified, defaults to true.

• method (str) – Used by trace to specify which method to use for trace operations. Valid values are icmp, tcp, and udp. If not specified, defaults to ‘udp’.

• discover_mtu (bool) – Used by trace to specify whether or not to discover the MTU along the path being traced. If not specified, defaults to false.

• component_name (str) – Used by ping and trace to specify where to run the operation. Valid values are controllers and blades from hardware list. If not specified, defaults to all available controllers and selected blades.

• source (str) – Used by ping and trace to specify the property where to start to run the specified operation. The property can be subnet or IP.

• port (str) – Used by trace to specify a destination port.

• resolve_hostname (bool) – Used by ping and trace to specify whether or not to map IP addresses to host 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

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

pypureclient.flashblade.FB_2_8.api.object_store_access_keys_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.8, developed by Pure Storage, Inc. (http://www.purestorage.com/).

OpenAPI spec version: 2.8

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

class pypureclient.flashblade.FB_2_8.api.object_store_access_keys_api.ObjectStoreAccessKeysApi(api_client)

Bases: object

api28_object_store_access_keys_delete_with_http_info(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 object-store-access-keys

Delete an object store access key. Once an access key has been deleted, it cannot be recovered. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_object_store_access_keys_delete_with_http_info(names, async_req=True) >>> result = thread.get()

Parameters

• names (list[str]) – A comma-separated list of resource names. (required)

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

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.

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

GET object-store-access-keys

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

Parameters

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

• filter (str) – Exclude resources that don’t match the specified criteria.

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

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

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

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_object_store_access_keys_patch_with_http_info(names: Optional[List[str]] = None, object_store_access_key: Optional[ObjectStoreAccessKey] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ObjectStoreAccessKeyResponse

PATCH object-store-access-keys

Enable or disable object store access keys. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_object_store_access_keys_patch_with_http_info(names, object_store_access_key, async_req=True) >>> result = thread.get()

Parameters

• names (list[str]) – A comma-separated list of resource names. (required)

• object_store_access_key (ObjectStoreAccessKey) – (required)

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_object_store_access_keys_post_with_http_info(object_store_access_key: Optional[ObjectStoreAccessKeyPost] = 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) → ObjectStoreAccessKeyResponse

POST object-store-access-keys

Create or import object store access keys. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_object_store_access_keys_post_with_http_info(object_store_access_key, async_req=True) >>> result = thread.get()

Parameters

• object_store_access_key (ObjectStoreAccessKeyPost) – (required)

• names (list[str]) – A comma-separated list of resource names to import. To import a set of credentials, this field must be specified with the secret_access_key body parameter. If both of these are not specified, the system will generate a new set of credentials.

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

pypureclient.flashblade.FB_2_8.api.object_store_accounts_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.8, developed by Pure Storage, Inc. (http://www.purestorage.com/).

OpenAPI spec version: 2.8

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

class pypureclient.flashblade.FB_2_8.api.object_store_accounts_api.ObjectStoreAccountsApi(api_client)

Bases: object

api28_object_store_accounts_delete_with_http_info(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 object-store-accounts

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

Parameters

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.

api28_object_store_accounts_get_with_http_info(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_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ObjectStoreAccountGetResponse

GET object-store-accounts

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

Parameters

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

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

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

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

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

• total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. 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

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

api28_object_store_accounts_patch_with_http_info(object_store_account: Optional[ObjectStoreAccountPatch] = None, ids: Optional[List[str]] = None, ignore_usage: 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) → ObjectStoreAccountResponse

PATCH object-store-accounts

Modify object store account attributes such as quota limit and bucket defaults. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_object_store_accounts_patch_with_http_info(object_store_account, async_req=True) >>> result = thread.get()

Parameters

• object_store_account (ObjectStoreAccountPatch) – (required)

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• ignore_usage (bool) – Allow update operations that lead to a hard_limit_enabled object store account, bucket, or file system with usage over its limiting value. For object store accounts and buckets, the limiting value is that of quota_limit, and for file systems it is that of provisioned. The operation can be either setting hard_limit_enabled when usage is higher than the limiting value, or modifying the limiting value to a value under usage when hard_limit_enabled is true.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_object_store_accounts_post_with_http_info(names: Optional[List[str]] = None, object_store_account: Optional[ObjectStoreAccountPost] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ObjectStoreAccountResponse

POST object-store-accounts

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

Parameters

• names (list[str]) – A comma-separated list of resource names. (required)

• object_store_account (ObjectStoreAccountPost) –

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

pypureclient.flashblade.FB_2_8.api.object_store_remote_credentials_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.8, developed by Pure Storage, Inc. (http://www.purestorage.com/).

OpenAPI spec version: 2.8

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

class pypureclient.flashblade.FB_2_8.api.object_store_remote_credentials_api.ObjectStoreRemoteCredentialsApi(api_client)

Bases: object

api28_object_store_remote_credentials_delete_with_http_info(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 object-store-remote-credentials

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

Parameters

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.

api28_object_store_remote_credentials_get_with_http_info(continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ObjectStoreRemoteCredentialGetResp

GET object-store-remote-credentials

List object store remote credentials used by bucket replica links to access buckets on remote arrays or targets. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_object_store_remote_credentials_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

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

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

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

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_object_store_remote_credentials_patch_with_http_info(remote_credentials: Optional[ObjectStoreRemoteCredentials] = 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) → ObjectStoreRemoteCredentialsResp

PATCH object-store-remote-credentials

Rename and/or change the access key/secret key pair for object store remote credentials. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_object_store_remote_credentials_patch_with_http_info(remote_credentials, async_req=True) >>> result = thread.get()

Parameters

• remote_credentials (ObjectStoreRemoteCredentials) – (required)

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_object_store_remote_credentials_post_with_http_info(names: Optional[List[str]] = None, remote_credentials: Optional[ObjectStoreRemoteCredentialsPost] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ObjectStoreRemoteCredentialsResp

POST object-store-remote-credentials

Create object store remote credentials to set up bucket replicat links to a remote array or target. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_object_store_remote_credentials_post_with_http_info(names, remote_credentials, async_req=True) >>> result = thread.get()

Parameters

• names (list[str]) – A comma-separated list of resource names. (required)

• remote_credentials (ObjectStoreRemoteCredentialsPost) – (required)

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

pypureclient.flashblade.FB_2_8.api.object_store_users_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.8, developed by Pure Storage, Inc. (http://www.purestorage.com/).

OpenAPI spec version: 2.8

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

class pypureclient.flashblade.FB_2_8.api.object_store_users_api.ObjectStoreUsersApi(api_client)

Bases: object

api28_object_store_users_delete_with_http_info(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 object-store-users

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

Parameters

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.

api28_object_store_users_get_with_http_info(continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ObjectStoreUserGetResponse

GET object-store-users

List object store users and their attributes. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_object_store_users_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

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

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

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

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_object_store_users_object_store_access_policies_delete_with_http_info(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 object-store-users/object-store-access-policies

Revoke an object store user’s access policy. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_object_store_users_object_store_access_policies_delete_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• member_ids (list[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• member_names (list[str]) – A comma-separated list of member names.

• policy_ids (list[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (list[str]) – A comma-separated list of policy 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.

api28_object_store_users_object_store_access_policies_get_with_http_info(continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, offset: Optional[int] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberGetResponse

GET object-store-users/object-store-access-policies

List object store users and their access policies. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_object_store_users_object_store_access_policies_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• filter (str) – Exclude resources that don’t match the specified criteria.

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

• member_ids (list[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• member_names (list[str]) – A comma-separated list of member names.

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

• policy_ids (list[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (list[str]) – A comma-separated list of policy names.

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

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_object_store_users_object_store_access_policies_post_with_http_info(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) → PolicyMemberResponse

POST object-store-users/object-store-access-policies

Grant access policies to an object store user. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_object_store_users_object_store_access_policies_post_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• member_ids (list[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• member_names (list[str]) – A comma-separated list of member names.

• policy_ids (list[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (list[str]) – A comma-separated list of policy 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

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

api28_object_store_users_post_with_http_info(names: Optional[List[str]] = None, full_access: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ObjectStoreUserResponse

POST object-store-users

Create object store users to administer object storage for an object store account. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_object_store_users_post_with_http_info(names, async_req=True) >>> result = thread.get()

Parameters

• names (list[str]) – A comma-separated list of resource names. (required)

• full_access (bool) – If set to true, creates an object store user with full permissions. If set to false, creates an object store user with no permission. 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

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

pypureclient.flashblade.FB_2_8.api.object_store_virtual_hosts_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.8, developed by Pure Storage, Inc. (http://www.purestorage.com/).

OpenAPI spec version: 2.8

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

class pypureclient.flashblade.FB_2_8.api.object_store_virtual_hosts_api.ObjectStoreVirtualHostsApi(api_client)

Bases: object

api28_object_store_virtual_hosts_delete_with_http_info(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 object-store-virtual-hosts

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

Parameters

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.

api28_object_store_virtual_hosts_get_with_http_info(continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ObjectStoreVirtualHostGetResponse

GET object-store-virtual-hosts

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

Parameters

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

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

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

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

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

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_object_store_virtual_hosts_post_with_http_info(names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ObjectStoreVirtualHostResponse

POST object-store-virtual-hosts

Create an object store virtual host. An example of a hostname is buckethost.example.com. A hostname cannot exceed 255 characters in length, it cannot be an IP address, only 10 hostnames are supported, supersets or subsets of existing hostnames with the same root are not allowed. The default hostname is s3.amazonaws.com and it 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.api28_object_store_virtual_hosts_post_with_http_info(names, async_req=True) >>> result = thread.get()

Parameters

• names (list[str]) – A comma-separated list of resource names. (required)

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

pypureclient.flashblade.FB_2_8.api.policies___nfs_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.8, developed by Pure Storage, Inc. (http://www.purestorage.com/).

OpenAPI spec version: 2.8

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

class pypureclient.flashblade.FB_2_8.api.policies___nfs_api.PoliciesNFSApi(api_client)

Bases: object

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

DELETE nfs-export-policies

Delete one or more NFS export policies. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_nfs_export_policies_delete_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• versions (list[str]) – A comma-separated list of versions. This is an optional query param used for concurrency control. The ordering should match the names or ids query param. This will fail with a 412 Precondition failed if the resource was changed and the current version of the resource doesn’t match the value in the query param.

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

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.

api28_nfs_export_policies_get_with_http_info(continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → NfsExportPolicyGetResponse

GET nfs-export-policies

Displays a list of NFS export policies. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_nfs_export_policies_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

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

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

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

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_nfs_export_policies_patch_with_http_info(policy: Optional[NfsExportPolicy] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = 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) → NfsExportPolicyResponse

PATCH nfs-export-policies

Modify an existing NFS export policy’s attributes. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_nfs_export_policies_patch_with_http_info(policy, async_req=True) >>> result = thread.get()

Parameters

• policy (NfsExportPolicy) – (required)

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• versions (list[str]) – A comma-separated list of versions. This is an optional query param used for concurrency control. The ordering should match the names or ids query param. This will fail with a 412 Precondition failed if the resource was changed and the current version of the resource doesn’t match the value in the query param.

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_nfs_export_policies_post_with_http_info(names: Optional[List[str]] = None, policy: Optional[NfsExportPolicyPost] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → NfsExportPolicyResponse

POST nfs-export-policies

Create a new NFS export policy. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_nfs_export_policies_post_with_http_info(names, async_req=True) >>> result = thread.get()

Parameters

• names (list[str]) – A comma-separated list of resource names. (required)

• policy (NfsExportPolicyPost) –

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

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

DELETE nfs-export-policies/rules

Delete one or more NFS export policy rules. One of the following is required: ids or names. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_nfs_export_policies_rules_delete_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• versions (list[str]) – A comma-separated list of versions. This is an optional query param used for concurrency control. The ordering should match the names or ids query param. This will fail with a 412 Precondition failed if the resource was changed and the current version of the resource doesn’t match the value in the query param.

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

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.

api28_nfs_export_policies_rules_get_with_http_info(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, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → NfsExportPolicyRuleGetResponse

GET nfs-export-policies/rules

Displays a list of NFS export policy rules. The default sort is by policy name, then index. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_nfs_export_policies_rules_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

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

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

• policy_ids (list[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (list[str]) – A comma-separated list of policy names.

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

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_nfs_export_policies_rules_patch_with_http_info(rule: Optional[NfsExportPolicyRule] = None, before_rule_id: Optional[str] = None, before_rule_name: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = 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) → NfsExportPolicyRuleResponse

PATCH nfs-export-policies/rules

Modify an existing NFS export policy rule. If before_rule_id or before_rule_name are specified, the rule will be moved before that rule. Rules are ordered in three groups; ip addresses, other and * and can only be moved within the appropriate group. One of the following is required: ids or names. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_nfs_export_policies_rules_patch_with_http_info(rule, async_req=True) >>> result = thread.get()

Parameters

• rule (NfsExportPolicyRule) – (required)

• before_rule_id (str) – The id of the rule to insert or move a rule before. This cannot be provided together with the before_rule_name query parameter.

• before_rule_name (str) – The name of the rule to insert or move a rule before. This cannot be provided together with the before_rule_id query parameter.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• versions (list[str]) – A comma-separated list of versions. This is an optional query param used for concurrency control. The ordering should match the names or ids query param. This will fail with a 412 Precondition failed if the resource was changed and the current version of the resource doesn’t match the value in the query param.

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_nfs_export_policies_rules_post_with_http_info(rule: Optional[NfsExportPolicyRule] = None, before_rule_id: Optional[str] = None, before_rule_name: Optional[str] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = 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) → NfsExportPolicyRuleResponse

POST nfs-export-policies/rules

Add a NFS export policy rule. Rules are ordered in three groups; ip addresses, other and *. The new rule will be added at the end of the appropriate group if neither before_rule_id and before_rule_name are specified. Rules can only be inserted into the appropriate group. Either policy_ids or policy_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.api28_nfs_export_policies_rules_post_with_http_info(rule, async_req=True) >>> result = thread.get()

Parameters

• rule (NfsExportPolicyRule) – (required)

• before_rule_id (str) – The id of the rule to insert or move a rule before. This cannot be provided together with the before_rule_name query parameter.

• before_rule_name (str) – The name of the rule to insert or move a rule before. This cannot be provided together with the before_rule_id query parameter.

• policy_ids (list[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (list[str]) – A comma-separated list of policy names.

• versions (list[str]) – A comma-separated list of versions. This is an optional query param used for concurrency control. The ordering should match the names or ids query param. This will fail with a 412 Precondition failed if the resource was changed and the current version of the resource doesn’t match the value in the query param.

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

pypureclient.flashblade.FB_2_8.api.policies___object_store_access_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.8, developed by Pure Storage, Inc. (http://www.purestorage.com/).

OpenAPI spec version: 2.8

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

class pypureclient.flashblade.FB_2_8.api.policies___object_store_access_api.PoliciesObjectStoreAccessApi(api_client)

Bases: object

api28_object_store_access_policies_delete_with_http_info(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 object-store-access-policies

Delete one or more access policies. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_object_store_access_policies_delete_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.

api28_object_store_access_policies_get_with_http_info(continuation_token: Optional[str] = None, exclude_rules: 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, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ObjectStoreAccessPolicyGetResponse

GET object-store-access-policies

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

Parameters

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

• exclude_rules (bool) – If true, the rules field in each policy will be null. If false, each returned policy will include its list of rules in the response. If not specified, defaults to false.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

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

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

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

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_object_store_access_policies_object_store_users_delete_with_http_info(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 object-store-access-policies/object-store-users

Revokes an object store user’s access policy. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_object_store_access_policies_object_store_users_delete_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• member_ids (list[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• member_names (list[str]) – A comma-separated list of member names.

• policy_ids (list[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (list[str]) – A comma-separated list of policy 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.

api28_object_store_access_policies_object_store_users_get_with_http_info(continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, offset: Optional[int] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberGetResponse

GET object-store-access-policies/object-store-users

List object store users and their access policies. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_object_store_access_policies_object_store_users_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• filter (str) – Exclude resources that don’t match the specified criteria.

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

• member_ids (list[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• member_names (list[str]) – A comma-separated list of member names.

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

• policy_ids (list[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (list[str]) – A comma-separated list of policy names.

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

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_object_store_access_policies_object_store_users_post_with_http_info(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) → PolicyMemberResponse

POST object-store-access-policies/object-store-users

Grant access policies to an object store user. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_object_store_access_policies_object_store_users_post_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• member_ids (list[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• member_names (list[str]) – A comma-separated list of member names.

• policy_ids (list[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (list[str]) – A comma-separated list of policy 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

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

api28_object_store_access_policies_patch_with_http_info(enforce_action_restrictions: Optional[bool] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, policy: Optional[ObjectStoreAccessPolicyPatch] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ObjectStoreAccessPolicyResponse

PATCH object-store-access-policies

Modify the rules of an object store access policy. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_object_store_access_policies_patch_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• enforce_action_restrictions (bool) – Certain combinations of actions and other rule elements are inherently ignored if specified together in a rule. If set to true, operations which attempt to set these combinations will fail. If set to false, such operations will instead be allowed. Defaults to true.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• policy (ObjectStoreAccessPolicyPatch) –

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_object_store_access_policies_post_with_http_info(names: Optional[List[str]] = None, enforce_action_restrictions: Optional[bool] = None, policy: Optional[ObjectStoreAccessPolicyPost] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ObjectStoreAccessPolicyResponse

POST object-store-access-policies

Create a new access policy. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_object_store_access_policies_post_with_http_info(names, async_req=True) >>> result = thread.get()

Parameters

• names (list[str]) – A comma-separated list of resource names. (required)

• enforce_action_restrictions (bool) – Certain combinations of actions and other rule elements are inherently ignored if specified together in a rule. If set to true, operations which attempt to set these combinations will fail. If set to false, such operations will instead be allowed. Defaults to true.

• policy (ObjectStoreAccessPolicyPost) –

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_object_store_access_policies_rules_delete_with_http_info(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 object-store-access-policies-rules

Delete one or more access policy rules. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_object_store_access_policies_rules_delete_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• policy_ids (list[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (list[str]) – A comma-separated list of policy 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.

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

GET object-store-access-policies-rules

List access policy rules and their attributes. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_object_store_access_policies_rules_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• filter (str) – Exclude resources that don’t match the specified criteria.

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

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

• policy_ids (list[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (list[str]) – A comma-separated list of policy names.

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

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

• _return_http_data_only (bool) – Returns only data field.

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

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

Returns

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

api28_object_store_access_policies_rules_patch_with_http_info(rule: Optional[PolicyRuleObjectAccess] = None, enforce_action_restrictions: Optional[bool] = 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) → ObjectStoreAccessPolicyRuleResponse

PATCH object-store-access-policies-rules

Modify an access policy rule’s attributes. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_object_store_access_policies_rules_patch_with_http_info(rule, async_req=True) >>> result = thread.get()

Parameters

• rule (PolicyRuleObjectAccess) – (required)

• enforce_action_restrictions (bool) – Certain combinations of actions and other rule elements are inherently ignored if specified together in a rule. If set to true, operations which attempt to set these combinations will fail. If set to false, such operations will instead be allowed. Defaults to true.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• policy_ids (list[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (list[str]) – A comma-separated list of policy 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

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

api28_object_store_access_policies_rules_post_with_http_info(names: Optional[List[str]] = None, rule: Optional[PolicyRuleObjectAccessPost] = None, enforce_action_restrictions: Optional[bool] = 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) → ObjectStoreAccessPolicyRuleResponse

POST object-store-access-policies-rules

Create a new access policy rule. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_object_store_access_policies_rules_post_with_http_info(names, rule, async_req=True) >>> result = thread.get()

Parameters

• names (list[str]) – A comma-separated list of resource names. (required)

• rule (PolicyRuleObjectAccessPost) – (required)

• enforce_action_restrictions (bool) – Certain combinations of actions and other rule elements are inherently ignored if specified together in a rule. If set to true, operations which attempt to set these combinations will fail. If set to false, such operations will instead be allowed. Defaults to true.

• policy_ids (list[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (list[str]) – A comma-separated list of policy 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

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

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

GET object-store-access-policy-actions

List valid actions for access policy rules. Each action is either a valid AWS S3 action (prefixed by s3:) or our special wildcard action (s3:*). Each action, when included in a rule, may restrict which other properties may be set for that rule. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_object_store_access_policy_actions_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

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

• filter (str) – Exclude resources that don’t match the specified criteria.

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

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

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

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

• _return_http_data_only (bool) – Returns only data field.

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

• _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

ObjectStoreAccessPolicyActionGetResponse If the method is called asynchronously, returns the request thread.

pypureclient.flashblade.FB_2_8.api.policies___snapshot_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.8, developed by Pure Storage, Inc. (http://www.purestorage.com/).

OpenAPI spec version: 2.8

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.flashblade.FB_2_8.api.policies___snapshot_api.PoliciesSnapshotApi(api_client)

Bases: object

api28_policies_delete_with_http_info(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 policies

Delete one or more snapshot scheduling policies. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_policies_delete_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.

api28_policies_file_system_replica_links_delete_with_http_info(local_file_system_ids: Optional[List[str]] = None, local_file_system_names: Optional[List[str]] = None, member_ids: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, remote_ids: Optional[List[str]] = None, remote_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 policies/file-system-replica-links

Remove a snapshot scheduling policy mapped to a file system replica link. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_policies_file_system_replica_links_delete_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• local_file_system_ids (list[str]) – A comma-separated list of local file system 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_file_system_names query parameter.

• local_file_system_names (list[str]) – A comma-separated list of local file system names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with local_file_system_ids query parameter.

• member_ids (list[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• policy_ids (list[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (list[str]) – A comma-separated list of policy names.

• 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 there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with remote_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.

api28_policies_file_system_replica_links_get_with_http_info(continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, local_file_system_ids: Optional[List[str]] = None, local_file_system_names: Optional[List[str]] = None, member_ids: Optional[List[str]] = None, offset: Optional[int] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, remote_ids: Optional[List[str]] = None, remote_file_system_ids: Optional[List[str]] = None, remote_file_system_names: Optional[List[str]] = None, remote_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberWithRemoteGetResponse

GET policies/file-system-replica-links

List snapshot scheduling policies for file system replica links. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_policies_file_system_replica_links_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request.

• local_file_system_ids (list[str]) – A comma-separated list of local file system 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_file_system_names query parameter.

• local_file_system_names (list[str]) – A comma-separated list of local file system names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with local_file_system_ids query parameter.

• member_ids (list[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• offset (int) – The offset of the first resource to return from a collection.

• policy_ids (list[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (list[str]) – A comma-separated list of policy names.

• 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_file_system_ids (list[str]) – A comma-separated list of remote file system IDs. If 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_file_system_names query parameter.

• remote_file_system_names (list[str]) – A comma-separated list of remote file system names. If 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_file_system_ids query parameter.

• remote_names (list[str]) – A comma-separated list of remote array names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with remote_ids query parameter.

• sort (list[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is converted into objects.

• _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

PolicyMemberWithRemoteGetResponse If the method is called asynchronously, returns the request thread.

api28_policies_file_system_replica_links_post_with_http_info(local_file_system_ids: Optional[List[str]] = None, local_file_system_names: Optional[List[str]] = None, member_ids: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, remote_ids: Optional[List[str]] = None, remote_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberWithRemoteResponse

POST policies/file-system-replica-links

Add a snapshot scheduling policy to a file system replica link. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_policies_file_system_replica_links_post_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• local_file_system_ids (list[str]) – A comma-separated list of local file system 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_file_system_names query parameter.

• local_file_system_names (list[str]) – A comma-separated list of local file system names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with local_file_system_ids query parameter.

• member_ids (list[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• policy_ids (list[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (list[str]) – A comma-separated list of policy names.

• 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 there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with remote_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

PolicyMemberWithRemoteResponse If the method is called asynchronously, returns the request thread.

api28_policies_file_system_snapshots_delete_with_http_info(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 policies/file-system-snapshots

Remove the snapshot scheduling policy mapped to a file system. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_policies_file_system_snapshots_delete_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• member_ids (list[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• member_names (list[str]) – A comma-separated list of member names.

• policy_ids (list[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (list[str]) – A comma-separated list of policy 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.

api28_policies_file_system_snapshots_get_with_http_info(continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, offset: Optional[int] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyFileSystemSnapshotGetResponse

GET policies/file-system-snapshots

List file system snapshots mapped to a snapshot scheduling policy. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_policies_file_system_snapshots_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request.

• member_ids (list[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• member_names (list[str]) – A comma-separated list of member names.

• offset (int) – The offset of the first resource to return from a collection.

• policy_ids (list[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (list[str]) – A comma-separated list of policy names.

• sort (list[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is converted into objects.

• _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

PolicyFileSystemSnapshotGetResponse If the method is called asynchronously, returns the request thread.

api28_policies_file_systems_delete_with_http_info(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 policies/file-systems

Remove the snapshot scheduling policy mapped to a file system. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_policies_file_systems_delete_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• member_ids (list[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• member_names (list[str]) – A comma-separated list of member names.

• policy_ids (list[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (list[str]) – A comma-separated list of policy 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.

api28_policies_file_systems_get_with_http_info(continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, offset: Optional[int] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberGetResponse

GET policies/file-systems

List file systems mapped to a snapshot scheduling policy. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_policies_file_systems_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request.

• member_ids (list[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• member_names (list[str]) – A comma-separated list of member names.

• offset (int) – The offset of the first resource to return from a collection.

• policy_ids (list[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (list[str]) – A comma-separated list of policy names.

• sort (list[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is converted into objects.

• _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

PolicyMemberGetResponse If the method is called asynchronously, returns the request thread.

api28_policies_file_systems_post_with_http_info(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) → PolicyMemberResponse

POST policies/file-systems

Map a file system to a snapshot scheduling policy. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_policies_file_systems_post_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• member_ids (list[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• member_names (list[str]) – A comma-separated list of member names.

• policy_ids (list[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (list[str]) – A comma-separated list of policy 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

PolicyMemberResponse If the method is called asynchronously, returns the request thread.

api28_policies_get_with_http_info(continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyGetResponse

GET policies

Display snapshot scheduling policies and their attributes. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_policies_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (list[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is converted into objects.

• _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

PolicyGetResponse If the method is called asynchronously, returns the request thread.

api28_policies_members_get_with_http_info(continuation_token: str = None, filter: str = None, limit: int = None, local_file_system_ids: List[str] = None, local_file_system_names: List[str] = None, member_ids: List[str] = None, member_names: List[str] = None, member_types: List[models.ModelsFB28ResourceTypeYaml] = None, offset: int = None, policy_ids: List[str] = None, policy_names: List[str] = None, remote_ids: List[str] = None, remote_file_system_ids: List[str] = None, remote_file_system_names: List[str] = None, remote_names: List[str] = None, sort: List[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → models.PolicyMemberWithRemoteGetResponse

GET policies/members

List snapshot scheduling policies mapped to file systems, snapshots, and file system replica links. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_policies_members_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request.

• local_file_system_ids (list[str]) – A comma-separated list of local file system 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_file_system_names query parameter.

• local_file_system_names (list[str]) – A comma-separated list of local file system names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with local_file_system_ids query parameter.

• member_ids (list[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• member_names (list[str]) – A comma-separated list of member names.

• member_types (list[ModelsFB28ResourceTypeYaml]) – A comma-separated list of member types. Valid values are file-systems, file-system-snapshots, file-system-replica-links, and object-store-users. Different endpoints may accept different subsets of these values.

• offset (int) – The offset of the first resource to return from a collection.

• policy_ids (list[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (list[str]) – A comma-separated list of policy names.

• 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_file_system_ids (list[str]) – A comma-separated list of remote file system IDs. If 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_file_system_names query parameter.

• remote_file_system_names (list[str]) – A comma-separated list of remote file system names. If 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_file_system_ids query parameter.

• remote_names (list[str]) – A comma-separated list of remote array names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with remote_ids query parameter.

• sort (list[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is converted into objects.

• _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

PolicyMemberWithRemoteGetResponse If the method is called asynchronously, returns the request thread.

api28_policies_patch_with_http_info(policy: Optional[PolicyPatch] = None, ids: Optional[List[str]] = None, destroy_snapshots: 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) → PolicyResponse

PATCH policies

Modify a snapshot scheduling policy’s attributes for when and how often snapshots are created and how long they are retained. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_policies_patch_with_http_info(policy, async_req=True) >>> result = thread.get()

Parameters

• policy (PolicyPatch) – (required)

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• destroy_snapshots (bool) – This parameter must be set to true in order to modify a policy such that local or remote snapshots would be destroyed.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.

api28_policies_post_with_http_info(names: Optional[List[str]] = None, policy: Optional[Policy] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyResponse

POST policies

Create a new snapshot scheduling policy with rule attributes to capture file system snapshots for a set period of time and frequency, as well as how long snapshots are retained before being destroyed and eradicated. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_policies_post_with_http_info(names, async_req=True) >>> result = thread.get()

Parameters

• names (list[str]) – A comma-separated list of resource names. (required)

• policy (Policy) –

• async_req (bool) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.

pypureclient.flashblade.FB_2_8.api.policies__all_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.8, developed by Pure Storage, Inc. (http://www.purestorage.com/).

OpenAPI spec version: 2.8

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.flashblade.FB_2_8.api.policies__all_api.PoliciesAllApi(api_client)

Bases: object

api28_policies_all_get_with_http_info(continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyBaseGetResponse

GET policies-all

List all policies of all types. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_policies_all_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (list[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is converted into objects.

• _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

PolicyBaseGetResponse If the method is called asynchronously, returns the request thread.

api28_policies_all_members_get_with_http_info(continuation_token: str = None, filter: str = None, limit: int = None, local_file_system_ids: List[str] = None, local_file_system_names: List[str] = None, member_ids: List[str] = None, member_names: List[str] = None, member_types: List[models.ModelsFB28ResourceTypeYaml] = None, offset: int = None, policy_ids: List[str] = None, policy_names: List[str] = None, remote_ids: List[str] = None, remote_file_system_ids: List[str] = None, remote_file_system_names: List[str] = None, remote_names: List[str] = None, sort: List[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → models.PolicyMemberWithRemoteGetResponse

GET policies-all/members

List policies (of all types) mapped to other entities (file systems, snapshots, file system replica links, and object store users). This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_policies_all_members_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request.

• local_file_system_ids (list[str]) – A comma-separated list of local file system 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_file_system_names query parameter.

• local_file_system_names (list[str]) – A comma-separated list of local file system names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with local_file_system_ids query parameter.

• member_ids (list[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• member_names (list[str]) – A comma-separated list of member names.

• member_types (list[ModelsFB28ResourceTypeYaml]) – A comma-separated list of member types. Valid values are file-systems, file-system-snapshots, file-system-replica-links, and object-store-users. Different endpoints may accept different subsets of these values.

• offset (int) – The offset of the first resource to return from a collection.

• policy_ids (list[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (list[str]) – A comma-separated list of policy names.

• 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_file_system_ids (list[str]) – A comma-separated list of remote file system IDs. If 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_file_system_names query parameter.

• remote_file_system_names (list[str]) – A comma-separated list of remote file system names. If 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_file_system_ids query parameter.

• remote_names (list[str]) – A comma-separated list of remote array names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with remote_ids query parameter.

• sort (list[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is converted into objects.

• _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

PolicyMemberWithRemoteGetResponse If the method is called asynchronously, returns the request thread.

pypureclient.flashblade.FB_2_8.api.quotas_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.8, developed by Pure Storage, Inc. (http://www.purestorage.com/).

OpenAPI spec version: 2.8

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.flashblade.FB_2_8.api.quotas_api.QuotasApi(api_client)

Bases: object

api28_quotas_groups_delete_with_http_info(file_system_names: Optional[List[str]] = None, file_system_ids: Optional[List[str]] = None, gids: Optional[List[int]] = None, group_names: 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 quotas/groups

Delete a hard limit quota for a group. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_quotas_groups_delete_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• file_system_names (list[str]) – A comma-separated list of file system names. If there is not at least one resource that matches each of the elements of file_system_names, then an error is returned.

• file_system_ids (list[str]) – A comma-separated list of file system IDs. If after filtering, there is not at least one resource that matches each of the elements of file_system_ids, then an error is returned. This cannot be provided together with the file_system_names query parameter.

• gids (list[int]) – A comma-separated list of group IDs. If there is not at least one resource that matches each of the elements of gids, then an error is returned. This cannot be provided together with group_names query parameter.

• group_names (list[str]) – A comma-separated list of group names. If there is not at least one resource that matches each of the elements of group_names, then an error is returned. This cannot be provided together with gids query parameter.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.

api28_quotas_groups_get_with_http_info(continuation_token: Optional[str] = None, file_system_ids: Optional[List[str]] = None, file_system_names: Optional[List[str]] = None, filter: Optional[str] = None, gids: Optional[List[int]] = None, group_names: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → GroupQuotaGetResponse

GET quotas/groups

List groups with hard limit quotas. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_quotas_groups_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• file_system_ids (list[str]) – A comma-separated list of file system IDs. If after filtering, there is not at least one resource that matches each of the elements of file_system_ids, then an error is returned. This cannot be provided together with the file_system_names query parameter.

• file_system_names (list[str]) – A comma-separated list of file system names. If there is not at least one resource that matches each of the elements of file_system_names, then an error is returned.

• filter (str) – Exclude resources that don’t match the specified criteria.

• gids (list[int]) – A comma-separated list of group IDs. If there is not at least one resource that matches each of the elements of gids, then an error is returned. This cannot be provided together with group_names query parameter.

• group_names (list[str]) – A comma-separated list of group names. If there is not at least one resource that matches each of the elements of group_names, then an error is returned. This cannot be provided together with gids query parameter.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (list[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is converted into objects.

• _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

GroupQuotaGetResponse If the method is called asynchronously, returns the request thread.

api28_quotas_groups_patch_with_http_info(file_system_names: Optional[List[str]] = None, file_system_ids: Optional[List[str]] = None, gids: Optional[List[int]] = None, group_names: Optional[List[str]] = None, names: Optional[List[str]] = None, quota: Optional[GroupQuotaPatch] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → GroupQuotaResponse

PATCH quotas/groups

Modify a quota for a group. Note that if you modify a group’s quota to a lower value and that group’s usage has already exceeded the new value, writes will automatically halt until usage decreases below the new quota setting. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_quotas_groups_patch_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• file_system_names (list[str]) – A comma-separated list of file system names. If there is not at least one resource that matches each of the elements of file_system_names, then an error is returned.

• file_system_ids (list[str]) – A comma-separated list of file system IDs. If after filtering, there is not at least one resource that matches each of the elements of file_system_ids, then an error is returned. This cannot be provided together with the file_system_names query parameter.

• gids (list[int]) – A comma-separated list of group IDs. If there is not at least one resource that matches each of the elements of gids, then an error is returned. This cannot be provided together with group_names query parameter.

• group_names (list[str]) – A comma-separated list of group names. If there is not at least one resource that matches each of the elements of group_names, then an error is returned. This cannot be provided together with gids query parameter.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• quota (GroupQuotaPatch) –

• async_req (bool) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is converted into objects.

• _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

GroupQuotaResponse If the method is called asynchronously, returns the request thread.

api28_quotas_groups_post_with_http_info(file_system_ids: Optional[List[str]] = None, file_system_names: Optional[List[str]] = None, gids: Optional[List[int]] = None, group_names: Optional[List[str]] = None, quota: Optional[GroupQuotaPost] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → GroupQuotaResponse

POST quotas/groups

Create a hard limit quota for a group. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_quotas_groups_post_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• file_system_ids (list[str]) – A comma-separated list of file system IDs. If after filtering, there is not at least one resource that matches each of the elements of file_system_ids, then an error is returned. This cannot be provided together with the file_system_names query parameter.

• file_system_names (list[str]) – A comma-separated list of file system names. If there is not at least one resource that matches each of the elements of file_system_names, then an error is returned.

• gids (list[int]) – A comma-separated list of group IDs. If there is not at least one resource that matches each of the elements of gids, then an error is returned. This cannot be provided together with group_names query parameter.

• group_names (list[str]) – A comma-separated list of group names. If there is not at least one resource that matches each of the elements of group_names, then an error is returned. This cannot be provided together with gids query parameter.

• quota (GroupQuotaPost) –

• async_req (bool) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is converted into objects.

• _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

GroupQuotaResponse If the method is called asynchronously, returns the request thread.

api28_quotas_settings_get_with_http_info(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) → QuotaSettingGetResponse

GET quotas-settings

List notification attributes of a group or user quota. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_quotas_settings_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is converted into objects.

• _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

QuotaSettingGetResponse If the method is called asynchronously, returns the request thread.

api28_quotas_settings_patch_with_http_info(quota_setting: Optional[QuotaSetting] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → QuotaSettingResponse

PATCH quotas-settings

Modify the notification attributes of a group or user quota. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_quotas_settings_patch_with_http_info(quota_setting, async_req=True) >>> result = thread.get()

Parameters

• quota_setting (QuotaSetting) – (required)

• async_req (bool) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is converted into objects.

• _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

QuotaSettingResponse If the method is called asynchronously, returns the request thread.

api28_quotas_users_delete_with_http_info(file_system_names: Optional[List[str]] = None, file_system_ids: Optional[List[str]] = None, names: Optional[List[str]] = None, uids: Optional[List[int]] = None, user_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 quotas/users

Delete a hard limit file system quota for a user. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_quotas_users_delete_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• file_system_names (list[str]) – A comma-separated list of file system names. If there is not at least one resource that matches each of the elements of file_system_names, then an error is returned.

• file_system_ids (list[str]) – A comma-separated list of file system IDs. If after filtering, there is not at least one resource that matches each of the elements of file_system_ids, then an error is returned. This cannot be provided together with the file_system_names query parameter.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• uids (list[int]) – A comma-separated list of user IDs. If there is not at least one resource that matches each of the elements of uids, then an error is returned. This cannot be provided together with user_names query parameter.

• user_names (list[str]) – A comma-separated list of user names. If there is not at least one resource that matches each of the elements of user_names, then an error is returned. This cannot be provided together with uids 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.

api28_quotas_users_get_with_http_info(continuation_token: Optional[str] = None, file_system_ids: Optional[List[str]] = None, file_system_names: Optional[List[str]] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, uids: Optional[List[int]] = None, user_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → UserQuotaGetResponse

GET quotas/users

List users with hard limit file system quotas. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_quotas_users_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• file_system_ids (list[str]) – A comma-separated list of file system IDs. If after filtering, there is not at least one resource that matches each of the elements of file_system_ids, then an error is returned. This cannot be provided together with the file_system_names query parameter.

• file_system_names (list[str]) – A comma-separated list of file system names. If there is not at least one resource that matches each of the elements of file_system_names, then an error is returned.

• filter (str) – Exclude resources that don’t match the specified criteria.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (list[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• uids (list[int]) – A comma-separated list of user IDs. If there is not at least one resource that matches each of the elements of uids, then an error is returned. This cannot be provided together with user_names query parameter.

• user_names (list[str]) – A comma-separated list of user names. If there is not at least one resource that matches each of the elements of user_names, then an error is returned. This cannot be provided together with uids 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

UserQuotaGetResponse If the method is called asynchronously, returns the request thread.

api28_quotas_users_patch_with_http_info(file_system_names: Optional[List[str]] = None, file_system_ids: Optional[List[str]] = None, names: Optional[List[str]] = None, uids: Optional[List[int]] = None, user_names: Optional[List[str]] = None, quota: Optional[UserQuotaPatch] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → UserQuotaResponse

PATCH quotas/users

Modify the attributes of a hard limit file system quota. Note that if you modify a user’s quota to a lower value and that user’s usage has already exceeded the new value, writes will automatically halt until usage decreases below the new quota setting. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_quotas_users_patch_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• file_system_names (list[str]) – A comma-separated list of file system names. If there is not at least one resource that matches each of the elements of file_system_names, then an error is returned.

• file_system_ids (list[str]) – A comma-separated list of file system IDs. If after filtering, there is not at least one resource that matches each of the elements of file_system_ids, then an error is returned. This cannot be provided together with the file_system_names query parameter.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• uids (list[int]) – A comma-separated list of user IDs. If there is not at least one resource that matches each of the elements of uids, then an error is returned. This cannot be provided together with user_names query parameter.

• user_names (list[str]) – A comma-separated list of user names. If there is not at least one resource that matches each of the elements of user_names, then an error is returned. This cannot be provided together with uids query parameter.

• quota (UserQuotaPatch) –

• async_req (bool) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is converted into objects.

• _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

UserQuotaResponse If the method is called asynchronously, returns the request thread.

api28_quotas_users_post_with_http_info(file_system_ids: Optional[List[str]] = None, file_system_names: Optional[List[str]] = None, uids: Optional[List[int]] = None, user_names: Optional[List[str]] = None, quota: Optional[UserQuotaPost] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → UserQuotaResponse

POST quotas/users

Create a hard limit file system quota for a user. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_quotas_users_post_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• file_system_ids (list[str]) – A comma-separated list of file system IDs. If after filtering, there is not at least one resource that matches each of the elements of file_system_ids, then an error is returned. This cannot be provided together with the file_system_names query parameter.

• file_system_names (list[str]) – A comma-separated list of file system names. If there is not at least one resource that matches each of the elements of file_system_names, then an error is returned.

• uids (list[int]) – A comma-separated list of user IDs. If there is not at least one resource that matches each of the elements of uids, then an error is returned. This cannot be provided together with user_names query parameter.

• user_names (list[str]) – A comma-separated list of user names. If there is not at least one resource that matches each of the elements of user_names, then an error is returned. This cannot be provided together with uids query parameter.

• quota (UserQuotaPost) –

• async_req (bool) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is converted into objects.

• _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

UserQuotaResponse If the method is called asynchronously, returns the request thread.

pypureclient.flashblade.FB_2_8.api.rdl_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.8, developed by Pure Storage, Inc. (http://www.purestorage.com/).

OpenAPI spec version: 2.8

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.flashblade.FB_2_8.api.rdl_api.RDLApi(api_client)

Bases: object

api28_rapid_data_locking_get_with_http_info(async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → RapidDataLockingResponse

Get the status of the Rapid Data Locking feature.

Displays the status of the Rapid Data Locking feature. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_rapid_data_locking_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• async_req (bool) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is converted into objects.

• _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

RapidDataLockingResponse If the method is called asynchronously, returns the request thread.

api28_rapid_data_locking_patch_with_http_info(rapid_data_locking: Optional[RapidDataLocking] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → RapidDataLockingResponse

Modifies the Rapid Data Locking feature.

Modifies the Rapid Data Locking feature. Note that the feature can only be enabled if there are no file systems nor buckets created on the array. Once enabled, the feature cannot be modified. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_rapid_data_locking_patch_with_http_info(rapid_data_locking, async_req=True) >>> result = thread.get()

Parameters

• rapid_data_locking (RapidDataLocking) – (required)

• async_req (bool) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is converted into objects.

• _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

RapidDataLockingResponse If the method is called asynchronously, returns the request thread.

api28_rapid_data_locking_rotate_post_with_http_info(async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Rotates the external keys on the associated EKM appliance.

Rotates the external keys on the associated EKM appliance. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_rapid_data_locking_rotate_post_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• async_req (bool) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.

api28_rapid_data_locking_test_get_with_http_info(async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → TestResultResponse

Displays Rapid Data Locking test results.

Displays a detailed result of a Rapid Data Locking test. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_rapid_data_locking_test_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• async_req (bool) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is converted into objects.

• _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

TestResultResponse If the method is called asynchronously, returns the request thread.

pypureclient.flashblade.FB_2_8.api.roles_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.8, developed by Pure Storage, Inc. (http://www.purestorage.com/).

OpenAPI spec version: 2.8

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.flashblade.FB_2_8.api.roles_api.RolesApi(api_client)

Bases: object

api28_roles_get_with_http_info(continuation_token: Optional[str] = None, ids: Optional[List[str]] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → RoleGetResponse

GET roles

List roles and permission attributes for role-based access control (RBAC). This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_roles_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• filter (str) – Exclude resources that don’t match the specified criteria.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (list[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is converted into objects.

• _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

RoleGetResponse If the method is called asynchronously, returns the request thread.

pypureclient.flashblade.FB_2_8.api.sessions_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.8, developed by Pure Storage, Inc. (http://www.purestorage.com/).

OpenAPI spec version: 2.8

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.flashblade.FB_2_8.api.sessions_api.SessionsApi(api_client)

Bases: object

api28_sessions_get_with_http_info(continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SessionGetResponse

List session data

Displays session data for user login events performed in the Purity//FB 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.api28_sessions_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (list[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is converted into objects.

• _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

SessionGetResponse If the method is called asynchronously, returns the request thread.

pypureclient.flashblade.FB_2_8.api.smtp_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.8, developed by Pure Storage, Inc. (http://www.purestorage.com/).

OpenAPI spec version: 2.8

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.flashblade.FB_2_8.api.smtp_api.SMTPApi(api_client)

Bases: object

api28_smtp_servers_get_with_http_info(continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SmtpServerGetResponse

GET smtp-servers

List SMTP server attributes for the array network. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_smtp_servers_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (list[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is converted into objects.

• _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

SmtpServerGetResponse If the method is called asynchronously, returns the request thread.

api28_smtp_servers_patch_with_http_info(smtp: Optional[SmtpServer] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SmtpServerResponse

PATCH smtp-servers

Modify SMTP server attributes such as the relay host and sender domain. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_smtp_servers_patch_with_http_info(smtp, async_req=True) >>> result = thread.get()

Parameters

• smtp (SmtpServer) – (required)

• async_req (bool) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.flashblade.FB_2_8.api.snmp_agents_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.8, developed by Pure Storage, Inc. (http://www.purestorage.com/).

OpenAPI spec version: 2.8

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.flashblade.FB_2_8.api.snmp_agents_api.SNMPAgentsApi(api_client)

Bases: object

api28_snmp_agents_get_with_http_info(continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SnmpAgentGetResponse

GET snmp-agents

List SNMP agent attributes. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_snmp_agents_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (list[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is converted into objects.

• _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

SnmpAgentGetResponse If the method is called asynchronously, returns the request thread.

api28_snmp_agents_mib_get_with_http_info(async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SnmpAgentMibResponse

GET snmp-agents-mib

List 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.api28_snmp_agents_mib_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• async_req (bool) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is converted into objects.

• _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

SnmpAgentMibResponse If the method is called asynchronously, returns the request thread.

api28_snmp_agents_patch_with_http_info(snmp_agent: Optional[SnmpAgent] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SnmpAgentResponse

PATCH snmp-agents

Modify SNMP agent attributes. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_snmp_agents_patch_with_http_info(snmp_agent, async_req=True) >>> result = thread.get()

Parameters

• snmp_agent (SnmpAgent) – (required)

• async_req (bool) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.flashblade.FB_2_8.api.snmp_managers_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.8, developed by Pure Storage, Inc. (http://www.purestorage.com/).

OpenAPI spec version: 2.8

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.flashblade.FB_2_8.api.snmp_managers_api.SNMPManagersApi(api_client)

Bases: object

api28_snmp_managers_delete_with_http_info(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 snmp-managers

Remove an SNMP manager. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_snmp_managers_delete_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.

api28_snmp_managers_get_with_http_info(continuation_token: Optional[str] = None, ids: Optional[List[str]] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SnmpManagerGetResponse

GET snmp-managers

List SNMP managers and their attributes. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_snmp_managers_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• filter (str) – Exclude resources that don’t match the specified criteria.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (list[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is converted into objects.

• _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

SnmpManagerGetResponse If the method is called asynchronously, returns the request thread.

api28_snmp_managers_patch_with_http_info(snmp_manager: Optional[SnmpManager] = 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) → SnmpManagerResponse

PATCH snmp-managers

Modify SNMP manager attributes such as versions. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_snmp_managers_patch_with_http_info(snmp_manager, async_req=True) >>> result = thread.get()

Parameters

• snmp_manager (SnmpManager) – (required)

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.

api28_snmp_managers_post_with_http_info(snmp_manager: Optional[SnmpManagerPost] = 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

POST snmp-managers

Create an SNMP manager. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_snmp_managers_post_with_http_info(snmp_manager, names, async_req=True) >>> result = thread.get()

Parameters

• snmp_manager (SnmpManagerPost) – (required)

• names (list[str]) – A comma-separated list of resource names. (required)

• async_req (bool) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.

api28_snmp_managers_test_get_with_http_info(continuation_token: Optional[str] = None, ids: Optional[List[str]] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → TestResultGetResponse

GET snmp-managers/test

Test if the configuration of an SNMP manager is valid. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_snmp_managers_test_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• filter (str) – Exclude resources that don’t match the specified criteria.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (list[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is converted into objects.

• _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

TestResultGetResponse If the method is called asynchronously, returns the request thread.

pypureclient.flashblade.FB_2_8.api.subnets_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.8, developed by Pure Storage, Inc. (http://www.purestorage.com/).

OpenAPI spec version: 2.8

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.flashblade.FB_2_8.api.subnets_api.SubnetsApi(api_client)

Bases: object

api28_subnets_delete_with_http_info(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 subnets

Remove an array subnet. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_subnets_delete_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.

api28_subnets_get_with_http_info(continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SubnetGetResponse

GET subnets

List the array’s subnets. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_subnets_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (list[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is converted into objects.

• _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

SubnetGetResponse If the method is called asynchronously, returns the request thread.

api28_subnets_patch_with_http_info(subnet: Optional[Subnet] = 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) → SubnetResponse

PATCH subnets

Modify array subnet attributes. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_subnets_patch_with_http_info(subnet, async_req=True) >>> result = thread.get()

Parameters

• subnet (Subnet) – (required)

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.

api28_subnets_post_with_http_info(subnet: Optional[Subnet] = 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

POST subnets

Create an array subnet. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_subnets_post_with_http_info(subnet, names, async_req=True) >>> result = thread.get()

Parameters

• subnet (Subnet) – (required)

• names (list[str]) – A comma-separated list of resource names. (required)

• async_req (bool) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.flashblade.FB_2_8.api.support_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.8, developed by Pure Storage, Inc. (http://www.purestorage.com/).

OpenAPI spec version: 2.8

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.flashblade.FB_2_8.api.support_api.SupportApi(api_client)

Bases: object

api28_support_get_with_http_info(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) → SupportGetResponse

GET support

List Phone Home and Remote Assistance settings. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_support_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.

api28_support_patch_with_http_info(support: Optional[Support] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SupportResponse

PATCH support

Modify Phone Home and Remote Assistance settings. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_support_patch_with_http_info(support, async_req=True) >>> result = thread.get()

Parameters

• support (Support) – (required)

• async_req (bool) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.

api28_support_test_get_with_http_info(filter: Optional[str] = None, sort: Optional[List[str]] = None, test_type: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → TestResultGetResponse

GET support-test

Test if the Phone Home and Remote Assistance settings are functioning properly. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_support_test_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• filter (str) – Exclude resources that don’t match the specified criteria.

• sort (list[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• test_type (str) – Specify the type of test. Valid values are all, phonehome and remote-assist. If not specified, defaults to all.

• async_req (bool) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.flashblade.FB_2_8.api.syslog_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.8, developed by Pure Storage, Inc. (http://www.purestorage.com/).

OpenAPI spec version: 2.8

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.flashblade.FB_2_8.api.syslog_api.SyslogApi(api_client)

Bases: object

api28_syslog_servers_delete_with_http_info(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 syslog-servers

Delete 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.api28_syslog_servers_delete_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• 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.

api28_syslog_servers_get_with_http_info(continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SyslogServerGetResponse

GET syslog-servers

Return 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.api28_syslog_servers_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request.

• 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 offset of the first resource to return from a collection.

• sort (list[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is converted into objects.

• _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

SyslogServerGetResponse If the method is called asynchronously, returns the request thread.

api28_syslog_servers_patch_with_http_info(syslog_server: Optional[SyslogServerPostOrPatch] = 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) → SyslogServerResponse

PATCH syslog-servers

Modify 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.api28_syslog_servers_patch_with_http_info(syslog_server, async_req=True) >>> result = thread.get()

Parameters

• syslog_server (SyslogServerPostOrPatch) – (required)

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• 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.

api28_syslog_servers_post_with_http_info(syslog_server: Optional[SyslogServerPostOrPatch] = 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

POST syslog-servers

Configure 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.api28_syslog_servers_post_with_http_info(syslog_server, async_req=True) >>> result = thread.get()

Parameters

• syslog_server (SyslogServerPostOrPatch) – (required)

• 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.

api28_syslog_servers_settings_get_with_http_info(continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SyslogServerSettingsGetResponse

GET syslog-servers/settings

List the certificate or certificate group associated with the syslog servers. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_syslog_servers_settings_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (list[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is converted into objects.

• _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

SyslogServerSettingsGetResponse If the method is called asynchronously, returns the request thread.

api28_syslog_servers_settings_patch_with_http_info(syslog_server_settings: Optional[SyslogServerSettings] = 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) → SyslogServerSettingsResponse

PATCH syslog-servers/settings

Modify the certificate or certificate group associated with the syslog servers. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_syslog_servers_settings_patch_with_http_info(syslog_server_settings, async_req=True) >>> result = thread.get()

Parameters

• syslog_server_settings (SyslogServerSettings) – (required)

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.

api28_syslog_servers_test_get_with_http_info(continuation_token: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → TestResultGetResponse

GET syslog-servers/test

Send test messages to conifgured remote syslog servers. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_syslog_servers_test_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• async_req (bool) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.flashblade.FB_2_8.api.targets_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.8, developed by Pure Storage, Inc. (http://www.purestorage.com/).

OpenAPI spec version: 2.8

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.flashblade.FB_2_8.api.targets_api.TargetsApi(api_client)

Bases: object

api28_targets_delete_with_http_info(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 targets

Delete the connection to the target for replication. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_targets_delete_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is 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.

api28_targets_get_with_http_info(continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → TargetGetResponse

GET targets

List targets used for replication. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_targets_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (list[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is converted into objects.

• _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

TargetGetResponse If the method is called asynchronously, returns the request thread.

api28_targets_patch_with_http_info(target: Optional[Target] = 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) → TargetResponse

PATCH targets

Modify the target attributes for replication. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_targets_patch_with_http_info(target, async_req=True) >>> result = thread.get()

Parameters

• target (Target) – (required)

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is converted into objects.

• _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

TargetResponse If the method is called asynchronously, returns the request thread.

api28_targets_performance_replication_get_with_http_info(continuation_token: Optional[str] = None, end_time: Optional[int] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, resolution: Optional[int] = None, sort: Optional[List[str]] = None, start_time: Optional[int] = 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) → ResourcePerformanceReplicationGetResponse

GET targets/performance/replication

List replication performance metrics for targets. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_targets_performance_replication_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• end_time (int) – When the time window ends (in milliseconds since epoch).

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (list[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request.

• names (list[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• resolution (int) – The desired ms between samples. Available resolutions may depend on data type, start_time and end_time. In general 1000, 30000, 300000, 1800000, 7200000, and 86400000 are possible values.

• sort (list[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• start_time (int) – When the time window starts (in milliseconds since epoch).

• total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. 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

ResourcePerformanceReplicationGetResponse If the method is called asynchronously, returns the request thread.

api28_targets_post_with_http_info(names: Optional[List[str]] = None, target: Optional[TargetPost] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → TargetResponse

POST targets

Add a target for replication. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_targets_post_with_http_info(names, target, async_req=True) >>> result = thread.get()

Parameters

• names (list[str]) – A comma-separated list of resource names. (required)

• target (TargetPost) – (required)

• async_req (bool) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is converted into objects.

• _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

TargetResponse If the method is called asynchronously, returns the request thread.

pypureclient.flashblade.FB_2_8.api.usage_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.8, developed by Pure Storage, Inc. (http://www.purestorage.com/).

OpenAPI spec version: 2.8

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.flashblade.FB_2_8.api.usage_api.UsageApi(api_client)

Bases: object

api28_usage_groups_get_with_http_info(continuation_token: Optional[str] = None, file_system_ids: Optional[List[str]] = None, file_system_names: Optional[List[str]] = None, filter: Optional[str] = None, gids: Optional[List[int]] = None, group_names: Optional[List[str]] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → GroupQuotaGetResponse

GET usage/groups

List groups with hard limit quotas and their file system usage. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_usage_groups_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• file_system_ids (list[str]) – A comma-separated list of file system IDs. If after filtering, there is not at least one resource that matches each of the elements of file_system_ids, then an error is returned. This cannot be provided together with the file_system_names query parameter.

• file_system_names (list[str]) – A comma-separated list of file system names. If there is not at least one resource that matches each of the elements of file_system_names, then an error is returned.

• filter (str) – Exclude resources that don’t match the specified criteria.

• gids (list[int]) – A comma-separated list of group IDs. If there is not at least one resource that matches each of the elements of gids, then an error is returned. This cannot be provided together with group_names query parameter.

• group_names (list[str]) – A comma-separated list of group names. If there is not at least one resource that matches each of the elements of group_names, then an error is returned. This cannot be provided together with gids query parameter.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request.

• offset (int) – The offset of the first resource to return from a collection.

• sort (list[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is converted into objects.

• _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

GroupQuotaGetResponse If the method is called asynchronously, returns the request thread.

api28_usage_users_get_with_http_info(continuation_token: Optional[str] = None, file_system_ids: Optional[List[str]] = None, file_system_names: Optional[List[str]] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, uids: Optional[List[int]] = None, user_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → UserQuotaGetResponse

GET usage/users

List users with hard limit quotas and their file system usage. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_usage_users_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• file_system_ids (list[str]) – A comma-separated list of file system IDs. If after filtering, there is not at least one resource that matches each of the elements of file_system_ids, then an error is returned. This cannot be provided together with the file_system_names query parameter.

• file_system_names (list[str]) – A comma-separated list of file system names. If there is not at least one resource that matches each of the elements of file_system_names, then an error is returned.

• filter (str) – Exclude resources that don’t match the specified criteria.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request.

• offset (int) – The offset of the first resource to return from a collection.

• sort (list[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• uids (list[int]) – A comma-separated list of user IDs. If there is not at least one resource that matches each of the elements of uids, then an error is returned. This cannot be provided together with user_names query parameter.

• user_names (list[str]) – A comma-separated list of user names. If there is not at least one resource that matches each of the elements of user_names, then an error is returned. This cannot be provided together with uids 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

UserQuotaGetResponse If the method is called asynchronously, returns the request thread.

pypureclient.flashblade.FB_2_8.api.verification_keys_api module

FlashBlade REST API

A lightweight client for FlashBlade REST API 2.8, developed by Pure Storage, Inc. (http://www.purestorage.com/).

OpenAPI spec version: 2.8

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.flashblade.FB_2_8.api.verification_keys_api.VerificationKeysApi(api_client)

Bases: object

api28_support_verification_keys_get_with_http_info(continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → VerificationKeyGetResponse

GET verification-keys

List the key used to verify the signed challenges that are used by Pure Support to access the FlashBlade. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_support_verification_keys_get_with_http_info(async_req=True) >>> result = thread.get()

Parameters

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client’s page size request.

• offset (int) – The offset of the first resource to return from a collection.

• sort (list[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is converted into objects.

• _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

VerificationKeyGetResponse If the method is called asynchronously, returns the request thread.

api28_support_verification_keys_patch_with_http_info(key: Optional[VerificationKeyPatch] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → VerificationKeyResponse

PATCH verification-keys

Update the key used to verify the signed challenges that are used by Pure Support to access the FlashBlade. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.api28_support_verification_keys_patch_with_http_info(key, async_req=True) >>> result = thread.get()

Parameters

• key (VerificationKeyPatch) – (required)

• async_req (bool) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

• _return_http_data_only (bool) – Returns only data field.

• _preload_content (bool) – Response is converted into objects.

• _request_timeout (int) – Total request timeout in seconds. It can also be a tuple of (connection time, read time) timeouts.

Returns

VerificationKeyResponse If the method is called asynchronously, returns the request thread.

Module contents