FlashBlade Reference

Client

FlashBlade REST Client Factory Method

pypureclient.flashblade.client.Client(target, version=None, 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)

Initialize a FlashBlade Client.

Keyword Arguments:
 
  • target (str, required) – The target array’s IP or hostname.
  • version (str, optional) – REST API version to use. Defaults to the most recent version supported by both the client and the target array.
  • 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.
Raises:

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

Importable as

from pypureclient.flashblade import Client

FlashBlade REST 2.0 Client

class pypureclient.flashblade.FB_2_0.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)

FlashBlade REST 2.1 Client

class pypureclient.flashblade.FB_2_1.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)

FlashBlade REST 2.2 Client

class pypureclient.flashblade.FB_2_2.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)

FlashBlade REST 2.3 Client

class pypureclient.flashblade.FB_2_3.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)

FlashBlade REST 2.4 Client

class pypureclient.flashblade.FB_2_4.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)
__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)

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.
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=None, ids=None, local_only=None, names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=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=None, admin_ids=None, admin_names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=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=None, ids=None, names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=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=None, ids=None, names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=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=None, ids=None, names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=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=None, remotes=None, ids=None, remote_ids=None, remote_names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=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=False, _return_http_data_only=False, _preload_content=True, _request_timeout=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=None, ids=None, names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=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=None, ids=None, names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=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=None, certificate_groups=None, certificate_ids=None, certificate_group_ids=None, certificate_group_names=None, certificate_names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=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=None, ids=None, names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=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=None, certificate_groups=None, certificate_ids=None, certificate_group_ids=None, certificate_group_names=None, certificate_names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=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=None, ids=None, names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=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=None, policies=None, member_ids=None, member_names=None, policy_ids=None, policy_names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=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=None, remotes=None, ids=None, names=None, remote_names=None, remote_ids=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=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=None, ids=None, names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=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_policies(members=None, policies=None, member_ids=None, member_names=None, policy_ids=None, policy_names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=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=None, ids=None, names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=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=None, names=None, ids=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=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=None, references=None, bucket_ids=None, bucket_names=None, ids=None, names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=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=None, ids=None, names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=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=None, ids=None, names=None, versions=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=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=None, ids=None, names=None, versions=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=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=None, names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=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=None, ids=None, names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=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=None, policies=None, member_ids=None, member_names=None, policy_ids=None, policy_names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=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=None, policies=None, names=None, policy_ids=None, policy_names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=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=None, ids=None, names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=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=None, ids=None, names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=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=None, ids=None, names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=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=None, policies=None, member_ids=None, member_names=None, policy_ids=None, policy_names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=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=None, ids=None, names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=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=None, ids=None, names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=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=None, policies=None, member_ids=None, member_names=None, policy_ids=None, policy_names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=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=None, policies=None, member_ids=None, member_names=None, policy_ids=None, policy_names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=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=None, groups=None, references=None, file_system_names=None, file_system_ids=None, gids=None, group_names=None, names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=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=None, references=None, users=None, file_system_names=None, file_system_ids=None, names=None, uids=None, user_names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=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=None, ids=None, names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=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=None, ids=None, names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=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=None, ids=None, names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=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=None, ids=None, names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=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=None, continuation_token=None, filter=None, ids=None, limit=None, names=None, offset=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, filter=None, ids=None, limit=None, names=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, continuation_token=None, expose_api_token=None, filter=None, ids=None, limit=None, names=None, offset=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, admin_ids=None, admin_names=None, continuation_token=None, expose_api_token=None, filter=None, limit=None, offset=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, continuation_token=None, filter=None, ids=None, limit=None, names=None, offset=None, refresh=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, filter=None, limit=None, offset=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, continuation_token=None, filter=None, ids=None, limit=None, names=None, offset=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, filter=None, ids=None, names=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, continuation_token=None, filter=None, ids=None, limit=None, names=None, offset=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, continuation_token=None, filter=None, ids=None, limit=None, names=None, offset=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, remotes=None, continuation_token=None, filter=None, ids=None, limit=None, offset=None, remote_ids=None, remote_names=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, continuation_token=None, filter=None, ids=None, limit=None, names=None, offset=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, remotes=None, continuation_token=None, filter=None, ids=None, limit=None, offset=None, remote_ids=None, remote_names=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, remotes=None, continuation_token=None, end_time=None, filter=None, ids=None, limit=None, offset=None, remote_ids=None, remote_names=None, resolution=None, sort=None, start_time=None, total_only=None, type=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, filter=None, limit=None, offset=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, filter=None, limit=None, names=None, sort=None, total_only=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, filter=None, limit=None, offset=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, filter=None, limit=None, offset=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, resolution=None, start_time=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, resolution=None, start_time=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, protocol=None, resolution=None, start_time=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, resolution=None, start_time=None, type=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, resolution=None, start_time=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, resolution=None, start_time=None, type=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, continuation_token=None, filter=None, limit=None, names=None, offset=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, continuation_token=None, filter=None, ids=None, limit=None, names=None, offset=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, continuation_token=None, filter=None, ids=None, limit=None, names=None, offset=None, sort=None, total_only=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, continuation_token=None, destroyed=None, filter=None, ids=None, limit=None, names=None, offset=None, sort=None, total_only=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, continuation_token=None, end_time=None, filter=None, ids=None, limit=None, names=None, offset=None, resolution=None, sort=None, start_time=None, total_only=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, continuation_token=None, end_time=None, filter=None, ids=None, limit=None, names=None, offset=None, resolution=None, sort=None, start_time=None, total_only=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, continuation_token=None, filter=None, ids=None, limit=None, names=None, offset=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, certificate_groups=None, continuation_token=None, certificate_ids=None, certificate_group_ids=None, certificate_group_names=None, certificate_names=None, filter=None, limit=None, offset=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, continuation_token=None, filter=None, ids=None, limit=None, names=None, offset=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, continuation_token=None, filter=None, ids=None, limit=None, names=None, offset=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, certificate_groups=None, continuation_token=None, certificate_ids=None, certificate_group_ids=None, certificate_group_names=None, certificate_names=None, filter=None, limit=None, offset=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, continuation_token=None, filter=None, ids=None, limit=None, names=None, offset=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, continuation_token=None, filter=None, ids=None, limit=None, names=None, offset=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, roles=None, continuation_token=None, ids=None, filter=None, limit=None, offset=None, role_ids=None, role_names=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, filter=None, ids=None, limit=None, names=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, continuation_token=None, filter=None, ids=None, limit=None, names=None, offset=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, continuation_token=None, filter=None, ids=None, limit=None, names=None, offset=None, sort=None, total_only=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, names_or_owners=None, owners=None, continuation_token=None, destroyed=None, filter=None, ids=None, limit=None, names_or_owner_names=None, offset=None, owner_ids=None, sort=None, total_only=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, policies=None, continuation_token=None, filter=None, limit=None, member_ids=None, member_names=None, offset=None, policy_ids=None, policy_names=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, names_or_owners=None, continuation_token=None, filter=None, ids=None, limit=None, names_or_owner_names=None, offset=None, sort=None, total_only=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, continuation_token=None, destroyed=None, filter=None, ids=None, limit=None, names=None, offset=None, sort=None, total_only=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, groups=None, references=None, file_system_ids=None, file_system_names=None, filter=None, gids=None, group_names=None, limit=None, names=None, sort=None, total_only=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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_performance(references=None, continuation_token=None, end_time=None, filter=None, ids=None, limit=None, names=None, offset=None, protocol=None, resolution=None, sort=None, start_time=None, total_only=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, policies=None, continuation_token=None, filter=None, limit=None, member_ids=None, member_names=None, offset=None, policy_ids=None, policy_names=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, policies=None, continuation_token=None, filter=None, limit=None, member_ids=None, member_names=None, offset=None, policy_ids=None, policy_names=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, references=None, users=None, file_system_ids=None, file_system_names=None, filter=None, limit=None, names=None, sort=None, total_only=None, uids=None, user_names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, continuation_token=None, filter=None, limit=None, offset=None, sort=None, ids=None, names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, continuation_token=None, filter=None, limit=None, offset=None, sort=None, ids=None, names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, end_time=None, filter=None, ids=None, limit=None, names=None, offset=None, resolution=None, sort=None, start_time=None, total_only=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, continuation_token=None, filter=None, ids=None, limit=None, names=None, offset=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, keytab_ids=None, keytab_names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, names=None, ids=None, filter=None, limit=None, offset=None, sort=None, continuation_token=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, names=None, ids=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, references=None, bucket_ids=None, bucket_names=None, continuation_token=None, filter=None, ids=None, limit=None, names=None, offset=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, start_time=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, continuation_token=None, filter=None, ids=None, limit=None, names=None, offset=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, continuation_token=None, filter=None, ids=None, limit=None, names=None, offset=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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_nfs_export_policies(references=None, continuation_token=None, filter=None, ids=None, limit=None, names=None, offset=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, policies=None, continuation_token=None, filter=None, ids=None, limit=None, names=None, offset=None, policy_ids=None, policy_names=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, continuation_token=None, filter=None, limit=None, names=None, offset=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, continuation_token=None, exclude_rules=None, filter=None, ids=None, limit=None, names=None, offset=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, policies=None, continuation_token=None, filter=None, limit=None, member_ids=None, member_names=None, offset=None, policy_ids=None, policy_names=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, policies=None, continuation_token=None, filter=None, limit=None, names=None, offset=None, policy_ids=None, policy_names=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, continuation_token=None, filter=None, limit=None, names=None, offset=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, continuation_token=None, filter=None, ids=None, limit=None, names=None, offset=None, sort=None, total_only=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, continuation_token=None, filter=None, ids=None, limit=None, names=None, offset=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, continuation_token=None, filter=None, ids=None, limit=None, names=None, offset=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, policies=None, continuation_token=None, filter=None, limit=None, member_ids=None, member_names=None, offset=None, policy_ids=None, policy_names=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, continuation_token=None, filter=None, ids=None, limit=None, names=None, offset=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, continuation_token=None, filter=None, ids=None, limit=None, names=None, offset=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, continuation_token=None, filter=None, ids=None, limit=None, names=None, offset=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, members=None, policies=None, remotes=None, remote_file_systems=None, continuation_token=None, filter=None, limit=None, local_file_system_ids=None, local_file_system_names=None, member_ids=None, member_names=None, member_types=None, offset=None, policy_ids=None, policy_names=None, remote_ids=None, remote_file_system_ids=None, remote_file_system_names=None, remote_names=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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[ModelsFB24ResourceTypeYaml], 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=None, policies=None, continuation_token=None, filter=None, limit=None, member_ids=None, member_names=None, offset=None, policy_ids=None, policy_names=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, policies=None, continuation_token=None, filter=None, limit=None, member_ids=None, member_names=None, offset=None, policy_ids=None, policy_names=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, members=None, policies=None, remotes=None, remote_file_systems=None, continuation_token=None, filter=None, limit=None, local_file_system_ids=None, local_file_system_names=None, member_ids=None, member_names=None, member_types=None, offset=None, policy_ids=None, policy_names=None, remote_ids=None, remote_file_system_ids=None, remote_file_system_names=None, remote_names=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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[ModelsFB24ResourceTypeYaml], 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=None, groups=None, references=None, continuation_token=None, file_system_ids=None, file_system_names=None, filter=None, gids=None, group_names=None, limit=None, names=None, offset=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, ids=None, names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, references=None, users=None, continuation_token=None, file_system_ids=None, file_system_names=None, filter=None, limit=None, names=None, offset=None, sort=None, uids=None, user_names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, continuation_token=None, ids=None, filter=None, limit=None, names=None, offset=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, continuation_token=None, filter=None, ids=None, limit=None, names=None, offset=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, continuation_token=None, filter=None, ids=None, limit=None, names=None, offset=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, continuation_token=None, filter=None, ids=None, limit=None, names=None, offset=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, continuation_token=None, ids=None, filter=None, limit=None, names=None, offset=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, continuation_token=None, ids=None, filter=None, limit=None, names=None, offset=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, continuation_token=None, filter=None, ids=None, limit=None, names=None, offset=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, ids=None, names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, sort=None, test_type=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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_syslog_servers(references=None, continuation_token=None, filter=None, ids=None, limit=None, names=None, offset=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, continuation_token=None, filter=None, ids=None, limit=None, names=None, offset=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, continuation_token=None, filter=None, ids=None, limit=None, names=None, offset=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, continuation_token=None, end_time=None, filter=None, ids=None, limit=None, names=None, offset=None, resolution=None, sort=None, start_time=None, total_only=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, groups=None, continuation_token=None, file_system_ids=None, file_system_names=None, filter=None, gids=None, group_names=None, limit=None, offset=None, sort=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, users=None, continuation_token=None, file_system_ids=None, file_system_names=None, filter=None, limit=None, offset=None, sort=None, uids=None, user_names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=False, _return_http_data_only=False, _preload_content=True, _request_timeout=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=None, active_directory=None, ids=None, names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, admin=None, ids=None, names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, alert_watcher=None, ids=None, names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, alerts_settings=None, ids=None, names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, api_clients=None, ids=None, names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, remotes=None, array_connection=None, ids=None, remote_ids=None, remote_names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, bucket=None, ids=None, names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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 (Bucket, 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_certificates(references=None, certificate=None, ids=None, names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, directory_service=None, ids=None, names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, roles=None, directory_service_roles=None, ids=None, role_ids=None, role_names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, filter=None, ids=None, names=None, sort=None, directory_service=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, dns=None, ids=None, names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, file_system_snapshot=None, ids=None, latest_replica=None, names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, file_system=None, delete_link_on_eradication=None, discard_detailed_permissions=None, discard_non_snapshotted_data=None, ids=None, ignore_usage=None, names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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 file system with usage over its provisioned size. The update can be either setting hard_limit_enabled when usage is higher than provisioned size, or resize provisioned size 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=None, hardware=None, ids=None, names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, hardware_connector=None, ids=None, names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, kmip_server=None, names=None, ids=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, references=None, lifecycle=None, bucket_ids=None, bucket_names=None, ids=None, names=None, confirm_date=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, network_interface=None, ids=None, names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, policy=None, ids=None, names=None, versions=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, rule=None, before_rule_id=None, before_rule_name=None, ids=None, names=None, versions=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, names=None, object_store_access_key=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, enforce_action_restrictions=None, ids=None, names=None, policy=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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.
  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.
  • _return_http_data_only (bool, optional) – Returns only data field.
  • _preload_content (bool, optional) – Response is converted into objects.
  • _request_timeout (int, optional) – Total request timeout in seconds.
Returns:

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

Return type:

ValidResponse

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=None, policies=None, rule=None, enforce_action_restrictions=None, names=None, policy_ids=None, policy_names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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_remote_credentials(references=None, remote_credentials=None, ids=None, names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, policy=None, ids=None, destroy_snapshots=None, names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, groups=None, references=None, file_system_names=None, file_system_ids=None, gids=None, group_names=None, names=None, quota=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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.
  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.
  • _return_http_data_only (bool, optional) – Returns only data field.
  • _preload_content (bool, optional) – Response is converted into objects.
  • _request_timeout (int, optional) – Total request timeout in seconds.
Returns:

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

Return type:

ValidResponse

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=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, references=None, users=None, file_system_names=None, file_system_ids=None, names=None, uids=None, user_names=None, quota=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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.
  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.
  • _return_http_data_only (bool, optional) – Returns only data field.
  • _preload_content (bool, optional) – Response is converted into objects.
  • _request_timeout (int, optional) – Total request timeout in seconds.
Returns:

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

Return type:

ValidResponse

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=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, snmp_manager=None, ids=None, names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, subnet=None, ids=None, names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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_syslog_servers(references=None, syslog_server=None, ids=None, names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, syslog_server_settings=None, ids=None, names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, target=None, ids=None, names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, active_directory=None, names=None, join_existing_account=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, admin_ids=None, admin_names=None, timeout=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, names=None, alert_watcher=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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.
  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.
  • _return_http_data_only (bool, optional) – Returns only data field.
  • _preload_content (bool, optional) – Response is converted into objects.
  • _request_timeout (int, optional) – Total request timeout in seconds.
Returns:

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

Return type:

ValidResponse

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=None, api_client=None, names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, bucket=None, names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

Create a new object store bucket.

Parameters:
  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.
  • bucket (BucketPost, 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_certificate_groups(references=None, names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, certificate_groups=None, certificate_ids=None, certificate_group_ids=None, certificate_group_names=None, certificate_names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, certificate=None, names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, certificate_groups=None, certificate_ids=None, certificate_group_ids=None, certificate_group_names=None, certificate_names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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=None, source_ids=None, source_names=None, send=None, targets=None, file_system_snapshot=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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.
  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.
  • _return_http_data_only (bool, optional) – Returns only data field.
  • _preload_content (bool, optional) – Response is converted into objects.
  • _request_timeout (int, optional) – Total request timeout in seconds.
Returns:

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

Return type:

ValidResponse

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=None, names=None, file_system=None, discard_non_snapshotted_data=None, overwrite=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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_policies(members=None, policies=None, member_ids=None, member_names=None, policy_ids=None, policy_names=None, async_req=False, _return_http_data_only=False, _preload_content=True, _request_timeout=None)

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: