pypureclient.flashblade.FB_2_8 package

Subpackages

Submodules

pypureclient.flashblade.FB_2_8.api_client 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_client.ApiClient(configuration=None, header_name=None, header_value=None, cookie=None)

Bases: object

Generic API client for Swagger client library builds.

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

Parameters

  • configuration – .Configuration object for this client

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

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

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

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

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

To make an async request, set the async_req parameter.

Parameters

  • resource_path – Path to method endpoint.

  • method – Method to call.

  • path_params – Path parameters in the url.

  • query_params – Query parameters in the url.

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

  • body – Request body.

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

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

  • response – Response data type.

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

  • bool (async_req) – execute request asynchronously

  • _return_http_data_only – response data without head status code and headers

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

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

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

Returns

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

close()
deserialize(response, response_type)

Deserializes response into an object.

Parameters

  • response – RESTResponse object to be deserialized.

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

Returns

deserialized object.

extract_object_dict_from_object(obj)

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

parameters_to_tuples(params, collection_formats)

Get parameters as list of tuples, formatting collections.

Parameters

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

  • collection_formats (dict) – Parameter collection formats

Returns

Parameters as list of tuples, collections formatted

prepare_post_parameters(post_params=None, files=None)

Builds form parameters.

Parameters

  • post_params – Normal form parameters.

  • files – File parameters.

Returns

Form parameters with files.

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

Makes the HTTP request using RESTClient.

sanitize_for_serialization(obj)

Builds a JSON POST object.

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

convert to string in iso8601 format.

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

Parameters

obj – The data to serialize.

Returns

The serialized form of data.

select_header_accept(accepts)

Returns Accept based on an array of accepts provided.

Parameters

accepts – List of headers.

Returns

Accept (e.g. application/json).

select_header_content_type(content_types)

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

Parameters

content_types – List of content-types.

Returns

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

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

Updates header and query params based on authentication setting.

Parameters

  • headers – Header parameters dict to be updated.

  • querys – Query parameters tuple list to be updated.

  • auth_settings – Authentication setting identifiers list.

property user_agent

User agent for this API client

pypureclient.flashblade.FB_2_8.client module

class pypureclient.flashblade.FB_2_8.client.Client(target, id_token=None, private_key_file=None, private_key_password=None, username=None, client_id=None, key_id=None, issuer=None, api_token=None, retries=5, timeout=15.0, ssl_cert=None, user_agent=None, verify_ssl=None)

Bases: object

DEFAULT_RETRIES = 5
DEFAULT_TIMEOUT = 15.0
USER_AGENT = 'pypureclient/1.52.0/FB/2.8/Linux/5.15.0-25-generic'
__init__(target, id_token=None, private_key_file=None, private_key_password=None, username=None, client_id=None, key_id=None, issuer=None, api_token=None, retries=5, timeout=15.0, ssl_cert=None, user_agent=None, verify_ssl=None)

Initialize a FlashBlade Client. id_token is generated based on app ID and private key info. Either id_token or api_token could be used for authentication. Only one authentication option is allowed.

Keyword Arguments

  • target (str, required) – The target array’s IP or hostname.

  • id_token (str, optional) – The security token that represents the identity of the party on behalf of whom the request is being made, issued by an enabled API client on the array. Overrides given private key.

  • private_key_file (str, optional) – The path of the private key to use. Defaults to None.

  • private_key_password (str, optional) – The password of the private key. Defaults to None.

  • username (str, optional) – Username of the user the token should be issued for. This must be a valid user in the system.

  • client_id (str, optional) – ID of API client that issued the identity token.

  • key_id (str, optional) – Key ID of API client that issued the identity token.

  • issuer (str, optional) – API client’s trusted identity issuer on the array.

  • api_token (str, optional) – API token for the user.

  • retries (int, optional) – The number of times to retry an API call if it fails for a non-blocking reason. Defaults to 5.

  • timeout (float or (float, float), optional) – The timeout duration in seconds, either in total time or (connect and read) times. Defaults to 15.0 total.

  • ssl_cert (str, optional) – SSL certificate to use. Defaults to None.

  • user_agent (str, optional) – User-Agent request header to use.

  • verify_ssl (bool | str, optional) – Controls SSL certificate validation. True specifies that the server validation uses default trust anchors; False switches certificate validation off, not safe!; It also accepts string value for a path to directory with certificates.

Raises

PureError – If it could not create an ID or access token

configure_ca_certificate_file(ca_certs_file_path)

” :param ca_certs_file_path: The path to the CA certificate(s) file to use. :return:

delete_active_directory(references: Optional[List[ReferenceType]] = None, 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 an Active Directory account.

Parameters

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_admins_api_tokens(admins: Optional[List[ReferenceType]] = None, 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

Deletes the API tokens of the specified administrators.

Parameters

  • admins (list[FixedReference], optional) – A list of admins to query for. Overrides admin_ids and admin_names keyword arguments.

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_admins_cache(references: Optional[List[ReferenceType]] = 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 cached administrator role information by name or ID.

Parameters

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_alert_watchers(references: Optional[List[ReferenceType]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Delete an alert watcher.

Parameters

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_api_clients(references: Optional[List[ReferenceType]] = 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 the API client.

Parameters

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_array_connections(references: Optional[List[ReferenceType]] = None, remotes: Optional[List[ReferenceType]] = 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) → None

Delete a connection to an array.

Parameters

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

  • remotes (list[FixedReference], optional) – A list of remotes to query for. Overrides remote_ids and remote_names keyword arguments.

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

Deletes any existing token that could be used to perform a factory reset on the array.

Parameters

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

Delete a bucket replica link.

Parameters

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

  • local_buckets (list[FixedReference], optional) – A list of local_buckets to query for. Overrides local_bucket_ids and local_bucket_names keyword arguments.

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

  • remotes (list[FixedReference], optional) – A list of remotes to query for. Overrides remote_ids and remote_names keyword arguments.

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_buckets(references: Optional[List[ReferenceType]] = 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 object store buckets.

Parameters

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_certificate_groups(references: Optional[List[ReferenceType]] = 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 one or more certificate groups from the array.

Parameters

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_certificate_groups_certificates(certificates: Optional[List[ReferenceType]] = None, certificate_groups: Optional[List[ReferenceType]] = 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, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Delete one or more certificate groups.

Parameters

  • certificates (list[FixedReference], optional) – A list of certificates to query for. Overrides certificate_ids and certificate_names keyword arguments.

  • certificate_groups (list[FixedReference], optional) – A list of certificate_groups to query for. Overrides certificate_group_ids and certificate_group_names keyword arguments.

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_certificates(references: Optional[List[ReferenceType]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Delete a CA certificate from the array.

Parameters

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_certificates_certificate_groups(certificates: Optional[List[ReferenceType]] = None, certificate_groups: Optional[List[ReferenceType]] = 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, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Remove one or more certificates from one or more certificate groups.

Parameters

  • certificates (list[FixedReference], optional) – A list of certificates to query for. Overrides certificate_ids and certificate_names keyword arguments.

  • certificate_groups (list[FixedReference], optional) – A list of certificate_groups to query for. Overrides certificate_group_ids and certificate_group_names keyword arguments.

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

Remove a policy from a file system replication link.

Parameters

  • local_file_systems (list[FixedReference], optional) – A list of local_file_systems to query for. Overrides local_file_system_ids and local_file_system_names keyword arguments.

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

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

  • remotes (list[FixedReference], optional) – A list of remotes to query for. Overrides remote_ids and remote_names keyword arguments.

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_file_system_snapshots(references: Optional[List[ReferenceType]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Delete a file system snapshot.

Parameters

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_file_system_snapshots_policies(members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Remove snapshot scheduling policies from a file system.

Parameters

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_file_system_snapshots_transfer(references: Optional[List[ReferenceType]] = None, remotes: Optional[List[ReferenceType]] = None, 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 snapshot transfers from the source array to the target array.

Parameters

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

  • remotes (list[FixedReference], optional) – A list of remotes to query for. Overrides remote_names and remote_ids keyword arguments.

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_file_systems(references: Optional[List[ReferenceType]] = 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

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.

Parameters

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_file_systems_locks(clients: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, 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

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.

Parameters

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_file_systems_policies(members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Remove a snapshot scheduling policy from a file system.

Parameters

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_keytabs(references: Optional[List[ReferenceType]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Delete a Kerberos keytab file.

Parameters

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_kmip(references: Optional[List[ReferenceType]] = None, names: Optional[List[str]] = None, ids: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Deletes a KMIP server configuration. A server can only be deleted when not in use by the array.

Parameters

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_lifecycle_rules(buckets: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, 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

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.

Parameters

  • buckets (list[FixedReference], optional) – A list of buckets to query for. Overrides bucket_ids and bucket_names keyword arguments.

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

Remove a link aggregation group to unbind the ports.

Parameters

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_network_interfaces(references: Optional[List[ReferenceType]] = 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

Remove a data VIP. Once removed, any clients connected through the data VIP will lose their connection to the file system.

Parameters

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_nfs_export_policies(references: Optional[List[ReferenceType]] = 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) → None

Delete one or more NFS export policies.

Parameters

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_nfs_export_policies_rules(references: Optional[List[ReferenceType]] = 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) → None

Delete one or more NFS export policy rules. One of the following is required: ids or names.

Parameters

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

Delete an object store access key. Once an access key has been deleted, it cannot be recovered.

Parameters

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

  • names (list[str], required) – A list of resource names.

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_object_store_access_policies(references: Optional[List[ReferenceType]] = 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 one or more access policies.

Parameters

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_object_store_access_policies_object_store_users(members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Revokes an object store user’s access policy.

Parameters

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_object_store_access_policies_rules(references: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Delete one or more access policy rules.

Parameters

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_object_store_accounts(references: Optional[List[ReferenceType]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Delete an object store account.

Parameters

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_object_store_remote_credentials(references: Optional[List[ReferenceType]] = 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 object store remote credentials.

Parameters

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_object_store_users(references: Optional[List[ReferenceType]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Delete an object store user.

Parameters

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_object_store_users_object_store_access_policies(members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Revoke an object store user’s access policy.

Parameters

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_object_store_virtual_hosts(references: Optional[List[ReferenceType]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Delete an object store virtual host.

Parameters

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_policies(references: Optional[List[ReferenceType]] = 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 one or more snapshot scheduling policies.

Parameters

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

Remove a snapshot scheduling policy mapped to a file system replica link.

Parameters

  • local_file_systems (list[FixedReference], optional) – A list of local_file_systems to query for. Overrides local_file_system_ids and local_file_system_names keyword arguments.

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

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

  • remotes (list[FixedReference], optional) – A list of remotes to query for. Overrides remote_ids and remote_names keyword arguments.

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_policies_file_system_snapshots(members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Remove the snapshot scheduling policy mapped to a file system.

Parameters

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_policies_file_systems(members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Remove the snapshot scheduling policy mapped to a file system.

Parameters

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_quotas_groups(file_systems: Optional[List[ReferenceType]] = None, groups: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, 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 a hard limit quota for a group.

Parameters

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_quotas_users(file_systems: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, users: Optional[List[ReferenceType]] = None, 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 a hard limit file system quota for a user.

Parameters

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_snmp_managers(references: Optional[List[ReferenceType]] = 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

Remove an SNMP manager.

Parameters

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_subnets(references: Optional[List[ReferenceType]] = 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

Remove an array subnet.

Parameters

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_syslog_servers(references: Optional[List[ReferenceType]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Delete a configured syslog server and stop forwarding syslog messages.

Parameters

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

  • ids (list[str], optional) – A 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], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_targets(references: Optional[List[ReferenceType]] = 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 the connection to the target for replication.

Parameters

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

disable_verify_ssl()

Change our certificate requirements so that a certificate is not validated.

enable_verify_ssl(ca_certs_file_path=None)

Change our certificate requirements so that a certificate is required and validated. Optionally, if a CA certificate(s) file path is provided, configure the client to use that CA certificate file.

get_access_token(refresh=False)

Get the last used access token.

Parameters

refresh (bool, optional) – Whether to retrieve a new access token. Defaults to False.

Returns

str

Raises

PureError – If there was an error retrieving an access token.

get_active_directory(references: Optional[List[ReferenceType]] = 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) → ActiveDirectoryGetResponse

List an Active Directory account and its configuration.

Parameters

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

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

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

  • ids (list[str], optional) – A list of resource IDs. If 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

get_active_directory_test(references: Optional[List[ReferenceType]] = None, 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

Testing if the configuration of an Active Directory account is valid.

Parameters

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

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

  • ids (list[str], optional) – A 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

get_admins(references: Optional[List[ReferenceType]] = None, 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

List the administrator’s attributes, including the API token and public key.

Parameters

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

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

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

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

  • ids (list[str], optional) – A 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

get_admins_api_tokens(admins: Optional[List[ReferenceType]] = None, 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

Displays API tokens for the specified administrators.

Parameters

  • admins (list[FixedReference], optional) – A list of admins to query for. Overrides admin_ids and admin_names keyword arguments.

  • admin_ids (list[str], optional) – A 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], optional) – A 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, optional) – An opaque token to iterate over a collection of resources.

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

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

get_admins_cache(references: Optional[List[ReferenceType]] = 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, 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

List cached administrator information used to determine role based access control privileges.

Parameters

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

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

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

  • ids (list[str], optional) – A list of resource IDs. If 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

Return global admin settings.

Parameters

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

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

get_alert_watchers(references: Optional[List[ReferenceType]] = 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) → AlertWatcherGetResponse

List alert watchers that are configured to receive alert messages.

Parameters

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

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

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

  • ids (list[str], optional) – A list of resource IDs. If 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

get_alert_watchers_test(references: Optional[List[ReferenceType]] = None, 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

Test an alert watcher’s contact information to verify alerts can be sent and received.

Parameters

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

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

  • ids (list[str], optional) – A 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], optional) – A 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[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

get_alerts(references: Optional[List[ReferenceType]] = 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) → AlertGetResponse

Returns a list of alerts which have been generated by the array.

Parameters

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

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

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

  • ids (list[str], optional) – A list of resource IDs. If 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

get_api_clients(references: Optional[List[ReferenceType]] = 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) → ApiClientsResponse

List an API client and its configuration attributes.

Parameters

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

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

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

  • ids (list[str], optional) – A list of resource IDs. If 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

get_array_connections(references: Optional[List[ReferenceType]] = None, remotes: Optional[List[ReferenceType]] = None, 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

List connected arrays for replication.

Parameters

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

  • remotes (list[FixedReference], optional) – A list of remotes to query for. Overrides remote_ids and remote_names keyword arguments.

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

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

  • ids (list[str], optional) – A list of resource IDs. If 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

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

  • remote_ids (list[str], optional) – A 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], optional) – A 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[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

get_array_connections_connection_key(references: Optional[List[ReferenceType]] = 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) → ArrayConnectionKeyGetResponse

List connection keys used to authenticate the connection from one array to another.

Parameters

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

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

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

  • ids (list[str], optional) – A list of resource IDs. If 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

get_array_connections_path(references: Optional[List[ReferenceType]] = None, remotes: Optional[List[ReferenceType]] = None, 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

List network path details of connected arrays.

Parameters

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

  • remotes (list[FixedReference], optional) – A list of remotes to query for. Overrides remote_ids and remote_names keyword arguments.

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

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

  • ids (list[str], optional) – A list of resource IDs. If 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

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

  • remote_ids (list[str], optional) – A 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], optional) – A 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[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

get_array_connections_performance_replication(references: Optional[List[ReferenceType]] = None, remotes: Optional[List[ReferenceType]] = None, 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

List performance metrics of file systems or objects being replicated from one array to another.

Parameters

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

  • remotes (list[FixedReference], optional) – A list of remotes to query for. Overrides remote_ids and remote_names keyword arguments.

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

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

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

  • ids (list[str], optional) – A 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

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

  • remote_ids (list[str], optional) – A 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], optional) – A 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, optional) – 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[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

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

  • total_only (bool, optional) – 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, optional) – 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

List array attributes such as the array name, ID, version, and NTP servers.

Parameters

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

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

get_arrays_clients_performance(references: Optional[List[ReferenceType]] = None, 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

List NFS client I/O performance metrics.

Parameters

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

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

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

  • names (list[str], optional) – A 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[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_only (bool, optional) – 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

List the End User Agreement and signature.

Parameters

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

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

Displays a list of tokens used to perform a factory reset on the array.

Parameters

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

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

List the HTTP performance metrics of the array.

Parameters

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

  • resolution (int, optional) – 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, optional) – When the time window starts (in milliseconds since epoch).

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

List the NFS performance metrics of the array.

Parameters

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

  • resolution (int, optional) – 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, optional) – When the time window starts (in milliseconds since epoch).

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

Lists the overall performance metrics of the array.

Parameters

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

  • protocol (str, optional) – 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, optional) – 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, optional) – When the time window starts (in milliseconds since epoch).

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

List replication performance metrics.

Parameters

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

  • resolution (int, optional) – 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, optional) – When the time window starts (in milliseconds since epoch).

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

List the S3 performance metrics of the array.

Parameters

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

  • resolution (int, optional) – 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, optional) – When the time window starts (in milliseconds since epoch).

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

List available and used storage space on the array.

Parameters

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

  • resolution (int, optional) – 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, optional) – When the time window starts (in milliseconds since epoch).

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

get_arrays_supported_time_zones(references: Optional[List[ReferenceType]] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ArraysSupportedTimeZonesGetResponse

List supported time zones for the array.

Parameters

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

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

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

get_audits(references: Optional[List[ReferenceType]] = None, 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

List the array audit trail to view activities that were performed on the array.

Parameters

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

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

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

  • ids (list[str], optional) – A list of resource IDs. If 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

get_blades(references: Optional[List[ReferenceType]] = None, 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

List array blade information.

Parameters

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

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

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

  • ids (list[str], optional) – A list of resource IDs. If 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

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

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

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

  • total_only (bool, optional) – 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

List bucket replica links for object replication.

Parameters

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

  • local_buckets (list[FixedReference], optional) – A list of local_buckets to query for. Overrides local_bucket_ids and local_bucket_names keyword arguments.

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

  • remotes (list[FixedReference], optional) – A list of remotes to query for. Overrides remote_ids and remote_names keyword arguments.

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

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

  • ids (list[str], optional) – A list of resource IDs. If 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

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

  • remote_bucket_names (list[str], optional) – A 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], optional) – A 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], optional) – A 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[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_only (bool, optional) – 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

get_buckets(references: Optional[List[ReferenceType]] = None, 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

List object store bucket attributes such as creation time and space usage.

Parameters

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

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

  • destroyed (bool, optional) – 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 (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

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

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

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

  • total_only (bool, optional) – 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

get_buckets_performance(references: Optional[List[ReferenceType]] = None, 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

List performance metrics for a bucket.

Parameters

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

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

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

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

  • ids (list[str], optional) – A 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

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

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

  • resolution (int, optional) – 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[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

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

  • total_only (bool, optional) – 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

get_buckets_s3_specific_performance(references: Optional[List[ReferenceType]] = None, 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

List performance metrics specific to S3 operations for a bucket.

Parameters

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

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

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

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

  • ids (list[str], optional) – A 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

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

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

  • resolution (int, optional) – 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[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

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

  • total_only (bool, optional) – 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

get_certificate_groups(references: Optional[List[ReferenceType]] = 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) → CertificateGroupGetResponse

Display all array certificate groups.

Parameters

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

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

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

  • ids (list[str], optional) – A list of resource IDs. If 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

get_certificate_groups_certificates(certificates: Optional[List[ReferenceType]] = None, certificate_groups: Optional[List[ReferenceType]] = None, 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

List membership associations between groups and certificates on the array.

Parameters

  • certificates (list[FixedReference], optional) – A list of certificates to query for. Overrides certificate_ids and certificate_names keyword arguments.

  • certificate_groups (list[FixedReference], optional) – A list of certificate_groups to query for. Overrides certificate_group_ids and certificate_group_names keyword arguments.

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

  • certificate_ids (list[str], optional) – A 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], optional) – A 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], optional) – A 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], optional) – A 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 (Filter, optional) – A filter to include only resources that match the specified criteria.

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

get_certificate_groups_uses(references: Optional[List[ReferenceType]] = 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) → CertificateGroupUseGetResponse

List how certificate groups are being used and by what.

Parameters

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

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

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

  • ids (list[str], optional) – A list of resource IDs. If 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

get_certificates(references: Optional[List[ReferenceType]] = 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) → CertificateGetResponse

List array certificates and their attributes.

Parameters

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

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

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

  • ids (list[str], optional) – A list of resource IDs. If 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

get_certificates_certificate_groups(certificates: Optional[List[ReferenceType]] = None, certificate_groups: Optional[List[ReferenceType]] = None, 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

List membership associations between groups and certificates.

Parameters

  • certificates (list[FixedReference], optional) – A list of certificates to query for. Overrides certificate_ids and certificate_names keyword arguments.

  • certificate_groups (list[FixedReference], optional) – A list of certificate_groups to query for. Overrides certificate_group_ids and certificate_group_names keyword arguments.

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

  • certificate_ids (list[str], optional) – A 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], optional) – A 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], optional) – A 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], optional) – A 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 (Filter, optional) – A filter to include only resources that match the specified criteria.

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

get_certificates_uses(references: Optional[List[ReferenceType]] = 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) → CertificateUseGetResponse

List how certificates are being used and by what.

Parameters

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

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

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

  • ids (list[str], optional) – A list of resource IDs. If 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

get_directory_services(references: Optional[List[ReferenceType]] = 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) → DirectoryServiceGetResponse

List directory service configuration information for the array.

Parameters

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

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

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

  • ids (list[str], optional) – A list of resource IDs. If 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

get_directory_services_roles(references: Optional[List[ReferenceType]] = None, roles: Optional[List[ReferenceType]] = None, 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

Return array’s RBAC group configuration settings for manageability.

Parameters

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

  • roles (list[FixedReference], optional) – A list of roles to query for. Overrides role_ids and role_names keyword arguments.

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

  • ids (list[str], optional) – A 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 (Filter, optional) – A filter to include only resources that match the specified criteria.

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

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

  • role_ids (list[str], optional) – A 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], optional) – A 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[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

get_directory_services_test(references: Optional[List[ReferenceType]] = None, 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

Test the configured directory services on the array.

Parameters

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

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

  • ids (list[str], optional) – A 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

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

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

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

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

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

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

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_dns(references: Optional[List[ReferenceType]] = 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) → DnsGetResponse

List DNS attributes for the array’s administrative network.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_drives(references: Optional[List[ReferenceType]] = None, 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

List array drive information.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_only (bool, optional) – 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

List file system replication link.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids keyword arguments.

  • local_file_systems (list[FixedReference], optional) – A list of local_file_systems to query for. Overrides local_file_system_ids and local_file_system_names keyword arguments.

  • remote_file_systems (list[FixedReference], optional) – A list of remote_file_systems to query for. Overrides remote_file_system_ids and remote_file_system_names keyword arguments.

  • remotes (list[FixedReference], optional) – A list of remotes to query for. Overrides remote_ids and remote_names keyword arguments.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • local_file_system_ids (list[str], optional) – A 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], optional) – A 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, optional) – The offset of the first resource to return from a collection.

  • remote_file_system_ids (list[str], optional) – A 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], optional) – A 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], optional) – A 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], optional) – A 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[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

List file system replication link policies.

Parameters

  • local_file_systems (list[FixedReference], optional) – A list of local_file_systems to query for. Overrides local_file_system_ids and local_file_system_names keyword arguments.

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • remotes (list[FixedReference], optional) – A list of remotes to query for. Overrides remote_ids and remote_names keyword arguments.

  • remote_file_systems (list[FixedReference], optional) – A list of remote_file_systems to query for. Overrides remote_file_system_ids and remote_file_system_names keyword arguments.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • local_file_system_ids (list[str], optional) – A 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], optional) – A 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], optional) – A 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, optional) – The offset of the first resource to return from a collection.

  • policy_ids (list[str], optional) – A 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], optional) – A list of policy names.

  • remote_ids (list[str], optional) – A 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], optional) – A 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], optional) – A 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], optional) – A 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[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

List the transfer status details for file system replication.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids keyword arguments.

  • names_or_owners (list[FixedReference], optional) – A list of names_or_owners to query for. Overrides names_or_owner_names keyword arguments.

  • remotes (list[FixedReference], optional) – A list of remotes to query for. Overrides remote_ids and remote_names keyword arguments.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names_or_owner_names (list[str], optional) – A list of resource names. Either the names of the snapshots or the owning file systems.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • remote_ids (list[str], optional) – A 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], optional) – A 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[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_only (bool, optional) – 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_file_system_snapshots(references: Optional[List[ReferenceType]] = None, names_or_owners: Optional[List[ReferenceType]] = None, owners: Optional[List[ReferenceType]] = None, 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

List file system snapshots.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids keyword arguments.

  • names_or_owners (list[FixedReference], optional) – A list of names_or_owners to query for. Overrides names_or_owner_names keyword arguments.

  • owners (list[FixedReference], optional) – A list of owners to query for. Overrides owner_ids keyword arguments.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • destroyed (bool, optional) – 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 (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names_or_owner_names (list[str], optional) – A list of resource names. Either the names of the snapshots or the owning file systems.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • owner_ids (list[str], optional) – A 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[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_only (bool, optional) – 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_file_system_snapshots_policies(members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, 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

List file system snapshots mapped to snapshot scheduling policies.

Parameters

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • member_ids (list[str], optional) – A list of member IDs. If 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], optional) – A list of member names.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • policy_ids (list[str], optional) – A 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], optional) – A list of policy names.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_file_system_snapshots_transfer(references: Optional[List[ReferenceType]] = None, names_or_owners: Optional[List[ReferenceType]] = None, 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

List file system snapshot transfers from the source array to the target array.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids keyword arguments.

  • names_or_owners (list[FixedReference], optional) – A list of names_or_owners to query for. Overrides names_or_owner_names keyword arguments.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names_or_owner_names (list[str], optional) – A list of resource names. Either the names of the snapshots or the owning file systems.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_only (bool, optional) – 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_file_systems(references: Optional[List[ReferenceType]] = None, 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

List one or more file systems on the array.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • destroyed (bool, optional) – 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 (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_only (bool, optional) – 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_file_systems_groups_performance(file_systems: Optional[List[ReferenceType]] = None, groups: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, 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

List a group’s I/O performance metrics on a file system.

Parameters

  • file_systems (list[FixedReference], optional) – A list of file_systems to query for. Overrides file_system_ids and file_system_names keyword arguments.

  • groups (list[FixedReference], optional) – A list of groups to query for. Overrides group_names keyword arguments.

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • file_system_ids (list[str], optional) – A 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], optional) – A 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 (Filter, optional) – A filter to include only resources that match the specified criteria.

  • gids (list[str], optional) – A list of group IDs. This cannot be provided together with group_names query parameter.

  • group_names (list[str], optional) – A list of group names. This cannot be provided together with gids query parameter.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_only (bool, optional) – 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_file_systems_locks(clients: Optional[List[ReferenceType]] = None, file_systems: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, 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

Lists all active file locks that satisfy the conditions specified by the parameters.

Parameters

  • clients (list[FixedReference], optional) – A list of clients to query for. Overrides client_names keyword arguments.

  • file_systems (list[FixedReference], optional) – A list of file_systems to query for. Overrides file_system_ids and file_system_names keyword arguments.

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • client_names (list[str], optional) – A 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], optional) – A 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], optional) – A 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 (Filter, optional) – A filter to include only resources that match the specified criteria.

  • inodes (list[float], optional) – 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • paths (list[str], optional) – 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_file_systems_locks_clients(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

Lists all clients that hold active file locks.

Parameters

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_file_systems_performance(references: Optional[List[ReferenceType]] = None, 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

Displays the performance metrics for a file system.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • end_time (int, optional) – When the time window ends (in milliseconds since epoch).

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • protocol (str, optional) – 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, optional) – 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[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • start_time (int, optional) – When the time window starts (in milliseconds since epoch).

  • total_only (bool, optional) – 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_file_systems_policies(members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, 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

List file system snapshot scheduling policies.

Parameters

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • member_ids (list[str], optional) – A list of member IDs. If 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], optional) – A list of member names.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • policy_ids (list[str], optional) – A 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], optional) – A list of policy names.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_file_systems_policies_all(members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, 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

List file system policies.

Parameters

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • member_ids (list[str], optional) – A list of member IDs. If 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], optional) – A list of member names.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • policy_ids (list[str], optional) – A 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], optional) – A list of policy names.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_file_systems_users_performance(file_systems: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, users: Optional[List[ReferenceType]] = 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, 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

List a user’s I/O performance metrics on a file system.

Parameters

  • file_systems (list[FixedReference], optional) – A list of file_systems to query for. Overrides file_system_ids and file_system_names keyword arguments.

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • users (list[FixedReference], optional) – A list of users to query for. Overrides user_names keyword arguments.

  • file_system_ids (list[str], optional) – A 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], optional) – A 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 (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A 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[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_only (bool, optional) – 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], optional) – A list of user IDs. This cannot be provided together with user_names query parameter.

  • user_names (list[str], optional) – A list of user names. This cannot be provided together with uids query parameter.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_hardware(references: Optional[List[ReferenceType]] = None, 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

List hardware slots and bays and the status of installed components.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • ids (list[str], optional) – A 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], optional) – A 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_hardware_connectors(references: Optional[List[ReferenceType]] = None, 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

List array connection information.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • ids (list[str], optional) – A 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], optional) – A 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_hardware_connectors_performance(references: Optional[List[ReferenceType]] = 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) → HardwareConnectorPerformanceGetResponse

Displays network statistics, historical bandwidth, and error reporting for all specified hardware connectors.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • end_time (int, optional) – When the time window ends (in milliseconds since epoch).

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • resolution (int, optional) – 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[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • start_time (int, optional) – When the time window starts (in milliseconds since epoch).

  • total_only (bool, optional) – 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_keytabs(references: Optional[List[ReferenceType]] = 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) → KeytabGetResponse

List a Kerberos keytab file and its configuration information.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_keytabs_download(keytabs: Optional[List[ReferenceType]] = None, 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

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.

Parameters

  • keytabs (list[FixedReference], optional) – A list of keytabs to query for. Overrides keytab_ids and keytab_names keyword arguments.

  • keytab_ids (list[str], optional) – A 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], optional) – A 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_kmip(references: Optional[List[ReferenceType]] = None, 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

Displays a list of KMIP server configurations.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names and ids keyword arguments.

  • names (list[str], optional) – A 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], optional) – A 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 (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_kmip_test(references: Optional[List[ReferenceType]] = 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) → TestResultResponse

Displays a detailed result of of KMIP server test.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names and ids keyword arguments.

  • names (list[str], optional) – A 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], optional) – A 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_lifecycle_rules(buckets: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, 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

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.

Parameters

  • buckets (list[FixedReference], optional) – A list of buckets to query for. Overrides bucket_ids and bucket_names keyword arguments.

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • bucket_ids (list[str], optional) – A 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], optional) – A 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, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

List the status and attributes of the Ethernet ports in the configured link aggregation groups.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_logs(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

Download a history of log events from the array to provide to Pure Technical Services for analysis.

Parameters

  • end_time (int, optional) – When the time window ends (in milliseconds since epoch).

  • start_time (int, optional) – When the time window starts (in milliseconds since epoch).

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_logs_async(references: Optional[List[ReferenceType]] = 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) → LogsAsyncGetResponse

List the attributes and status of preparation for a history of log events from the array to provide to Pure Technical Services for analysis.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_logs_async_download(references: List[models.ReferenceType] = None, 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

Download the files which contain a history of log events from the array to provide to Pure Technical Services for analysis.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • names (list[str], optional) – A 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_network_interfaces(references: Optional[List[ReferenceType]] = None, 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

List network interfaces and their attributes.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_network_interfaces_ping(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

Display network interface ping result.

Parameters

  • destination (str, required) – A destination specified by user to run the network diagnosis against. Can be a hostname or an IP.

  • packet_size (int, optional) – Used by ping to specify the number of data bytes to be sent per packet. If not specified, defaults to 56.

  • count (int, optional) – Used by ping to specify the number of packets to send. If not specified, defaults to 1.

  • component_name (str, optional) – 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, optional) – 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, optional) – 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, optional) – 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_network_interfaces_trace(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

Display network interface trace result.

Parameters

  • destination (str, required) – A destination specified by user to run the network diagnosis against. Can be a hostname or an IP.

  • fragment_packet (bool, optional) – Used by trace to specify whether or not to fragment packets. If not specified, defaults to true.

  • method (str, optional) – 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, optional) – 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, optional) – 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, optional) – 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, optional) – Used by trace to specify a destination port.

  • resolve_hostname (bool, optional) – 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_nfs_export_policies(references: Optional[List[ReferenceType]] = 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) → NfsExportPolicyGetResponse

Displays a list of NFS export policies.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_nfs_export_policies_rules(references: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = 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, 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

Displays a list of NFS export policy rules. The default sort is by policy name, then index.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • policy_ids (list[str], optional) – A 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], optional) – A list of policy names.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_object_store_access_keys(references: Optional[List[ReferenceType]] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ObjectStoreAccessKeyGetResponse

List object store access keys.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A 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, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_object_store_access_policies(references: Optional[List[ReferenceType]] = None, 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

List access policies and their attributes.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • exclude_rules (bool, optional) – 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 (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_object_store_access_policies_object_store_users(members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, 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

List object store users and their access policies.

Parameters

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • member_ids (list[str], optional) – A list of member IDs. If 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], optional) – A list of member names.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • policy_ids (list[str], optional) – A 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], optional) – A list of policy names.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_object_store_access_policies_rules(references: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, 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

List access policy rules and their attributes.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A 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, optional) – The offset of the first resource to return from a collection.

  • policy_ids (list[str], optional) – A 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], optional) – A list of policy names.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_object_store_access_policy_actions(references: Optional[List[ReferenceType]] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ObjectStoreAccessPolicyActionGetResponse

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.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A 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, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_object_store_accounts(references: Optional[List[ReferenceType]] = None, 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

List object store accounts and their attributes.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_only (bool, optional) – 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_object_store_remote_credentials(references: Optional[List[ReferenceType]] = 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) → ObjectStoreRemoteCredentialGetResp

List object store remote credentials used by bucket replica links to access buckets on remote arrays or targets.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_object_store_users(references: Optional[List[ReferenceType]] = 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) → ObjectStoreUserGetResponse

List object store users and their attributes.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_object_store_users_object_store_access_policies(members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, 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

List object store users and their access policies.

Parameters

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • member_ids (list[str], optional) – A list of member IDs. If 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], optional) – A list of member names.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • policy_ids (list[str], optional) – A 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], optional) – A list of policy names.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_object_store_virtual_hosts(references: Optional[List[ReferenceType]] = 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) → ObjectStoreVirtualHostGetResponse

List object store virtual hosts.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_policies(references: Optional[List[ReferenceType]] = None, 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

Display snapshot scheduling policies and their attributes.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_policies_all(references: Optional[List[ReferenceType]] = 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) → PolicyBaseGetResponse

List all policies of all types.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_policies_all_members(local_file_systems: List[models.ReferenceType] = None, members: List[models.ReferenceType] = None, policies: List[models.ReferenceType] = None, remotes: List[models.ReferenceType] = None, remote_file_systems: List[models.ReferenceType] = None, 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

List policies (of all types) mapped to other entities (file systems, snapshots, file system replica links, and object store users).

Parameters

  • local_file_systems (list[FixedReference], optional) – A list of local_file_systems to query for. Overrides local_file_system_ids and local_file_system_names keyword arguments.

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • remotes (list[FixedReference], optional) – A list of remotes to query for. Overrides remote_ids and remote_names keyword arguments.

  • remote_file_systems (list[FixedReference], optional) – A list of remote_file_systems to query for. Overrides remote_file_system_ids and remote_file_system_names keyword arguments.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • local_file_system_ids (list[str], optional) – A 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], optional) – A 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], optional) – A 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], optional) – A list of member names.

  • member_types (list[ModelsFB28ResourceTypeYaml], optional) – A 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, optional) – The offset of the first resource to return from a collection.

  • policy_ids (list[str], optional) – A 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], optional) – A list of policy names.

  • remote_ids (list[str], optional) – A 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], optional) – A 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], optional) – A 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], optional) – A 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[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

List snapshot scheduling policies for file system replica links.

Parameters

  • local_file_systems (list[FixedReference], optional) – A list of local_file_systems to query for. Overrides local_file_system_ids and local_file_system_names keyword arguments.

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • remotes (list[FixedReference], optional) – A list of remotes to query for. Overrides remote_ids and remote_names keyword arguments.

  • remote_file_systems (list[FixedReference], optional) – A list of remote_file_systems to query for. Overrides remote_file_system_ids and remote_file_system_names keyword arguments.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • local_file_system_ids (list[str], optional) – A 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], optional) – A 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], optional) – A 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, optional) – The offset of the first resource to return from a collection.

  • policy_ids (list[str], optional) – A 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], optional) – A list of policy names.

  • remote_ids (list[str], optional) – A 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], optional) – A 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], optional) – A 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], optional) – A 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[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_policies_file_system_snapshots(members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, 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

List file system snapshots mapped to a snapshot scheduling policy.

Parameters

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • member_ids (list[str], optional) – A list of member IDs. If 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], optional) – A list of member names.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • policy_ids (list[str], optional) – A 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], optional) – A list of policy names.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_policies_file_systems(members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, 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

List file systems mapped to a snapshot scheduling policy.

Parameters

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • member_ids (list[str], optional) – A list of member IDs. If 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], optional) – A list of member names.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • policy_ids (list[str], optional) – A 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], optional) – A list of policy names.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_policies_members(local_file_systems: List[models.ReferenceType] = None, members: List[models.ReferenceType] = None, policies: List[models.ReferenceType] = None, remotes: List[models.ReferenceType] = None, remote_file_systems: List[models.ReferenceType] = None, 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

List snapshot scheduling policies mapped to file systems, snapshots, and file system replica links.

Parameters

  • local_file_systems (list[FixedReference], optional) – A list of local_file_systems to query for. Overrides local_file_system_ids and local_file_system_names keyword arguments.

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • remotes (list[FixedReference], optional) – A list of remotes to query for. Overrides remote_ids and remote_names keyword arguments.

  • remote_file_systems (list[FixedReference], optional) – A list of remote_file_systems to query for. Overrides remote_file_system_ids and remote_file_system_names keyword arguments.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • local_file_system_ids (list[str], optional) – A 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], optional) – A 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], optional) – A 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], optional) – A list of member names.

  • member_types (list[ModelsFB28ResourceTypeYaml], optional) – A 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, optional) – The offset of the first resource to return from a collection.

  • policy_ids (list[str], optional) – A 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], optional) – A list of policy names.

  • remote_ids (list[str], optional) – A 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], optional) – A 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], optional) – A 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], optional) – A 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[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_quotas_groups(file_systems: Optional[List[ReferenceType]] = None, groups: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, 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

List groups with hard limit quotas.

Parameters

  • file_systems (list[FixedReference], optional) – A list of file_systems to query for. Overrides file_system_ids and file_system_names keyword arguments.

  • groups (list[FixedReference], optional) – A list of groups to query for. Overrides group_names keyword arguments.

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • file_system_ids (list[str], optional) – A 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], optional) – A 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 (Filter, optional) – A filter to include only resources that match the specified criteria.

  • gids (list[int], optional) – A 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], optional) – A 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_quotas_settings(references: Optional[List[ReferenceType]] = 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) → QuotaSettingGetResponse

List notification attributes of a group or user quota.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • ids (list[str], optional) – A 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], optional) – A 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_quotas_users(file_systems: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, users: Optional[List[ReferenceType]] = None, 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

List users with hard limit file system quotas.

Parameters

  • file_systems (list[FixedReference], optional) – A list of file_systems to query for. Overrides file_system_ids and file_system_names keyword arguments.

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • users (list[FixedReference], optional) – A list of users to query for. Overrides user_names keyword arguments.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • file_system_ids (list[str], optional) – A 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], optional) – A 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 (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A 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, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • uids (list[int], optional) – A 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], optional) – A 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_rapid_data_locking(async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → RapidDataLockingResponse

Displays the status of the Rapid Data Locking feature.

Parameters

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_rapid_data_locking_test(async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → TestResultResponse

Displays a detailed result of a Rapid Data Locking test.

Parameters

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_roles(references: Optional[List[ReferenceType]] = None, 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

List roles and permission attributes for role-based access control (RBAC).

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • ids (list[str], optional) – A 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 (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A 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, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_sessions(references: Optional[List[ReferenceType]] = 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) → SessionGetResponse

Displays session data for user login events performed in the Purity//FB GUI, CLI, and REST API.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_smtp_servers(references: Optional[List[ReferenceType]] = 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) → SmtpServerGetResponse

List SMTP server attributes for the array network.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_snmp_agents(references: Optional[List[ReferenceType]] = 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) → SnmpAgentGetResponse

List SNMP agent attributes.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_snmp_agents_mib(async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SnmpAgentMibResponse

List the SNMP MIB text.

Parameters

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_snmp_managers(references: Optional[List[ReferenceType]] = None, 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

List SNMP managers and their attributes.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • ids (list[str], optional) – A 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 (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A 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, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_snmp_managers_test(references: Optional[List[ReferenceType]] = None, 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

Test if the configuration of an SNMP manager is valid.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • ids (list[str], optional) – A 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 (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A 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, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_subnets(references: Optional[List[ReferenceType]] = 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) → SubnetGetResponse

List the array’s subnets.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_support(references: Optional[List[ReferenceType]] = 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) → SupportGetResponse

List Phone Home and Remote Assistance settings.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • ids (list[str], optional) – A 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], optional) – A 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_support_test(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

Test if the Phone Home and Remote Assistance settings are functioning properly.

Parameters

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • test_type (str, optional) – Specify the type of test. Valid values are all, phonehome and remote- assist. If not specified, defaults to all.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_support_verification_keys(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

List the key used to verify the signed challenges that are used by Pure Support to access the FlashBlade.

Parameters

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_syslog_servers(references: Optional[List[ReferenceType]] = 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) → SyslogServerGetResponse

Return a list of configured syslog servers.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_syslog_servers_settings(references: Optional[List[ReferenceType]] = 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) → SyslogServerSettingsGetResponse

List the certificate or certificate group associated with the syslog servers.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_syslog_servers_test(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

Send test messages to conifgured remote syslog servers.

Parameters

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_targets(references: Optional[List[ReferenceType]] = None, 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

List targets used for replication.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_targets_performance_replication(references: Optional[List[ReferenceType]] = None, 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

List replication performance metrics for targets.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • end_time (int, optional) – When the time window ends (in milliseconds since epoch).

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • resolution (int, optional) – 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[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • start_time (int, optional) – When the time window starts (in milliseconds since epoch).

  • total_only (bool, optional) – 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_usage_groups(file_systems: Optional[List[ReferenceType]] = None, groups: Optional[List[ReferenceType]] = None, 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

List groups with hard limit quotas and their file system usage.

Parameters

  • file_systems (list[FixedReference], optional) – A list of file_systems to query for. Overrides file_system_ids and file_system_names keyword arguments.

  • groups (list[FixedReference], optional) – A list of groups to query for. Overrides group_names keyword arguments.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • file_system_ids (list[str], optional) – A 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], optional) – A 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 (Filter, optional) – A filter to include only resources that match the specified criteria.

  • gids (list[int], optional) – A 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], optional) – A 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_usage_users(file_systems: Optional[List[ReferenceType]] = None, users: Optional[List[ReferenceType]] = None, 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

List users with hard limit quotas and their file system usage.

Parameters

  • file_systems (list[FixedReference], optional) – A list of file_systems to query for. Overrides file_system_ids and file_system_names keyword arguments.

  • users (list[FixedReference], optional) – A list of users to query for. Overrides user_names keyword arguments.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • file_system_ids (list[str], optional) – A 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], optional) – A 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 (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • uids (list[int], optional) – A 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], optional) – A 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_versions(async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → dict

Get available API versions. No authentication is required to access this endpoint. The response will be a ValidResponse with version ids listed as items.

Parameters

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

logout(async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Invalidate a REST session token.

Parameters

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_active_directory(references: Optional[List[ReferenceType]] = None, 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

Modify the configuration of an Active Directory account.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • active_directory (ActiveDirectoryPatch, required) –

  • ids (list[str], optional) – A 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], optional) – A 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_admins(references: Optional[List[ReferenceType]] = None, 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

Modify the attributes of the administrator.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • admin (AdminPatch, required) –

  • ids (list[str], optional) – A 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], optional) – A 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_admins_settings(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 properties for global admin settings.

Parameters

  • admin_setting (AdminSetting, required) –

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_alert_watchers(references: Optional[List[ReferenceType]] = None, 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

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.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • alert_watcher (AlertWatcher, required) –

  • ids (list[str], optional) – A 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], optional) – A 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_alerts(references: Optional[List[ReferenceType]] = None, 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

Make changes to an alert. This is currently limited to the alert’s flagged property.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • alerts_settings (Alert, required) –

  • ids (list[str], optional) – A 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], optional) – A 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_api_clients(references: Optional[List[ReferenceType]] = None, 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

Modify an API client. Newly created API clients can be enabled by setting the enabled parameter to true.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • api_clients (ApiClient, required) –

  • ids (list[str], optional) – A 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], optional) – A 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_array_connections(references: Optional[List[ReferenceType]] = None, remotes: Optional[List[ReferenceType]] = None, 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

Modify the configuration of a connected array.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids keyword arguments.

  • remotes (list[FixedReference], optional) – A list of remotes to query for. Overrides remote_ids and remote_names keyword arguments.

  • array_connection (ArrayConnection, required) –

  • ids (list[str], optional) – A 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], optional) – A 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], optional) – A 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_arrays(array: Optional[list] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ArrayResponse

Modify the general configuration of the array including banner text, array name, NTP servers, and time zone.

Parameters

  • array (Array, required) –

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_arrays_eula(eula: Optional[Eula] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → EulaResponse

Modifies the signature on the End User Agreement.

Parameters

  • eula (Eula, required) –

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

Modify the configuration of a bucket replica link including whether the link is paused and the object store remote credentials used.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids keyword arguments.

  • local_buckets (list[FixedReference], optional) – A list of local_buckets to query for. Overrides local_bucket_ids and local_bucket_names keyword arguments.

  • remote_buckets (list[FixedReference], optional) – A list of remote_buckets to query for. Overrides remote_bucket_names keyword arguments.

  • remotes (list[FixedReference], optional) – A list of remotes to query for. Overrides remote_ids and remote_names keyword arguments.

  • bucket_replica_link (BucketReplicaLink, required) –

  • ids (list[str], optional) – A 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], optional) – A 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], optional) – A 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], optional) – A 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], optional) – A 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], optional) – A 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_buckets(references: Optional[List[ReferenceType]] = None, 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

Modify object store bucket attributes such as destroyed and versioning.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • bucket (BucketPatch, required) –

  • ids (list[str], optional) – A 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, optional) – 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], optional) – A 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_certificates(references: Optional[List[ReferenceType]] = None, 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

Modify SSL certificate attributes such as passphrases and intermediate certificates.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • certificate (CertificatePatch, required) –

  • ids (list[str], optional) – A 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], optional) – A 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_directory_services(references: Optional[List[ReferenceType]] = None, 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

Modifies and tests the directory service configuration.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • directory_service (DirectoryService, required) –

  • ids (list[str], optional) – A 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], optional) – A 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_directory_services_roles(references: Optional[List[ReferenceType]] = None, roles: Optional[List[ReferenceType]] = None, 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

Update an RBAC group configuration setting for manageability.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids keyword arguments.

  • roles (list[FixedReference], optional) – A list of roles to query for. Overrides role_ids and role_names keyword arguments.

  • directory_service_roles (DirectoryServiceRole, required) –

  • ids (list[str], optional) – A 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], optional) – A 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], optional) – A 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_directory_services_test(references: Optional[List[ReferenceType]] = None, 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

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.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A 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], optional) – A 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[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • directory_service (DirectoryService, optional) – 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_dns(references: Optional[List[ReferenceType]] = None, 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

Modify DNS attributes.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • dns (Dns, required) –

  • ids (list[str], optional) – A 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], optional) – A 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_file_system_snapshots(references: Optional[List[ReferenceType]] = None, 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

Modify file system snapshot attributes.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • file_system_snapshot (FileSystemSnapshot, required) –

  • ids (list[str], optional) – A 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, optional) – 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], optional) – A 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_file_systems(references: Optional[List[ReferenceType]] = None, 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

Modify a file system’s attributes including its export protocols and limits.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • file_system (FileSystemPatch, required) –

  • delete_link_on_eradication (bool, optional) – 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, optional) – 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, optional) – 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], optional) – A 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, optional) – 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], optional) – A 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_hardware(references: Optional[List[ReferenceType]] = None, 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

Controls the visual identification light of the specified hardware component.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • hardware (Hardware, required) –

  • ids (list[str], optional) – A 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], optional) – A 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_hardware_connectors(references: Optional[List[ReferenceType]] = None, 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

Modify array connection information.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • hardware_connector (HardwareConnector, required) –

  • ids (list[str], optional) – A 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], optional) – A 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_kmip(references: Optional[List[ReferenceType]] = None, 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

Modifies KMIP server properties - URI, certificate, certificate group.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names and ids keyword arguments.

  • kmip_server (KmipServer, required) –

  • names (list[str], optional) – A 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], optional) – A 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_lifecycle_rules(buckets: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, 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

Modify an existing lifecycle rule by name or id. If ids is specified, bucket_names or bucket_ids is also required.

Parameters

  • buckets (list[FixedReference], optional) – A list of buckets to query for. Overrides bucket_ids and bucket_names keyword arguments.

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • lifecycle (LifecycleRulePatch, required) –

  • bucket_ids (list[str], optional) – A 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], optional) – A 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], optional) – A 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], optional) – A 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, optional) – If set to true, then confirm the date of keep_current_version_until is correct.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

Modify link aggregation groups by adding and removing Ethernet ports.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • link_aggregation_group (Linkaggregationgroup, required) –

  • ids (list[str], optional) – A 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], optional) – A 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_logs_async(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

Start the preparation for a history of log events from the array to provide to Pure Technical Services for analysis.

Parameters

  • logs_async (LogsAsync, required) –

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_network_interfaces(references: Optional[List[ReferenceType]] = None, 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

Modify the attributes of a data VIP.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • network_interface (NetworkInterfacePatch, required) –

  • ids (list[str], optional) – A 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], optional) – A 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_nfs_export_policies(references: Optional[List[ReferenceType]] = None, 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

Modify an existing NFS export policy’s attributes.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • policy (NfsExportPolicy, required) –

  • ids (list[str], optional) – A 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], optional) – A 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], optional) – A 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_nfs_export_policies_rules(references: Optional[List[ReferenceType]] = None, 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

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.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • rule (NfsExportPolicyRule, required) –

  • before_rule_id (str, optional) – 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, optional) – 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], optional) – A 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], optional) – A 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], optional) – A 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_object_store_access_keys(references: Optional[List[ReferenceType]] = None, 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

Enable or disable object store access keys.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • names (list[str], required) – A list of resource names.

  • object_store_access_key (ObjectStoreAccessKey, required) –

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_object_store_access_policies(references: Optional[List[ReferenceType]] = None, 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

Modify the rules of an object store access policy.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • enforce_action_restrictions (bool, optional) – 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], optional) – A 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], optional) – A 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, optional) –

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_object_store_access_policies_rules(references: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, 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

Modify an access policy rule’s attributes.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • rule (PolicyRuleObjectAccess, required) –

  • enforce_action_restrictions (bool, optional) – 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], optional) – A 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], optional) – A 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], optional) – A list of policy names.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_object_store_accounts(references: Optional[List[ReferenceType]] = None, 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

Modify object store account attributes such as quota limit and bucket defaults.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • object_store_account (ObjectStoreAccountPatch, required) –

  • ids (list[str], optional) – A 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, optional) – 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], optional) – A 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_object_store_remote_credentials(references: Optional[List[ReferenceType]] = None, 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

Rename and/or change the access key/secret key pair for object store remote credentials.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • remote_credentials (ObjectStoreRemoteCredentials, required) –

  • ids (list[str], optional) – A 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], optional) – A 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_policies(references: Optional[List[ReferenceType]] = None, 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

Modify a snapshot scheduling policy’s attributes for when and how often snapshots are created and how long they are retained.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • policy (PolicyPatch, required) –

  • ids (list[str], optional) – A 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, optional) – 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], optional) – A 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_quotas_groups(file_systems: Optional[List[ReferenceType]] = None, groups: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, 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

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.

Parameters

  • file_systems (list[FixedReference], optional) – A list of file_systems to query for. Overrides file_system_names and file_system_ids keyword arguments.

  • groups (list[FixedReference], optional) – A list of groups to query for. Overrides group_names keyword arguments.

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • file_system_names (list[str], optional) – A 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], optional) – A 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], optional) – A 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], optional) – A 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], optional) – A 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, optional) –

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_quotas_settings(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

Modify the notification attributes of a group or user quota.

Parameters

  • quota_setting (QuotaSetting, required) –

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_quotas_users(file_systems: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, users: Optional[List[ReferenceType]] = None, 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

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.

Parameters

  • file_systems (list[FixedReference], optional) – A list of file_systems to query for. Overrides file_system_names and file_system_ids keyword arguments.

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • users (list[FixedReference], optional) – A list of users to query for. Overrides user_names keyword arguments.

  • file_system_names (list[str], optional) – A 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], optional) – A 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], optional) – A 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], optional) – A 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], optional) – A 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, optional) –

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_rapid_data_locking(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. 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.

Parameters

  • rapid_data_locking (RapidDataLocking, required) –

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_smtp_servers(smtp: Optional[SmtpServer] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SmtpServerResponse

Modify SMTP server attributes such as the relay host and sender domain.

Parameters

  • smtp (SmtpServer, required) –

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_snmp_agents(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

Modify SNMP agent attributes.

Parameters

  • snmp_agent (SnmpAgent, required) –

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_snmp_managers(references: Optional[List[ReferenceType]] = None, 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

Modify SNMP manager attributes such as versions.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • snmp_manager (SnmpManager, required) –

  • ids (list[str], optional) – A 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], optional) – A 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_subnets(references: Optional[List[ReferenceType]] = None, 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

Modify array subnet attributes.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • subnet (Subnet, required) –

  • ids (list[str], optional) – A 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], optional) – A 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_support(support: Optional[Support] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SupportResponse

Modify Phone Home and Remote Assistance settings.

Parameters

  • support (Support, required) –

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_support_verification_keys(key: Optional[VerificationKeyPatch] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → VerificationKeyResponse

Update the key used to verify the signed challenges that are used by Pure Support to access the FlashBlade.

Parameters

  • key (VerificationKeyPatch, required) –

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_syslog_servers(references: Optional[List[ReferenceType]] = None, 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

Modify the URI of a configured syslog server.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • syslog_server (SyslogServerPostOrPatch, required) –

  • ids (list[str], optional) – A 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], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_syslog_servers_settings(references: Optional[List[ReferenceType]] = None, 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

Modify the certificate or certificate group associated with the syslog servers.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • syslog_server_settings (SyslogServerSettings, required) –

  • ids (list[str], optional) – A 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], optional) – A 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_targets(references: Optional[List[ReferenceType]] = None, 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

Modify the target attributes for replication.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • target (Target, required) –

  • ids (list[str], optional) – A 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], optional) – A 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_active_directory(references: Optional[List[ReferenceType]] = None, 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

Join an Active Directory domain and generate keytabs for the registered SPNs and supported encryption types.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • active_directory (ActiveDirectoryPost, required) –

  • names (list[str], optional) – A 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, optional) – 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_admins_api_tokens(admins: Optional[List[ReferenceType]] = None, 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

Creates API tokens for the specified administrators.

Parameters

  • admins (list[FixedReference], optional) – A list of admins to query for. Overrides admin_ids and admin_names keyword arguments.

  • admin_ids (list[str], optional) – A 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], optional) – A 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, optional) – The duration of API token validity, in milliseconds.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_alert_watchers(references: Optional[List[ReferenceType]] = None, 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

Create an alert watcher to receive array alert messages.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • names (list[str], required) – A list of resource names.

  • alert_watcher (AlertWatcherPost, optional) –

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_api_clients(references: Optional[List[ReferenceType]] = None, 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

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.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • api_client (ApiClientsPost, required) –

  • names (list[str], optional) – A 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_array_connections(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

Create a connection to an array for replication and configure network settings.

Parameters

  • array_connection (ArrayConnectionPost, required) –

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_array_connections_connection_key(async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ArrayConnectionKeyResponse

Create an array connection key allowing one array to connect to another for replication.

Parameters

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_arrays_factory_reset_token(async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ArrayFactoryResetTokenResponse

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.

Parameters

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

Create a bucket replica link for object replication.

Parameters

  • local_buckets (list[FixedReference], optional) – A list of local_buckets to query for. Overrides local_bucket_names and local_bucket_ids keyword arguments.

  • remote_buckets (list[FixedReference], optional) – A list of remote_buckets to query for. Overrides remote_bucket_names keyword arguments.

  • remote_credential (list[FixedReference], optional) – A list of remote_credential to query for. Overrides remote_credentials_names and remote_credentials_ids keyword arguments.

  • bucket_replica_link (BucketReplicaLinkPost, required) –

  • local_bucket_names (list[str], optional) – A 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], optional) – A 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], optional) – A 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], optional) – A 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], optional) – A 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_buckets(references: Optional[List[ReferenceType]] = None, 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

Create a new object store bucket.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • names (list[str], required) – A list of resource names.

  • bucket (BucketPost, required) –

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_certificate_groups(references: Optional[List[ReferenceType]] = 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) → CertificateGroupResponse

Create one or more certificate groups on the array.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • names (list[str], optional) – A 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_certificate_groups_certificates(certificates: Optional[List[ReferenceType]] = None, certificate_groups: Optional[List[ReferenceType]] = 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, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → CertificateGroupCertificateResponse

Add one or more certificates to one or more certificate groups on the array.

Parameters

  • certificates (list[FixedReference], optional) – A list of certificates to query for. Overrides certificate_ids and certificate_names keyword arguments.

  • certificate_groups (list[FixedReference], optional) – A list of certificate_groups to query for. Overrides certificate_group_ids and certificate_group_names keyword arguments.

  • certificate_ids (list[str], optional) – A 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], optional) – A 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], optional) – A 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], optional) – A 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_certificates(references: Optional[List[ReferenceType]] = None, 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

Upload a CA certificate to the array.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • certificate (CertificatePost, required) –

  • names (list[str], optional) – A 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_certificates_certificate_groups(certificates: Optional[List[ReferenceType]] = None, certificate_groups: Optional[List[ReferenceType]] = 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, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → CertificateCertificateGroupResponse

Add one or more certificates to one or more certificate groups.

Parameters

  • certificates (list[FixedReference], optional) – A list of certificates to query for. Overrides certificate_ids and certificate_names keyword arguments.

  • certificate_groups (list[FixedReference], optional) – A list of certificate_groups to query for. Overrides certificate_group_ids and certificate_group_names keyword arguments.

  • certificate_ids (list[str], optional) – A 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], optional) – A 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], optional) – A 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], optional) – A 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

Create a file system replication link.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids keyword arguments.

  • local_file_systems (list[FixedReference], optional) – A list of local_file_systems to query for. Overrides local_file_system_ids and local_file_system_names keyword arguments.

  • remote_file_systems (list[FixedReference], optional) – A list of remote_file_systems to query for. Overrides remote_file_system_names keyword arguments.

  • remotes (list[FixedReference], optional) – A list of remotes to query for. Overrides remote_ids and remote_names keyword arguments.

  • file_system_replica_link (FileSystemReplicaLink, required) –

  • ids (list[str], optional) – A 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], optional) – A 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], optional) – A 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], optional) – A 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], optional) – A 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], optional) – A 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

Add a policy to a file system replication link.

Parameters

  • local_file_systems (list[FixedReference], optional) – A list of local_file_systems to query for. Overrides local_file_system_ids and local_file_system_names keyword arguments.

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • remotes (list[FixedReference], optional) – A list of remotes to query for. Overrides remote_ids and remote_names keyword arguments.

  • local_file_system_ids (list[str], optional) – A 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], optional) – A 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], optional) – A 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], optional) – A 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], optional) – A list of policy names.

  • remote_ids (list[str], optional) – A 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], optional) – A 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_file_system_snapshots(sources: Optional[List[ReferenceType]] = None, 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

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.

Parameters

  • sources (list[FixedReference], optional) – A list of sources to query for. Overrides source_ids and source_names keyword arguments.

  • source_ids (list[str], optional) – A 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], optional) – A 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, optional) – 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], optional) – The target arrays to replicate created snapshots to. Only valid when send is true.

  • file_system_snapshot (FileSystemSnapshotPost, optional) –

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_file_systems(references: Optional[List[ReferenceType]] = None, 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

Create a file system on the current array.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • names (list[str], required) – A list of resource names.

  • file_system (FileSystemPost, required) –

  • discard_non_snapshotted_data (bool, optional) – 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, optional) – When used for snapshot restore, overwrites (true) an existing file system.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_file_systems_locks_nlm_reclamations(async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → FileLockNlmReclamationResponse

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.

Parameters

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_file_systems_policies(members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberResponse

Apply a snapshot scheduling policy to a file system. Only one file system can be mapped to a policy at a time.

Parameters

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • member_ids (list[str], optional) – A 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], optional) – A list of member names.

  • policy_ids (list[str], optional) – A 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], optional) – A list of policy names.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_keytabs(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

Import a Kerberos keytab file from a Key Distribution Center.

Parameters

  • keytab (KeytabPost, required) –

  • name_prefixes (str, optional) – The prefix to use for the names of all Kerberos keytab objects that are being created.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_keytabs_upload(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

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.

Parameters

  • keytab_file (ERRORUNKNOWN, required) – The keytab file to upload.

  • name_prefixes (str, optional) – The prefix to use for the names of all Kerberos keytab objects that are being created.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_kmip(references: Optional[List[ReferenceType]] = None, 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

Creates a KMIP server configuration.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • kmip_server (KmipServer, required) –

  • names (list[str], optional) – A 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_lifecycle_rules(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

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”.

Parameters

  • rule (LifecycleRulePost, required) –

  • confirm_date (bool, optional) – If set to true, then confirm the date of keep_current_version_until is correct.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

Create a link aggregation group of Ethernet ports on the array.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • link_aggregation_group (LinkAggregationGroup, required) –

  • names (list[str], required) – A list of resource names.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_network_interfaces(references: Optional[List[ReferenceType]] = None, 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

Create a data VIP to export a file system.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • network_interface (NetworkInterface, required) –

  • names (list[str], required) – A list of resource names.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_nfs_export_policies(references: Optional[List[ReferenceType]] = None, 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

Create a new NFS export policy.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • names (list[str], required) – A list of resource names.

  • policy (NfsExportPolicyPost, optional) –

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_nfs_export_policies_rules(policies: Optional[List[ReferenceType]] = None, 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

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.

Parameters

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • rule (NfsExportPolicyRule, required) –

  • before_rule_id (str, optional) – 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, optional) – 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], optional) – A 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], optional) – A list of policy names.

  • versions (list[str], optional) – A 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_object_store_access_keys(references: Optional[List[ReferenceType]] = None, 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

Create or import object store access keys.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • object_store_access_key (ObjectStoreAccessKeyPost, required) –

  • names (list[str], optional) – A 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_object_store_access_policies(references: Optional[List[ReferenceType]] = None, 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

Create a new access policy.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • names (list[str], required) – A list of resource names.

  • enforce_action_restrictions (bool, optional) – 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, optional) –

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_object_store_access_policies_object_store_users(members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberResponse

Grant access policies to an object store user.

Parameters

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • member_ids (list[str], optional) – A 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], optional) – A list of member names.

  • policy_ids (list[str], optional) – A 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], optional) – A list of policy names.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_object_store_access_policies_rules(references: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, 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

Create a new access policy rule.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • names (list[str], required) – A list of resource names.

  • rule (PolicyRuleObjectAccessPost, required) –

  • enforce_action_restrictions (bool, optional) – 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], optional) – A 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], optional) – A list of policy names.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_object_store_accounts(references: Optional[List[ReferenceType]] = None, 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

Create an object store account.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • names (list[str], required) – A list of resource names.

  • object_store_account (ObjectStoreAccountPost, optional) –

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_object_store_remote_credentials(references: Optional[List[ReferenceType]] = None, 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

Create object store remote credentials to set up bucket replicat links to a remote array or target.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • names (list[str], required) – A list of resource names.

  • remote_credentials (ObjectStoreRemoteCredentialsPost, required) –

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_object_store_users(references: Optional[List[ReferenceType]] = None, 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

Create object store users to administer object storage for an object store account.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • names (list[str], required) – A list of resource names.

  • full_access (bool, optional) – 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_object_store_users_object_store_access_policies(members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberResponse

Grant access policies to an object store user.

Parameters

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • member_ids (list[str], optional) – A 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], optional) – A list of member names.

  • policy_ids (list[str], optional) – A 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], optional) – A list of policy names.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_object_store_virtual_hosts(references: Optional[List[ReferenceType]] = 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) → ObjectStoreVirtualHostResponse

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.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • names (list[str], required) – A list of resource names.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_policies(references: Optional[List[ReferenceType]] = None, 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

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.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • names (list[str], required) – A list of resource names.

  • policy (Policy, optional) –

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

Add a snapshot scheduling policy to a file system replica link.

Parameters

  • local_file_systems (list[FixedReference], optional) – A list of local_file_systems to query for. Overrides local_file_system_ids and local_file_system_names keyword arguments.

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • remotes (list[FixedReference], optional) – A list of remotes to query for. Overrides remote_ids and remote_names keyword arguments.

  • local_file_system_ids (list[str], optional) – A 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], optional) – A 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], optional) – A 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], optional) – A 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], optional) – A list of policy names.

  • remote_ids (list[str], optional) – A 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], optional) – A 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, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_policies_file_systems(members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberResponse

Map a file system to a snapshot scheduling policy.

Parameters

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • member_ids (list[str], optional) – A 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], optional) – A list of member names.

  • policy_ids (list[str], optional) – A 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], optional) – A list of policy names.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_quotas_groups(file_systems: Optional[List[ReferenceType]] = None, groups: Optional[List[ReferenceType]] = None, 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

Create a hard limit quota for a group.

Parameters

  • file_systems (list[FixedReference], optional) – A list of file_systems to query for. Overrides file_system_ids and file_system_names keyword arguments.

  • groups (list[FixedReference], optional) – A list of groups to query for. Overrides group_names keyword arguments.

  • file_system_ids (list[str], optional) – A 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], optional) – A 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], optional) – A 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], optional) – A 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, optional) –

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_quotas_users(file_systems: Optional[List[ReferenceType]] = None, users: Optional[List[ReferenceType]] = None, 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

Create a hard limit file system quota for a user.

Parameters

  • file_systems (list[FixedReference], optional) – A list of file_systems to query for. Overrides file_system_ids and file_system_names keyword arguments.

  • users (list[FixedReference], optional) – A list of users to query for. Overrides user_names keyword arguments.

  • file_system_ids (list[str], optional) – A 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], optional) – A 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], optional) – A 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], optional) – A 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, optional) –

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_rapid_data_locking_rotate(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.

Parameters

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_snmp_managers(references: Optional[List[ReferenceType]] = None, 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

Create an SNMP manager.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • snmp_manager (SnmpManagerPost, required) –

  • names (list[str], required) – A list of resource names.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_subnets(references: Optional[List[ReferenceType]] = None, 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

Create an array subnet.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • subnet (Subnet, required) –

  • names (list[str], required) – A list of resource names.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_syslog_servers(references: Optional[List[ReferenceType]] = None, 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

Configure a new syslog server. Transmission of syslog messages is enabled immediately.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • syslog_server (SyslogServerPostOrPatch, required) –

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_targets(references: Optional[List[ReferenceType]] = None, 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

Add a target for replication.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • names (list[str], required) – A list of resource names.

  • target (TargetPost, required) –

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

pypureclient.flashblade.FB_2_8.configuration 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.configuration.Configuration

Bases: object

__init__()

Constructor

auth_settings()

Gets Auth Settings dict for api client.

Returns

The Auth Settings information dict.

property debug

Debug status

Parameters

value – The debug status, True or False.

Type

bool

get_api_key_with_prefix(identifier)

Gets API key (with prefix if set).

Parameters

identifier – The identifier of apiKey.

Returns

The token for api key authentication.

get_basic_auth_token()

Gets HTTP basic authentication header (string).

Returns

The token for basic HTTP authentication.

property logger_file

The logger file.

If the logger_file is None, then add stream handler and remove file handler. Otherwise, add file handler and remove stream handler.

Parameters

value – The logger_file path.

Type

str

property logger_format

The logger format.

The logger_formatter will be updated when sets logger_format.

Parameters

value – The format string.

Type

str

to_debug_report()

Gets the essential information for debugging.

Returns

The report for debugging.

class pypureclient.flashblade.FB_2_8.configuration.TypeWithDefault(name, bases, dct)

Bases: type

set_default(default)

pypureclient.flashblade.FB_2_8.rest 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

exception pypureclient.flashblade.FB_2_8.rest.ApiException(status=None, reason=None, http_resp=None)

Bases: Exception

__str__()

Custom error messages for exception

class pypureclient.flashblade.FB_2_8.rest.RESTClientObject(configuration, pools_size=4, maxsize=None)

Bases: object

DELETE(url, headers=None, query_params=None, body=None, _preload_content=True, _request_timeout=None)
GET(url, headers=None, query_params=None, _preload_content=True, _request_timeout=None)
HEAD(url, headers=None, query_params=None, _preload_content=True, _request_timeout=None)
OPTIONS(url, headers=None, query_params=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)
PATCH(url, headers=None, query_params=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)
POST(url, headers=None, query_params=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)
PUT(url, headers=None, query_params=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)
request(method, url, query_params=None, headers=None, body=None, post_params=None, _preload_content=True, _request_timeout=None)

Perform requests.

Parameters

  • method – http request method

  • url – http request url

  • query_params – query parameters in the url

  • headers – http request headers

  • body – request json body, for application/json

  • post_params – request post parameters, application/x-www-form-urlencoded and multipart/form-data

  • _preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

class pypureclient.flashblade.FB_2_8.rest.RESTResponse(resp)

Bases: IOBase

getheader(name, default=None)

Returns a given response header.

getheaders()

Returns a dictionary of the response headers.

Module contents

pypureclient.flashblade.FB_2_8.add_properties(model)