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, verify_ssl=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.

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

Raises

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

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, verify_ssl=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, verify_ssl=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, verify_ssl=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, verify_ssl=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, verify_ssl=None)

FlashBlade REST 2.5 Client

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

FlashBlade REST 2.6 Client

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

FlashBlade REST 2.7 Client

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

FlashBlade REST 2.8 Client

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

FlashBlade REST 2.9 Client

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

FlashBlade REST 2.10 Client

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

FlashBlade REST 2.11 Client

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

FlashBlade REST 2.12 Client

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

FlashBlade REST 2.13 Client

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Raises

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

configure_ca_certificate_file(ca_certs_file_path)

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

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

Delete an Active Directory account.

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_admins_api_tokens(admins: Optional[List[ReferenceType]] = None, admin_ids: Optional[List[str]] = None, admin_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) None

Deletes the API tokens of the specified administrators.

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

Delete cached administrator role information by name or ID.

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

Delete an alert watcher.

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

Delete the API client.

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_array_connections(references: Optional[List[ReferenceType]] = None, remotes: Optional[List[ReferenceType]] = None, ids: Optional[List[str]] = None, remote_ids: Optional[List[str]] = None, remote_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) None

Delete a connection to an array.

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

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

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

  • remote_ids (list[str], optional) – A list of remote array IDs. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_names query parameter.

  • remote_names (list[str], optional) – A list of remote array names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with remote_ids query parameter.

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

Delete a bucket replica link.

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

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

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

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

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

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

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

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

  • remote_ids (list[str], optional) – A list of remote array IDs. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_names query parameter.

  • remote_names (list[str], optional) – A list of remote array names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with remote_ids query parameter.

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

Delete object store buckets.

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_buckets_bucket_access_policies(buckets: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, bucket_ids: Optional[List[str]] = None, bucket_names: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) None

Delete a bucket policy of the specified bucket. Either names or bucket_names/bucket_ids query parameters can be used.

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

  • names (list[str], optional) – A list 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_buckets_bucket_access_policies_rules(buckets: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, bucket_ids: Optional[List[str]] = None, bucket_names: Optional[List[str]] = None, names: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) None

Delete one or more bucket policy rules for the specified bucket. Either policy_names or bucket_names/bucket_ids query parameters can be used.

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 names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_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.

  • names (list[str], optional) – A list 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_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_buckets_cross_origin_resource_sharing_policies(buckets: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, bucket_ids: Optional[List[str]] = None, bucket_names: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) None

Delete a cross origin resource sharing policy of the specified bucket. Either names or bucket_names/bucket_ids query parameters can be used.

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

  • names (list[str], optional) – A list 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_buckets_cross_origin_resource_sharing_policies_rules(buckets: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, bucket_ids: Optional[List[str]] = None, bucket_names: Optional[List[str]] = None, names: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) None

Delete one or more cross origin resource sharing policy rules for the specified bucket. Either policy_names or bucket_names query parameters can be used.

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 names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_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.

  • names (list[str], optional) – A list 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_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_certificate_groups(references: Optional[List[ReferenceType]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) None

Delete one or more certificate groups from the array.

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_certificate_groups_certificates(certificates: Optional[List[ReferenceType]] = None, certificate_groups: Optional[List[ReferenceType]] = None, certificate_ids: Optional[List[str]] = None, certificate_group_ids: Optional[List[str]] = None, certificate_group_names: Optional[List[str]] = None, certificate_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) None

Delete one or more certificate groups.

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

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

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

Delete a CA certificate from the array.

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_certificates_certificate_groups(certificates: Optional[List[ReferenceType]] = None, certificate_groups: Optional[List[ReferenceType]] = None, certificate_ids: Optional[List[str]] = None, certificate_group_ids: Optional[List[str]] = None, certificate_group_names: Optional[List[str]] = None, certificate_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) None

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

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

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

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

Delete 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_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.

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

  • cancel_in_progress_transfers (bool, optional) – This parameter must be set to true in order to delete a file system replication link (which can cancel any in-progress replication transfers). Setting this parameter to true is acknowledgement that any in-progress replication transfers on the specified links will be cancelled when this request is fulfilled.

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

Remove a policy from a file system replication link.

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

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

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

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

  • local_file_system_ids (list[str], optional) – A list of local file system IDs. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the local_file_system_names query parameter.

  • local_file_system_names (list[str], optional) – A list of local file system names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with local_file_system_ids query parameter.

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

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

  • policy_names (list[str], optional) – A list of policy names.

  • remote_ids (list[str], optional) – A list of remote array IDs. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_names query parameter.

  • remote_names (list[str], optional) – A list of remote array names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with remote_ids query parameter.

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

Delete a file system snapshot.

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

Remove snapshot scheduling policies from a file system.

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

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

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

  • member_names (list[str], optional) – A list of member names.

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

  • policy_names (list[str], optional) – A list of policy names.

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_file_system_snapshots_transfer(references: Optional[List[ReferenceType]] = None, remotes: Optional[List[ReferenceType]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, remote_names: Optional[List[str]] = None, remote_ids: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) None

Delete file system snapshot transfers from the source array to the target array.

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

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

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

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

  • remote_names (list[str], optional) – A list of remote array names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with remote_ids query parameter.

  • remote_ids (list[str], optional) – A list of remote array IDs. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_names query parameter.

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

Deletes a file system. Deleting a file system is equivalent to eradication. A file system’s destroyed parameter must be set to true before a file system can be deleted.

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_file_systems_locks(clients: Optional[List[ReferenceType]] = None, file_systems: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, client_names: Optional[List[str]] = None, file_system_ids: Optional[List[str]] = None, file_system_names: Optional[List[str]] = None, inodes: Optional[List[float]] = None, names: Optional[List[str]] = None, paths: Optional[List[str]] = None, recursive: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) None

Invalidates file locks. It can be used to either delete an individual lock by name or multiple locks filtered by parameters. E.g. to delete locks held by a client on specific file, parameters client_names, file_system_ids or file_system_names and path must be specified. When names is specified, no other query parameter can be specified.

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

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

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

  • client_names (list[str], optional) – A list of ip addresses of clients. For IPv6 both the extended format (x:x:x:x:x:x:x:x) and the shortened format are supported.

  • file_system_ids (list[str], optional) – A list of file system IDs. If after filtering, there is not at least one resource that matches each of the elements of file_system_ids, then an error is returned. This cannot be provided together with the file_system_names query parameter.

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

  • inodes (list[float], optional) – A list of inodes used for filtering file locks query by inodes. This may only be specified if file_system_ids or file_system_names is also specified. This cannot be provided together with the paths query parameter.

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

  • paths (list[str], optional) – A list of paths used for filtering file locks query by paths. This may only be specified if file_system_ids or file_system_names is also specified. This cannot be provided together with the inodes query parameter.

  • recursive (bool, optional) – Flag used to indicate that the action should be done recursively. If set to true and used e.g. with path pointing to a directory, the operation will delete all locks in given directory and subdirectories recursively. For more fine grained control over deleted locks, use delete by name. 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.

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

Remove a snapshot scheduling policy from a file system.

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

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

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

  • member_names (list[str], optional) – A list of member names.

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

  • policy_names (list[str], optional) – A list of policy names.

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_file_systems_sessions(clients: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, users: Optional[List[ReferenceType]] = None, client_names: Optional[List[str]] = None, disruptive: Optional[bool] = None, names: Optional[List[str]] = None, protocols: Optional[List[str]] = None, user_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) None

Delete sessions. It can be used to either delete an individual session by name or multiple sessions filtered by parameters. E.g. to delete SMBv3 sessions held by specific client, protocols and client_names must be specified. To prevent accidental deletes, setting flag disruptive to true is required when only a single query parameter is part of the query. E.g. to delete all SMBv3 sessions, query parameters protocols and disruptive must be set. When names is specified, no other query parameter can be specified.

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

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

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

  • client_names (list[str], optional) – A list of ip addresses of clients. For IPv6 both the extended format (x:x:x:x:x:x:x:x) and the shortened format are supported.

  • disruptive (bool, optional) – If set to true, a wide scope of sessions may be deleted in a single action using a single query parameter from user_names, client_names, or protocols. Otherwise, multiple query parameters must be specified to narrow the impact of deletion and avoid potential for accidental disruption of clients.

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

  • protocols (list[str], optional) – A list of file protocols. Valid values include nfs and smb.

  • user_names (list[str], optional) – A list of user names.

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

Delete a Kerberos keytab file.

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_lifecycle_rules(buckets: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, bucket_ids: Optional[List[str]] = None, bucket_names: Optional[List[str]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) None

Deletes individual lifecycle rules by name or id, or deletes all rules for a bucket. If ids is specified, bucket_names or bucket_ids is also required. If bucket_names or bucket_ids are specified without ids, delete all the rules for the bucket.

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

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

  • bucket_ids (list[str], optional) – A list of bucket IDs. If after filtering, there is not at least one resource that matches each of the elements of bucket_ids, then an error is returned. This cannot be provided together with the bucket_names query parameter. This can be provided with the ids query parameter but not with names.

  • bucket_names (list[str], optional) – A list of bucket names. If there is not at least one resource that matches each of the elements of bucket_names, then an error is returned. This cannot be provided together with the bucket_ids query parameter. This can be provided with the ids query parameter but not with names.

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

Remove a link aggregation group to unbind the ports.

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

Delete one or more network access policy rules.

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_network_interfaces(references: Optional[List[ReferenceType]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) None

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

Delete one or more NFS export policies.

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

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

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

  • versions (list[str], optional) – A list of versions. This is an optional query param used for concurrency control. The ordering should match the names or ids query param. This will fail with a 412 Precondition failed if the resource was changed and the current version of the resource doesn’t match the value in the query param.

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

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

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

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

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

  • versions (list[str], optional) – A list of versions. This is an optional query param used for concurrency control. The ordering should match the names or ids query param. This will fail with a 412 Precondition failed if the resource was changed and the current version of the resource doesn’t match the value in the query param.

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

Delete one or more access policies.

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

Revokes an object store user’s access policy.

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

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

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

  • member_names (list[str], optional) – A list of member names.

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

  • policy_names (list[str], optional) – A list of policy names.

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

Delete one or more access policy rules.

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

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

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

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

  • policy_names (list[str], optional) – A list of policy names.

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

Delete an object store account.

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

Delete object store remote credentials.

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

Delete an object store user.

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

Revoke an object store user’s access policy.

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

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

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

  • member_names (list[str], optional) – A list of member names.

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

  • policy_names (list[str], optional) – A list of policy names.

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

Delete an object store virtual host.

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

Delete one or more snapshot scheduling policies.

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

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

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

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

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

  • local_file_system_ids (list[str], optional) – A list of local file system IDs. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the local_file_system_names query parameter.

  • local_file_system_names (list[str], optional) – A list of local file system names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with local_file_system_ids query parameter.

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

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

  • policy_names (list[str], optional) – A list of policy names.

  • remote_ids (list[str], optional) – A list of remote array IDs. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_names query parameter.

  • remote_names (list[str], optional) – A list of remote array names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with remote_ids query parameter.

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

Remove the snapshot scheduling policy mapped to a file system.

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

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

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

  • member_names (list[str], optional) – A list of member names.

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

  • policy_names (list[str], optional) – A list of policy names.

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

Remove the snapshot scheduling policy mapped to a file system.

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

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

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

  • member_names (list[str], optional) – A list of member names.

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

  • policy_names (list[str], optional) – A list of policy names.

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_quotas_groups(file_systems: Optional[List[ReferenceType]] = None, groups: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, file_system_names: Optional[List[str]] = None, file_system_ids: Optional[List[str]] = None, gids: Optional[List[int]] = None, group_names: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) None

Delete a hard limit quota for a group.

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

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

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

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

  • file_system_ids (list[str], optional) – A list of file system IDs. If after filtering, there is not at least one resource that matches each of the elements of file_system_ids, then an error is returned. This cannot be provided together with the file_system_names query parameter.

  • gids (list[int], optional) – A list of group IDs. If there is not at least one resource that matches each of the elements of gids, then an error is returned. This cannot be provided together with group_names query parameter.

  • group_names (list[str], optional) – A list of group names. If there is not at least one resource that matches each of the elements of group_names, then an error is returned. This cannot be provided together with gids query parameter.

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_quotas_users(file_systems: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, users: Optional[List[ReferenceType]] = None, file_system_names: Optional[List[str]] = None, file_system_ids: Optional[List[str]] = None, names: Optional[List[str]] = None, uids: Optional[List[int]] = None, user_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) None

Delete a hard limit file system quota for a user.

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

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

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

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

  • file_system_ids (list[str], optional) – A list of file system IDs. If after filtering, there is not at least one resource that matches each of the elements of file_system_ids, then an error is returned. This cannot be provided together with the file_system_names query parameter.

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

  • uids (list[int], optional) – A list of user IDs. If there is not at least one resource that matches each of the elements of uids, then an error is returned. This cannot be provided together with user_names query parameter.

  • user_names (list[str], optional) – A list of user names. If there is not at least one resource that matches each of the elements of user_names, then an error is returned. This cannot be provided together with uids query parameter.

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

Delete one or more SMB Client 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_smb_client_policies_rules(references: Optional[List[ReferenceType]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, versions: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) None

Delete one or more SMB Client 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_smb_share_policies(references: Optional[List[ReferenceType]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) None

Delete one or more SMB Share 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_smb_share_policies_rules(references: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) None

Delete one or more SMB Share policy rules. One of the following is required: ids or names. If names is provided, the policy_ids or policy_names parameter is also required.

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.

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

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

  • policy_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_snmp_managers(references: Optional[List[ReferenceType]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) None

Remove an SNMP manager.

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

Remove an array subnet.

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

Delete a configured syslog server and stop forwarding syslog messages.

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

Delete the connection to the target for replication.

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

disable_verify_ssl()

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

enable_verify_ssl(ca_certs_file_path=None)

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

get_access_token(refresh=False)

Get the last used access token.

Parameters

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

Returns

str

Raises

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

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

List an Active Directory account and its configuration.

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

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

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

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

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

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

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

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

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

get_admins(references: Optional[List[ReferenceType]] = None, continuation_token: Optional[str] = None, expose_api_token: Optional[bool] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) AdminGetResponse

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

Displays API tokens for the specified administrators.

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

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

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

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

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

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

get_admins_cache(references: Optional[List[ReferenceType]] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, refresh: Optional[bool] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) AdminCacheGetResponse

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

Return global admin settings.

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

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

List alert watchers that are configured to receive alert messages.

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

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

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

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

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

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

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

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

List an API client and its configuration attributes.

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

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

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

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

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

List connected arrays for replication.

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

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

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

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

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

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

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

  • remote_ids (list[str], optional) – A list of remote array IDs. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_names query parameter.

  • remote_names (list[str], optional) – A list of remote array names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with remote_ids query parameter.

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

List network path details of connected arrays.

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

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

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

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

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

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

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

  • remote_ids (list[str], optional) – A list of remote array IDs. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_names query parameter.

  • remote_names (list[str], optional) – A list of remote array names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with remote_ids query parameter.

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

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

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

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

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

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

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

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

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

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

  • remote_ids (list[str], optional) – A list of remote array IDs. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_names query parameter.

  • remote_names (list[str], optional) – A list of remote array names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with remote_ids query parameter.

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

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

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

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

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

get_arrays_clients_performance(references: Optional[List[ReferenceType]] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, sort: Optional[List[str]] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) ClientPerformanceGetResponse

List NFS client I/O performance metrics.

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

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

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

List the End User Agreement and signature.

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

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

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

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

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

List the HTTP performance metrics of the array.

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

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

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

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

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

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_arrays_nfs_specific_performance(end_time: Optional[int] = None, resolution: Optional[int] = None, start_time: Optional[int] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) ArrayNfsSpecificPerformanceGet

List the NFS performance metrics of the array.

Parameters
  • end_time (int, optional) – When the time window ends (in milliseconds since epoch).

  • resolution (int, optional) – The desired ms between samples. Available resolutions may depend on data type, start_time and end_time. In general 1000, 30000, 300000, 1800000, 7200000, and 86400000 are possible values.

  • start_time (int, optional) – When the time window starts (in milliseconds since epoch).

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_arrays_performance(end_time: Optional[int] = None, protocol: Optional[str] = None, resolution: Optional[int] = None, start_time: Optional[int] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) ArrayPerformanceGetResponse

Lists the overall performance metrics of the array.

Parameters
  • end_time (int, optional) – When the time window ends (in milliseconds since epoch).

  • protocol (str, optional) – Display the performance of a specified protocol. Valid values are all, HTTP, SMB, NFS, and S3. If not specified, defaults to all, which will provide the combined performance of all available protocols.

  • resolution (int, optional) – The desired ms between samples. Available resolutions may depend on data type, start_time and end_time. In general 1000, 30000, 300000, 1800000, 7200000, and 86400000 are possible values.

  • start_time (int, optional) – When the time window starts (in milliseconds since epoch).

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_arrays_performance_replication(end_time: Optional[int] = None, resolution: Optional[int] = None, start_time: Optional[int] = None, type: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) ArrayPerformanceReplicationGetResp

List replication performance metrics.

Parameters
  • end_time (int, optional) – When the time window ends (in milliseconds since epoch).

  • resolution (int, optional) – The desired ms between samples. Available resolutions may depend on data type, start_time and end_time. In general 1000, 30000, 300000, 1800000, 7200000, and 86400000 are possible values.

  • start_time (int, optional) – When the time window starts (in milliseconds since epoch).

  • type (str, optional) – Display the metric of a specified object type. Valid values are all, file- system, and object-store. If not specified, defaults to all.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_arrays_s3_specific_performance(end_time: Optional[int] = None, resolution: Optional[int] = None, start_time: Optional[int] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) ArrayS3SpecificPerformanceGetResp

List the S3 performance metrics of the array.

Parameters
  • end_time (int, optional) – When the time window ends (in milliseconds since epoch).

  • resolution (int, optional) – The desired ms between samples. Available resolutions may depend on data type, start_time and end_time. In general 1000, 30000, 300000, 1800000, 7200000, and 86400000 are possible values.

  • start_time (int, optional) – When the time window starts (in milliseconds since epoch).

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_arrays_space(end_time: Optional[int] = None, resolution: Optional[int] = None, start_time: Optional[int] = None, type: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) ArraySpaceGetResponse

List available and used storage space on the array.

Parameters
  • end_time (int, optional) – When the time window ends (in milliseconds since epoch).

  • resolution (int, optional) – The desired ms between samples. Available resolutions may depend on data type, start_time and end_time. In general 1000, 30000, 300000, 1800000, 7200000, and 86400000 are possible values.

  • start_time (int, optional) – When the time window starts (in milliseconds since epoch).

  • type (str, optional) – Display the metric of a specified object type. Valid values are array, file- system, and object-store. If not specified, defaults to array.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_arrays_supported_time_zones(references: Optional[List[ReferenceType]] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) ArraysSupportedTimeZonesGetResponse

List supported time zones for the array.

Parameters
  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_audits(references: Optional[List[ReferenceType]] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) AuditGetResponse

List the array audit trail to view activities that were performed on the array.

Parameters
  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_blades(references: Optional[List[ReferenceType]] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) BladeGetResponse

List array blade information.

Parameters
  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_only (bool, optional) – Only return the total record for the specified items. The total record will be the total of all items after filtering. The items list will be empty.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

List bucket replica links for object replication.

Parameters
  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids keyword arguments.

  • local_buckets (list[FixedReference], optional) – A list of local_buckets to query for. Overrides local_bucket_ids and local_bucket_names keyword arguments.

  • remote_buckets (list[FixedReference], optional) – A list of remote_buckets to query for. Overrides remote_bucket_names keyword arguments.

  • remotes (list[FixedReference], optional) – A list of remotes to query for. Overrides remote_ids and remote_names keyword arguments.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • local_bucket_ids (list[str], optional) – A list of local bucket IDs. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the local_bucket_names query parameter.

  • local_bucket_names (list[str], optional) – A list of local bucket names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with local_bucket_ids query parameter.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • remote_bucket_names (list[str], optional) – A list of remote bucket names. If there is not at least one resource that matches each of the elements, then an error is returned.

  • remote_ids (list[str], optional) – A list of remote array IDs. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_names query parameter.

  • remote_names (list[str], optional) – A list of remote array names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with remote_ids query parameter.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_only (bool, optional) – Only return the total record for the specified items. The total record will be the total of all items after filtering. The items list will be empty.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_buckets(references: Optional[List[ReferenceType]] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) BucketGetResponse

List object store bucket attributes such as creation time and space usage.

Parameters
  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. If not set, lists both objects that are destroyed and those that are not destroyed. If object name(s) are specified in the names parameter, then each object referenced must exist. If destroyed is set to true, then each object referenced must also be destroyed. If destroyed is set to false, then each object referenced must also not be destroyed. An error is returned if any of these conditions are not met.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_only (bool, optional) – Only return the total record for the specified items. The total record will be the total of all items after filtering. The items list will be empty.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises
  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_buckets_bucket_access_policies(buckets: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, bucket_ids: Optional[List[str]] = None, bucket_names: Optional[List[str]] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) BucketAccessPolicyGetResponse

List a policy for the specified bucket and its attributes. Either names or bucket_names/bucket_ids query parameters can be used.

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 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.

  • 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_buckets_bucket_access_policies_rules(buckets: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, bucket_ids: Optional[List[str]] = None, bucket_names: Optional[List[str]] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, policy_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) BucketAccessPolicyRuleGetResponse

List bucket policy rules for the specified bucket and their attributes. Either policy_names or bucket_names/bucket_ids query parameters can be used.

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 names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_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.

  • 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_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_buckets_cross_origin_resource_sharing_policies(buckets: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, bucket_ids: Optional[List[str]] = None, bucket_names: Optional[List[str]] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: