FlashBlade Reference

Client

FlashBlade REST Client Factory Method

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

FlashBlade REST 2.14 Client

class pypureclient.flashblade.FB_2_14.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=None, ssl_cert=None, user_agent=None, verify_ssl=None)

FlashBlade REST 2.15 Client

class pypureclient.flashblade.FB_2_15.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=None, ssl_cert=None, user_agent=None, verify_ssl=None)

FlashBlade REST 2.16 Client

class pypureclient.flashblade.FB_2_16.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=None, ssl_cert=None, user_agent=None, verify_ssl=None)

FlashBlade REST 2.17 Client

class pypureclient.flashblade.FB_2_17.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=None, 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=None, 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.

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

  • 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, x_request_id: Optional[str] = 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.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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(references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Delete a local administrator..

Parameters

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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_admins_api_tokens(admins: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = 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.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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_admins_ssh_certificate_authority_policies(members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Remove a SSH Certificate Authority policy from a specific user.

Parameters

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

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

Delete an alert watcher.

Parameters

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Delete the API client.

Parameters

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, remotes: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = 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

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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. Deprecated, best practice is to reference connections with 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. Deprecated, best practice is to reference connections with 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 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(x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

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

Parameters

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

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

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

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

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

Returns

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

Return type

ValidResponse

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_ssh_certificate_authority_policies(members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Remove a SSH Certificate Authority policy from being a default for admins.

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.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

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

Delete one or more audit policies.

Parameters

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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_audit_file_systems_policies_members(contexts: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Remove the audit policy mapped to a file system.

Parameters

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

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • 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 a bucket replica link.

Parameters

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

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

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

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

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

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

Returns

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

Return type

ValidResponse

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

Delete object store buckets.

Parameters

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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, contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, bucket_ids: Optional[List[str]] = None, bucket_names: Optional[List[str]] = None, context_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.

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

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

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • names (list[str], optional) – A list 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, contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, bucket_ids: Optional[List[str]] = None, bucket_names: Optional[List[str]] = None, context_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.

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

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

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • names (list[str], optional) – A list 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, contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, bucket_ids: Optional[List[str]] = None, bucket_names: Optional[List[str]] = None, context_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.

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

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

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • names (list[str], optional) – A list 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, contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, bucket_ids: Optional[List[str]] = None, bucket_names: Optional[List[str]] = None, context_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.

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

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

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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(certificate_groups: Optional[List[ReferenceType]] = None, certificates: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, certificate_group_ids: Optional[List[str]] = None, certificate_group_names: Optional[List[str]] = None, certificate_ids: Optional[List[str]] = None, certificate_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Delete one or more certificate groups.

Parameters

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • 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 no resource 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_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_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, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Delete a CA certificate from the array.

Parameters

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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(certificate_groups: Optional[List[ReferenceType]] = None, certificates: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, certificate_group_ids: Optional[List[str]] = None, certificate_group_names: Optional[List[str]] = None, certificate_ids: Optional[List[str]] = None, certificate_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

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

Parameters

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

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

Delete an RBAC group configuration setting for manageability.

Parameters

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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_dns(references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Deletes a DNS configuration.

Parameters

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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_exports(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, context_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 a file system export.

Parameters

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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 a file system replication link.

Parameters

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

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

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

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

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

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

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

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

Returns

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

Return type

ValidResponse

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

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

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

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

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

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

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

Returns

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

Return type

ValidResponse

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

Delete a file system snapshot.

Parameters

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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(contexts: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Remove snapshot scheduling policies from a file system.

Parameters

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

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • 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(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, remotes: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, remote_ids: Optional[List[str]] = None, remote_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

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

Parameters

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

  • 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_ids and remote_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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_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, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_ids query parameter.

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

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

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

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

Returns

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

Return type

ValidResponse

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(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, context_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 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

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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_audit_policies(contexts: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Remove the audit policy mapped to a file system.

Parameters

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

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • 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_locks(clients: Optional[List[ReferenceType]] = None, file_systems: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = 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.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

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

Close open file from given identifiers.

Parameters

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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_file_systems_policies(contexts: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Remove a snapshot scheduling policy from a file system.

Parameters

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

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • 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, x_request_id: Optional[str] = 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.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

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

Permanently delete a fleet. A fleet can only be deleted if the current array is the only array in the fleet.

Parameters

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – Performs the operation on the unique resource IDs specified. Only one value is supported.

  • names (list[str], optional) – Performs the operation on the unique resource names specified. Only one value is supported.

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

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

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

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

Returns

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

Return type

ValidResponse

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_fleets_members(members: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, unreachable: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Remove the specified array(s) from the fleet. Note: that this will only succeed if the array(s) to be removed are not making use of any fleet resources.

Parameters

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

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

  • unreachable (bool, optional) – If set to true, allows a one-sided disconnect when the connection status is connecting instead of connected or partially connected. If set to false, it works just like normal coordinated disconnect. 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_keytabs(references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Delete a Kerberos keytab file.

Parameters

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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 a legal hold instance. Deletion is not allowed if the legal hold is applied to one or more paths.

Parameters

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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_lifecycle_rules(buckets: Optional[List[ReferenceType]] = None, contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, bucket_ids: Optional[List[str]] = None, bucket_names: Optional[List[str]] = None, context_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.

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

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

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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_maintenance_windows(references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Deletes an active maintenance window before its scheduled end (expire) time. The names parameter is required and must be set to array.

Parameters

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, versions: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → 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.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

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

Parameters

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

Remove a TLS policy from a network interface.

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.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

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

Delete one or more NFS export policies.

Parameters

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, versions: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

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

Parameters

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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, contexts: Optional[List[ReferenceType]] = None, names: Optional[List[str]] = None, x_request_id: Optional[str] = None, context_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.

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

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

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

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

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

Returns

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

Return type

ValidResponse

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

Delete one or more access policies.

Parameters

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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_roles(contexts: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Revoke an object store role’s access policy.

Parameters

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

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • 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_object_store_users(contexts: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Revokes an object store user’s access policy.

Parameters

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

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • 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(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, context_names: 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 access policy rules.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_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_ids and policy_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

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

Delete an object store account.

Parameters

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Delete object store remote credentials.

Parameters

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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_roles(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Delete existing object store roles.

Parameters

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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_roles_object_store_access_policies(contexts: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Revoke an object store role’s access policy.

Parameters

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

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • 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_roles_object_store_trust_policies_rules(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, roles: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, indices: Optional[List[int]] = None, names: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, role_ids: Optional[List[str]] = None, role_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Delete one or more trust policy rules.

Parameters

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

  • roles (list[FixedReference], optional) – A list of roles to query for. Overrides role_ids and role_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

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

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

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

  • role_names (list[str], optional) – A list of object store role names. If there is not at least one resource that matches each of the elements of role_names, then an error is returned. This cannot be provided together with the role_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_object_store_users(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Delete an object store user.

Parameters

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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(contexts: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Revoke an object store user’s access policy.

Parameters

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

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

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

Delete an object store virtual host.

Parameters

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Delete one or more snapshot scheduling policies.

Parameters

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

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

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

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

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

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

Returns

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

Return type

ValidResponse

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(contexts: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Remove the snapshot scheduling policy mapped to a file system.

Parameters

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

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • 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(contexts: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Remove the snapshot scheduling policy mapped to a file system.

Parameters

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

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

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

Deletes public key configurations.

Parameters

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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_qos_policies(references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Delete a QoS policy.

Parameters

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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_quotas_groups(contexts: Optional[List[ReferenceType]] = None, file_systems: Optional[List[ReferenceType]] = None, groups: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, file_system_ids: Optional[List[str]] = None, file_system_names: Optional[List[str]] = None, gids: Optional[List[int]] = None, group_names: Optional[List[str]] = None, 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

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

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

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

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

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

  • names (list[str], optional) – A list 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(contexts: Optional[List[ReferenceType]] = None, file_systems: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, users: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, file_system_ids: Optional[List[str]] = None, file_system_names: 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

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

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

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

Delete a server.

Parameters

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

  • cascade_delete (list[str], required) – The resource types to delete when deleting this object. It will fail if the resources are referenced by other objects. Valid values include directory- services.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Delete one or more SMB Client policies.

Parameters

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, versions: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

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

Parameters

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Delete one or more SMB Share policies.

Parameters

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = 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

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Remove an SNMP manager.

Parameters

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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_ssh_certificate_authority_policies(references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Deletes SSH Certificate Authority configurations.

Parameters

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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_ssh_certificate_authority_policies_admins(members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Remove a SSH Certificate Authority policy from a specific user.

Parameters

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • 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_ssh_certificate_authority_policies_arrays(members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Remove a SSH Certificate Authority policy from being a default for admins.

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.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

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

Delete OIDC SSO configurations.

Parameters

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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_sso_saml2_idps(references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Deletes SAML2 SSO configurations.

Parameters

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Remove an array subnet.

Parameters

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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_tls_policies(references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Deletes TLS policies.

Parameters

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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_tls_policies_network_interfaces(members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Remove a TLS policy from a network interface.

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.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

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

Delete a WORM data policy. Deletion is not allowed if the policy is attached to one or more file systems.

Parameters

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ActiveDirectoryGetResponse

List Active Directory accounts and their configuration.

Parameters

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • 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, x_request_id: Optional[str] = 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.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • 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, x_request_id: Optional[str] = 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.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • 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, x_request_id: Optional[str] = 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.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • 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, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, 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.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • 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(x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, 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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • 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_admins_ssh_certificate_authority_policies(members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, offset: Optional[int] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberGetResponse

List SSH Certificate Authority policies mapped to specific users.

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.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

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

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

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

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

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

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

get_alert_watchers(references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, 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.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • 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, x_request_id: Optional[str] = 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.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • 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, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, 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.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • 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, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, 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.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • 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(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, remotes: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, context_names: Optional[List[str]] = 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

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

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

  • 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, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, 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.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • 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(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, remotes: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, context_names: Optional[List[str]] = 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

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

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

  • 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, x_request_id: Optional[str] = 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.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

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

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

  • 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(x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, 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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • 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, x_request_id: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, sort: Optional[List[str]] = None, total_only: Optional[bool] = None, 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.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

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

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

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

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

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

Returns

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

Return type

ValidResponse

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(x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, 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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • 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(x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, 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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • 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(contexts: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, context_names: Optional[List[str]] = None, 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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

  • 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(contexts: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, context_names: Optional[List[str]] = None, 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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

  • 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(contexts: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, context_names: Optional[List[str]] = None, 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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

  • 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(contexts: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, context_names: Optional[List[str]] = None, 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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

  • 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(contexts: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, context_names: Optional[List[str]] = None, 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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

  • 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(contexts: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, context_names: Optional[List[str]] = None, 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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

  • 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_space_storage_classes(storage_classes: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, end_time: Optional[int] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, resolution: Optional[int] = None, sort: Optional[List[str]] = None, start_time: Optional[int] = None, storage_class_names: 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) → ArraySpaceStorageClassGetResponse

List available and used storage space for storage classes on the array.

Parameters

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

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

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

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

  • storage_class_names (list[str], optional) – A list of storage class names. Valid values include S500X-S and S500X-A.

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

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

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

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

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

Returns

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

Return type

ValidResponse

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_ssh_certificate_authority_policies(members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, offset: Optional[int] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberGetResponse

List SSH Certificate Authority policies mapped as defaults for admins.

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.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

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

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

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

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

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

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

get_arrays_supported_time_zones(references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, 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.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • 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_audit_file_systems_policies(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, context_names: Optional[List[str]] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → AuditFileSystemsPoliciesGetResponse

Displays a list of audit policies for file systems.

Parameters

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

  • 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_audit_file_systems_policies_members(contexts: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, context_names: Optional[List[str]] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, offset: Optional[int] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → AuditFileSystemsPoliciesMembersGetResponse

List file systems mapped to a audit policy.

Parameters

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

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

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

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

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

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

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

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

get_audits(references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, 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.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • 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, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_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.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

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

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

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

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

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

Returns

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

Return type

ValidResponse

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

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

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(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, context_names: Optional[List[str]] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_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

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

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

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

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

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

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

Returns

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

Return type

ValidResponse

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, contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, bucket_ids: Optional[List[str]] = None, bucket_names: Optional[List[str]] = None, context_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.

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

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

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

  • 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, contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, bucket_ids: Optional[List[str]] = None, bucket_names: Optional[List[str]] = None, context_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.

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

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

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

  • 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, contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, bucket_ids: Optional[List[str]] = None, bucket_names: Optional[List[str]] = None, context_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) → CrossOriginResourceSharingPolicyGetResponse

List cross origin resource sharing 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.

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

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

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

  • 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_cross_origin_resource_sharing_policies_rules(buckets: Optional[List[ReferenceType]] = None, contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, bucket_ids: Optional[List[str]] = None, bucket_names: Optional[List[str]] = None, context_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) → CrossOriginResourceSharingPolicyRuleGetResponse

List cross origin resource sharing policy rules for the specified bucket and their attributes. 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.

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

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

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

  • 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_performance(references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, end_time: Optional[int] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, resolution: Optional[int] = None, sort: Optional[List[str]] = None, start_time: Optional[int] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → BucketPerformanceGetResponse

List performance metrics for a bucket.

Parameters

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

get_buckets_s3_specific_performance(references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, end_time: Optional[int] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, resolution: Optional[int] = None, sort: Optional[List[str]] = None, start_time: Optional[int] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → BucketS3SpecificPerformanceGetResp

List performance metrics specific to S3 operations for a bucket.

Parameters

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

Display all array certificate groups.

Parameters

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

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

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

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

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

get_certificate_groups_certificates(certificate_groups: Optional[List[ReferenceType]] = None, certificates: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, certificate_group_ids: Optional[List[str]] = None, certificate_group_names: Optional[List[str]] = None, certificate_ids: Optional[List[str]] = None, certificate_names: Optional[List[str]] = None, 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) → CertificateGroupCertificateGetResp

List membership associations between groups and certificates on the array.

Parameters

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

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

  • 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_certificate_groups_uses(references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → CertificateGroupUseGetResponse

List how certificate groups are being used and by what.

Parameters

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

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

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

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

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

List array certificates and their attributes.

Parameters

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

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

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

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

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

get_certificates_certificate_groups(certificate_groups: Optional[List[ReferenceType]] = None, certificates: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, certificate_group_ids: Optional[List[str]] = None, certificate_group_names: Optional[List[str]] = None, certificate_ids: Optional[List[str]] = None, certificate_names: Optional[List[str]] = None, 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) → CertificateCertificateGroupGetResp

List membership associations between groups and certificates.

Parameters

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

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

  • 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_certificates_uses(references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → CertificateUseGetResponse

List how certificates are being used and by what.

Parameters

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

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

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

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

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

List directory service configuration information.

Parameters

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

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

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

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

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

Return array’s RBAC group configuration settings for manageability.

Parameters

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

  • roles (list[FixedReference], optional) – A list of roles to query for. Overrides role_ids and role_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • 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 names, role_names, or role_ids 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 IDs. If after filtering, there is not at least one resource that matches each of the elements of names, then an error is returned. This cannot be provided together with the ids, role_names, or role_ids query parameters.

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

  • role_ids (list[str], optional) – A list of role_ids. If after filtering, there is not at least one resource that matches each of the elements of role_ids, then an error is returned. This cannot be provided together with the ids, names or role_names query parameters. This query parameter is deprecated for use with directory service roles. If this parameter is used to query or modify directory service roles, but more than 1 configuration exists with a given role id, an error will be returned in order to avoid ambiguous operation.

  • role_names (list[str], optional) – A list of role_names. If there is not at least one resource that matches each of the elements of role_names, then an error is returned. This cannot be provided together with the ids, names, or role_ids query parameters. This query parameter is deprecated for use with directory service roles. If this parameter is used to query or modify directory service roles, but more than 1 configuration exists with a given role name, an error will be returned in order to avoid ambiguous operation.

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

Test the configured directory services on the array.

Parameters

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

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

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

Displays the current DNS configurations and their parameters including domain suffix, the list of DNS name server IP addresses, and the list of services that DNS parameters apply to.

Parameters

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

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

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

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

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

List array drive information.

Parameters

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

get_file_system_exports(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, context_names: Optional[List[str]] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → FileSystemExportGetResponse

List one or more file system exports.

Parameters

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

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

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

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

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

List file system replication link.

Parameters

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

List file system replication link policies.

Parameters

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

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

List the transfer status details for file system replication.

Parameters

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

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

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

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

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

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

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

  • names_or_owner_names (list[str], optional) – A list of resource names. Either the names of the snapshots or the owning file systems.

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

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

get_file_system_snapshots(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, names_or_owners: Optional[List[ReferenceType]] = None, owners: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, context_names: Optional[List[str]] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names_or_owner_names: Optional[List[str]] = None, offset: Optional[int] = None, owner_ids: Optional[List[str]] = None, sort: Optional[List[str]] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → FileSystemSnapshotGetResponse

List file system snapshots. Note: if more than 150,000 items would be returned in the response, an error will be thrown and query parameters must be used to limit the items queried.

Parameters

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

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

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

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

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. If not set, lists both objects that are destroyed and those that are not destroyed. If object name(s) are specified in the names parameter, then each object referenced must exist. If destroyed is set to true, then each object referenced must also be destroyed. If destroyed is set to false, then each object referenced must also not be destroyed. An error is returned if any of these conditions are not met.

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

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

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

  • names_or_owner_names (list[str], optional) – A list of resource names. Either the names of the snapshots or the owning file systems.

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

get_file_system_snapshots_policies(contexts: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, context_names: Optional[List[str]] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, offset: Optional[int] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyFileSystemSnapshotGetResponse

List file system snapshots mapped to snapshot scheduling policies. Note: if more than 150,000 items would be returned in the response, an error will be thrown and query parameters must be used to limit the items queried.

Parameters

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

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

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

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

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

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

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

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

get_file_system_snapshots_transfer(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, names_or_owners: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, context_names: Optional[List[str]] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names_or_owner_names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → FileSystemSnapshotGetTransferResponse

List file system snapshot transfers from the source array to the target array. Note: if more than 150,000 items would be returned in the response, an error will be thrown and query parameters must be used to limit the items queried.

Parameters

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

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

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

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

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

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

  • names_or_owner_names (list[str], optional) – A list of resource names. Either the names of the snapshots or the owning file systems.

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

get_file_systems(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, context_names: Optional[List[str]] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → FileSystemGetResponse

List one or more file systems on the array.

Parameters

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

get_file_systems_audit_policies(contexts: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, context_names: Optional[List[str]] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, offset: Optional[int] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → AuditFileSystemsPoliciesMembersGetResponse

List file systems mapped to a audit policy.

Parameters

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

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

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

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

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

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

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

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

get_file_systems_groups_performance(file_systems: Optional[List[ReferenceType]] = None, groups: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, file_system_ids: Optional[List[str]] = None, file_system_names: Optional[List[str]] = None, filter: Optional[str] = None, gids: Optional[List[str]] = None, group_names: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, sort: Optional[List[str]] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → FileSystemGroupsPerformanceGetResponse

List a group’s I/O performance metrics on a file system.

Parameters

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

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

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

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

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

  • gids (list[str], optional) – A list of group IDs. This cannot be provided together with group_names query parameter.

  • group_names (list[str], optional) – A list of group names. This cannot be provided together with gids query parameter.

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

get_file_systems_locks(clients: Optional[List[ReferenceType]] = None, file_systems: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, client_names: Optional[List[str]] = None, continuation_token: Optional[str] = None, file_system_ids: Optional[List[str]] = None, file_system_names: Optional[List[str]] = None, filter: Optional[str] = None, inodes: Optional[List[float]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, paths: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → FileLockGetResponse

Lists all active file locks that satisfy the conditions specified by the parameters.

Parameters

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

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

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

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

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

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

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

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

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

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

  • paths (list[str], optional) – 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.

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

get_file_systems_locks_clients(x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → FileSystemClientsGetResponse

Lists all clients that hold active file locks.

Parameters

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

get_file_systems_open_files(clients: Optional[List[ReferenceType]] = None, file_systems: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, sessions: Optional[List[ReferenceType]] = None, users: Optional[List[ReferenceType]] = None, protocols: Optional[List[str]] = None, x_request_id: Optional[str] = None, client_names: Optional[List[str]] = None, continuation_token: Optional[str] = None, file_system_ids: Optional[List[str]] = None, file_system_names: Optional[List[str]] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, paths: Optional[List[str]] = None, session_names: 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) → FileSystemOpenFilesGetResponse

List open files.

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

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

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

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

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

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

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

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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.

  • paths (list[str], optional) – A list of paths used for filtering open files query.

  • session_names (list[str], optional) – A list of session names used for filtering open files query. Files opened in any of the specified sessions will be returned.

  • user_names (list[str], optional) – A list of user names used for filtering open files query. Files opened by any of the specified users will be returned.

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

get_file_systems_performance(references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, end_time: Optional[int] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, protocol: Optional[str] = None, resolution: Optional[int] = None, sort: Optional[List[str]] = None, start_time: Optional[int] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → FileSystemPerformanceGetResponse

Displays the performance metrics for a file system.

Parameters

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

get_file_systems_policies(contexts: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, context_names: Optional[List[str]] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, offset: Optional[int] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberContextGetResponse

List file system snapshot scheduling policies. Note: if more than 150,000 items would be returned in the response, an error will be thrown and query parameters must be used to limit the items queried.

Parameters

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

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

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

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

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

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

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

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

get_file_systems_policies_all(contexts: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, context_names: Optional[List[str]] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, offset: Optional[int] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberContextGetResponse

List file system policies. Note: if more than 150,000 items would be returned in the response, an error will be thrown and query parameters must be used to limit the items queried.

Parameters

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

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

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

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

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

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

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

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

get_file_systems_sessions(clients: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, users: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, client_names: Optional[List[str]] = None, continuation_token: Optional[str] = None, limit: Optional[int] = 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) → FileSessionGetResponse

Lists all active sessions that satisfy the conditions specified by the parameters.

Parameters

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

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

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

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

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

get_file_systems_users_performance(file_systems: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, users: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, file_system_ids: Optional[List[str]] = None, file_system_names: Optional[List[str]] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, sort: Optional[List[str]] = None, total_only: Optional[bool] = None, uids: Optional[List[int]] = None, user_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → FileSystemUsersPerformanceGetResponse

List a user’s I/O performance metrics on a file system.

Parameters

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

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

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

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

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

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

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

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

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

  • uids (list[int], optional) – A list of user IDs. This cannot be provided together with user_names query parameter.

  • user_names (list[str], optional) – A list of user names. This cannot be provided together with uids query parameter.

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

get_file_systems_worm_data_policies(contexts: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, context_names: Optional[List[str]] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, offset: Optional[int] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → WormDataPoliciesMembersGetResponse

List file systems mapped to a WORM data policy.

Parameters

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

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

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

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

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

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

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

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

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

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

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

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

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

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

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

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_fleets(references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → FleetGetResponse

Displays information about the fleets known to the array.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • 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) – Performs the operation on the unique resource IDs specified. Only one value is supported.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique resource names specified. Only one value is supported.

  • 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) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

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_fleets_fleet_key(x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → FleetKeyGetResponse

Displays the time remaining on the fleet key. Note: fleet key itself is not displayed, since that is only available at the time of fleet key creation.

Parameters

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • 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.

  • total_only (bool, optional) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

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_fleets_members(fleets: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, fleet_ids: Optional[List[str]] = None, fleet_names: Optional[List[str]] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, member_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) → FleetMemberGetResponse

Displays the members in the current fleet.

Parameters

  • fleets (list[FixedReference], optional) – A list of fleets to query for. Overrides fleet_ids and fleet_names keyword arguments.

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • 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.

  • fleet_ids (list[str], optional) – Performs the operation on the unique Fleet IDs specified. This query currently accepts only 1 ID.

  • fleet_names (list[str], optional) – Performs the operation on the unique Fleet names specified. Enter multiple names in comma-separated format. For example, name01,name02. This query currently accepts only 1 name.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • member_ids (list[str], optional) – A list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (list[str], optional) – A list of member names.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_only (bool, optional) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_hardware(references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → HardwareGetResponse

List hardware slots and bays and the status of installed components.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • 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_hardware_connectors(references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → HardwareConnectorGetResponse

The endpoint is deprecated. Use the /network-interfaces/connectors endpoint instead. List array connection information.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • 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_hardware_connectors_performance(references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, end_time: Optional[int] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, resolution: Optional[int] = None, sort: Optional[List[str]] = None, start_time: Optional[int] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → HardwareConnectorPerformanceGetResponse

The endpoint is deprecated. Use the /network-interfaces/connectors/performance endpoint instead. Displays network statistics, historical bandwidth, and error reporting for all specified hardware connectors.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • end_time (int, optional) – When the time window ends (in milliseconds since epoch).

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • resolution (int, optional) – The desired ms between samples. Available resolutions may depend on data type, start_time and end_time. In general 1000, 30000, 300000, 1800000, 7200000, and 86400000 are possible values.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • start_time (int, optional) – When the time window starts (in milliseconds since epoch).

  • total_only (bool, optional) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_keytabs(references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → KeytabGetResponse

List a Kerberos keytab file and its configuration information.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_keytabs_download(keytabs: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, keytab_ids: Optional[List[str]] = None, keytab_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → KeytabFileResponse

Download a Kerberos keytab file. The file can be downloaded in the native binary format or a base64 encoded format. If not specified, defaults to binary.

Parameters

  • keytabs (list[FixedReference], optional) – A list of keytabs to query for. Overrides keytab_ids and keytab_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • keytab_ids (list[str], optional) – A list of keytab IDs. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the keytab_names query parameter.

  • keytab_names (list[str], optional) – A list of keytab names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with keytab_ids query parameter.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_kmip(references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → KmipServerResponse

Displays a list of KMIP server configurations.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • 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_kmip_test(references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → TestResultResponse

Displays a detailed result of of KMIP server test.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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.

List legal holds.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

List entities to which a legal hold has been applied.

Parameters

  • file_systems (list[FixedReference], optional) – A list of file_systems to query for. Overrides file_system_ids and file_system_names keyword arguments.

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • file_system_ids (list[str], optional) – A list of file system IDs. If after filtering, there is not at least one resource that matches each of the elements of file_system_ids, then an error is returned. This cannot be provided together with the file_system_names query parameter.

  • file_system_names (list[str], optional) – A list of file system names. If there is not at least one resource that matches each of the elements of file_system_names, then an error is returned.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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.

  • 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.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_lifecycle_rules(buckets: Optional[List[ReferenceType]] = None, contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, bucket_ids: Optional[List[str]] = None, bucket_names: Optional[List[str]] = None, context_names: Optional[List[str]] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → LifecycleRuleGetResponse

Returns a list of lifecycle rules. If names is specified, list the individual rules. If ids is specified, bucket_names or bucket_ids is also required. If bucket_names or bucket_ids are specified without ids, list all the rules for the bucket.

Parameters

  • buckets (list[FixedReference], optional) – A list of buckets to query for. Overrides bucket_ids and bucket_names keyword arguments.

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • 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.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

List the status and attributes of the Ethernet ports in the configured link aggregation groups.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_logs(x_request_id: str = None, end_time: int = None, start_time: int = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → models.file

Download a history of log events from the array to provide to Pure Technical Services for analysis.

Parameters

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • end_time (int, optional) – When the time window ends (in milliseconds since epoch).

  • start_time (int, optional) – When the time window starts (in milliseconds since epoch).

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_logs_async(references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → LogsAsyncGetResponse

List the attributes and status of preparation for a history of log events from the array to provide to Pure Technical Services for analysis.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_logs_async_download(references: List[models.ReferenceType] = None, x_request_id: str = None, names: List[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → models.file

Download the files which contain a history of log events from the array to provide to Pure Technical Services for analysis.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_maintenance_windows(references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → MaintenanceWindowsGetResponse

Displays maintenance window details, including start time, end time, and maintenance type.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_network_access_policies(references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → NetworkAccessPolicyGetResponse

Displays a list of network access policies.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_network_access_policies_members(members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, offset: Optional[int] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberGetResponse

List network access policies mapped to different configurations on the array.

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.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • member_ids (list[str], optional) – A list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (list[str], optional) – A list of member names.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • policy_ids (list[str], optional) – A list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (list[str], optional) – A list of policy names.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_network_access_policies_rules(references: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → NetworkAccessPolicyRuleGetResponse

Displays a list of network access policy rules.

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.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • policy_ids (list[str], optional) – A list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (list[str], optional) – A list of policy names.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_network_interfaces(references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → NetworkInterfaceGetResponse

List network interfaces and their attributes.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_network_interfaces_connectors(references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → NetworkInterfacesConnectorsGetResponse

List network connector information

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_network_interfaces_connectors_performance(references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, end_time: Optional[int] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, resolution: Optional[int] = None, sort: Optional[List[str]] = None, start_time: Optional[int] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → NetworkInterfacesConnectorsPerformanceGetResponse

Displays network statistics, historical bandwidth, and error reporting for all specified network connectors.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • end_time (int, optional) – When the time window ends (in milliseconds since epoch).

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • resolution (int, optional) – The desired ms between samples. Available resolutions may depend on data type, start_time and end_time. In general 1000, 30000, 300000, 1800000, 7200000, and 86400000 are possible values.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • start_time (int, optional) – When the time window starts (in milliseconds since epoch).

  • total_only (bool, optional) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_network_interfaces_connectors_settings(references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → NetworkInterfacesConnectorsSettingsGetResponse

Display the global network settings for network connectors.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_network_interfaces_ping(destination: Optional[str] = None, x_request_id: Optional[str] = None, component_name: Optional[str] = None, count: Optional[int] = None, packet_size: Optional[int] = None, print_latency: Optional[bool] = None, resolve_hostname: Optional[bool] = None, source: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → NetworkInterfacePingGetResponse

Display network interface ping result.

Parameters

  • destination (str, required) – A destination specified by user to run the network diagnosis against. Can be a hostname or an IP.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • component_name (str, optional) – Used by ping and trace to specify where to run the operation. Valid values are controllers and blades from hardware list. If not specified, defaults to all available controllers and selected blades.

  • count (int, optional) – Used by ping to specify the number of packets to send. If not specified, defaults to 1.

  • packet_size (int, optional) – Used by ping to specify the number of data bytes to be sent per packet. If not specified, defaults to 56.

  • print_latency (bool, optional) – Used by ping to specify whether or not to print the full user-to-user latency. If not specified, defaults to false.

  • resolve_hostname (bool, optional) – Used by ping and trace to specify whether or not to map IP addresses to host names. If not specified, defaults to true.

  • source (str, optional) – Used by ping and trace to specify the property where to start to run the specified operation. The property can be subnet or IP.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_network_interfaces_tls_policies(members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, offset: Optional[int] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberGetResponse

List network interface TLS policies.

Parameters

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • member_ids (list[str], optional) – A list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (list[str], optional) – A list of member names.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • policy_ids (list[str], optional) – A list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (list[str], optional) – A list of policy names.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_network_interfaces_trace(destination: Optional[str] = None, x_request_id: Optional[str] = None, component_name: Optional[str] = None, discover_mtu: Optional[bool] = None, fragment_packet: Optional[bool] = None, method: Optional[str] = None, port: Optional[str] = None, resolve_hostname: Optional[bool] = None, source: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → NetworkInterfaceTraceGetResponse

Display network interface trace result.

Parameters

  • destination (str, required) – A destination specified by user to run the network diagnosis against. Can be a hostname or an IP.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • component_name (str, optional) – Used by ping and trace to specify where to run the operation. Valid values are controllers and blades from hardware list. If not specified, defaults to all available controllers and selected blades.

  • discover_mtu (bool, optional) – Used by trace to specify whether or not to discover the MTU along the path being traced. If not specified, defaults to false.

  • fragment_packet (bool, optional) – Used by trace to specify whether or not to fragment packets. If not specified, defaults to true.

  • method (str, optional) – Used by trace to specify which method to use for trace operations. Valid values are icmp, tcp, and udp. If not specified, defaults to ‘udp’.

  • port (str, optional) – Used by trace to specify a destination port.

  • resolve_hostname (bool, optional) – Used by ping and trace to specify whether or not to map IP addresses to host names. If not specified, defaults to true.

  • source (str, optional) – Used by ping and trace to specify the property where to start to run the specified operation. The property can be subnet or IP.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_nfs_export_policies(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, context_names: Optional[List[str]] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → NfsExportPolicyGetResponse

Displays a list of NFS export policies.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_nfs_export_policies_rules(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, context_names: Optional[List[str]] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → NfsExportPolicyRuleGetResponse

Displays a list of NFS export policy rules. The default sort is by policy name, then index.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • 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.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • policy_ids (list[str], optional) – A list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (list[str], optional) – A list of policy names.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_object_store_access_keys(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, context_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) → ObjectStoreAccessKeyGetResponse

List object store access keys.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_object_store_access_policies(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, context_names: Optional[List[str]] = None, continuation_token: Optional[str] = None, exclude_rules: Optional[bool] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ObjectStoreAccessPolicyGetResponse

List access policies and their attributes.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • exclude_rules (bool, optional) – If true, the rules field in each policy will be null. If false, each returned policy will include its list of rules in the response. If not specified, defaults to false.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_object_store_access_policies_object_store_roles(contexts: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, context_names: Optional[List[str]] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, offset: Optional[int] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberContextGetResponse

List object store roles and their access policies.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • member_ids (list[str], optional) – A list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (list[str], optional) – A list of member names.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • policy_ids (list[str], optional) – A list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (list[str], optional) – A list of policy names.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_object_store_access_policies_object_store_users(contexts: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, context_names: Optional[List[str]] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, offset: Optional[int] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberContextGetResponse

List object store users and their access policies.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • member_ids (list[str], optional) – A list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (list[str], optional) – A list of member names.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • policy_ids (list[str], optional) – A list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (list[str], optional) – A list of policy names.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_object_store_access_policies_rules(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, context_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_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ObjectStoreAccessPolicyRuleGetResponse

List access policy rules and their attributes.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_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_ids and policy_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • policy_ids (list[str], optional) – A list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (list[str], optional) – A list of policy names.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_object_store_access_policy_actions(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, context_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) → ObjectStoreAccessPolicyActionGetResponse

List valid actions for access policy rules. Each action is either a valid AWS S3 action (prefixed by s3:) or our special wildcard action (s3:*). Each action, when included in a rule, may restrict which other properties may be set for that rule.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_object_store_accounts(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, context_names: Optional[List[str]] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ObjectStoreAccountGetResponse

List object store accounts and their attributes.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

  • 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) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_object_store_remote_credentials(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, context_names: Optional[List[str]] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ObjectStoreRemoteCredentialGetResp

List object store remote credentials used by bucket replica links to access buckets on remote arrays or targets.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_object_store_roles(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, context_names: Optional[List[str]] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ObjectStoreRoleGetResponse

List object store roles and their attributes.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_object_store_roles_object_store_access_policies(contexts: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, context_names: Optional[List[str]] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, offset: Optional[int] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberContextGetResponse

List object store roles and their access policies.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • member_ids (list[str], optional) – A list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (list[str], optional) – A list of member names.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • policy_ids (list[str], optional) – A list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (list[str], optional) – A list of policy names.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_object_store_roles_object_store_trust_policies(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, roles: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, context_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, role_ids: Optional[List[str]] = None, role_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ObjectStoreTrustPolicyGetResponse

List object store roles and their trust policies.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • roles (list[FixedReference], optional) – A list of roles to query for. Overrides role_ids and role_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

  • 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.

  • role_ids (list[str], optional) – A list of object store role IDs. If after filtering, there is not at least one resource that matches each of the elements of role_ids, then an error is returned. This cannot be provided together with the role_names query parameter.

  • role_names (list[str], optional) – A list of object store role names. If there is not at least one resource that matches each of the elements of role_names, then an error is returned. This cannot be provided together with the role_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_object_store_roles_object_store_trust_policies_download(references: Optional[List[ReferenceType]] = None, roles: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, role_ids: Optional[List[str]] = None, role_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ObjectStoreTrustPolicyIam

Download object store roles and their trust policies in native AWS format.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • roles (list[FixedReference], optional) – A list of roles to query for. Overrides role_ids and role_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • role_ids (list[str], optional) – A list of object store role IDs. If after filtering, there is not at least one resource that matches each of the elements of role_ids, then an error is returned. This cannot be provided together with the role_names query parameter.

  • role_names (list[str], optional) – A list of object store role names. If there is not at least one resource that matches each of the elements of role_names, then an error is returned. This cannot be provided together with the role_ids query parameter.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_object_store_roles_object_store_trust_policies_rules(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, roles: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, context_names: Optional[List[str]] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, indices: Optional[List[int]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, policy_names: Optional[List[str]] = None, role_ids: Optional[List[str]] = None, role_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ObjectStoreTrustPolicyRuleGetResponse

List trust policy rules and their attributes.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_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.

  • roles (list[FixedReference], optional) – A list of roles to query for. Overrides role_ids and role_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

  • 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.

  • indices (list[int], optional) – A list of resource indices. If there is not at least one resource that matches each of the elements of indices, then an error is returned.

  • 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.

  • role_ids (list[str], optional) – A list of object store role IDs. If after filtering, there is not at least one resource that matches each of the elements of role_ids, then an error is returned. This cannot be provided together with the role_names query parameter.

  • role_names (list[str], optional) – A list of object store role names. If there is not at least one resource that matches each of the elements of role_names, then an error is returned. This cannot be provided together with the role_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_object_store_users(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, context_names: Optional[List[str]] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ObjectStoreUserGetResponse

List object store users and their attributes.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_object_store_users_object_store_access_policies(contexts: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, context_names: Optional[List[str]] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, offset: Optional[int] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberContextGetResponse

List object store users and their access policies.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • member_ids (list[str], optional) – A list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (list[str], optional) – A list of member names.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • policy_ids (list[str], optional) – A list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (list[str], optional) – A list of policy names.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_object_store_virtual_hosts(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, context_names: Optional[List[str]] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ObjectStoreVirtualHostGetResponse

List object store virtual hosts.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

  • 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_password_policies(references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PasswordPoliciesGetResponse

Displays a list of password policies.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_policies(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, context_names: Optional[List[str]] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyGetResponse

Display snapshot scheduling policies and their attributes.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_policies_all(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, context_names: Optional[List[str]] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyBaseGetResponse

List all policies of all types.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_policies_all_members(contexts: Optional[List[ReferenceType]] = None, local_file_systems: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, remote_file_systems: Optional[List[ReferenceType]] = None, remotes: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, context_names: Optional[List[str]] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, local_file_system_ids: Optional[List[str]] = None, local_file_system_names: Optional[List[str]] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, member_types: Optional[List[str]] = None, offset: Optional[int] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, remote_file_system_ids: Optional[List[str]] = None, remote_file_system_names: Optional[List[str]] = None, remote_ids: Optional[List[str]] = None, remote_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberWithRemoteGetResponse

List policies (of all types) mapped to other entities (file systems, snapshots, file system replica links, and object store users). Note: if more than 150,000 items would be returned in the response, an error will be thrown and query parameters must be used to limit the items queried.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names 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.

  • 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.

  • 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.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • local_file_system_ids (list[str], optional) – A list of local file system IDs. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the local_file_system_names query parameter.

  • local_file_system_names (list[str], optional) – A list of local file system names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with local_file_system_ids query parameter.

  • member_ids (list[str], optional) – A list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (list[str], optional) – A list of member names.

  • member_types (list[str], optional) – A list of member types. Valid values are file-systems, file-system- snapshots, file-system-replica-links, and object-store-users. Different endpoints may accept different subsets of these values.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • policy_ids (list[str], optional) – A list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (list[str], optional) – A list of policy names.

  • remote_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, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_ids query parameter.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

List snapshot scheduling policies for file system replica links. Note: if more than 150,000 items would be returned in the response, an error will be thrown and query parameters must be used to limit the items queried.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names 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.

  • 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.

  • 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.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • local_file_system_ids (list[str], optional) – A list of local file system IDs. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the local_file_system_names query parameter.

  • local_file_system_names (list[str], optional) – A list of local file system names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with local_file_system_ids query parameter.

  • member_ids (list[str], optional) – A list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • policy_ids (list[str], optional) – A list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (list[str], optional) – A list of policy names.

  • remote_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, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_ids query parameter.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_policies_file_system_snapshots(contexts: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, context_names: Optional[List[str]] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, offset: Optional[int] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyFileSystemSnapshotGetResponse

List file system snapshots mapped to a snapshot scheduling policy. Note: if more than 150,000 items would be returned in the response, an error will be thrown and query parameters must be used to limit the items queried.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • member_ids (list[str], optional) – A list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (list[str], optional) – A list of member names.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • policy_ids (list[str], optional) – A list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (list[str], optional) – A list of policy names.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_policies_file_systems(contexts: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, context_names: Optional[List[str]] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, offset: Optional[int] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberContextGetResponse

List file systems mapped to a snapshot scheduling policy. Note: if more than 150,000 items would be returned in the response, an error will be thrown and query parameters must be used to limit the items queried.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • member_ids (list[str], optional) – A list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (list[str], optional) – A list of member names.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • policy_ids (list[str], optional) – A list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (list[str], optional) – A list of policy names.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_policies_members(contexts: Optional[List[ReferenceType]] = None, local_file_systems: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, remote_file_systems: Optional[List[ReferenceType]] = None, remotes: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, context_names: Optional[List[str]] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, local_file_system_ids: Optional[List[str]] = None, local_file_system_names: Optional[List[str]] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, member_types: Optional[List[str]] = None, offset: Optional[int] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, remote_file_system_ids: Optional[List[str]] = None, remote_file_system_names: Optional[List[str]] = None, remote_ids: Optional[List[str]] = None, remote_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberWithRemoteGetResponse

List snapshot scheduling policies mapped to file systems, snapshots, and file system replica links. Note: if more than 150,000 items would be returned in the response, an error will be thrown and query parameters must be used to limit the items queried.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names 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.

  • 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.

  • 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.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • local_file_system_ids (list[str], optional) – A list of local file system IDs. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the local_file_system_names query parameter.

  • local_file_system_names (list[str], optional) – A list of local file system names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with local_file_system_ids query parameter.

  • member_ids (list[str], optional) – A list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (list[str], optional) – A list of member names.

  • member_types (list[str], optional) – A list of member types. Valid values are file-systems, file-system- snapshots, file-system-replica-links, and object-store-users. Different endpoints may accept different subsets of these values.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • policy_ids (list[str], optional) – A list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (list[str], optional) – A list of policy names.

  • remote_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, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_ids query parameter.

  • 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_public_keys(references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PublicKeyGetResponse

List public key configurations.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • 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_public_keys_uses(references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PublicKeyUseGetResponse

List how public keys are being used and by what.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • 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_qos_policies(references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → QosPoliciesGetResponse

List QoS policies.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • 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_qos_policies_file_systems(members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, offset: Optional[int] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberGetResponse

List qos policies and their file system members.

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.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • member_ids (list[str], optional) – A list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (list[str], optional) – A list of member names.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • policy_ids (list[str], optional) – A list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (list[str], optional) – A list of policy names.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_qos_policies_members(members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, offset: Optional[int] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberGetResponse

List qos policies and their managed object members.

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.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • member_ids (list[str], optional) – A list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (list[str], optional) – A list of member names.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • policy_ids (list[str], optional) – A list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (list[str], optional) – A list of policy names.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_quotas_groups(contexts: Optional[List[ReferenceType]] = None, file_systems: Optional[List[ReferenceType]] = None, groups: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, context_names: Optional[List[str]] = None, continuation_token: Optional[str] = None, file_system_ids: Optional[List[str]] = None, file_system_names: Optional[List[str]] = None, filter: Optional[str] = None, gids: Optional[List[int]] = None, group_names: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → GroupQuotaGetResponse

List groups with hard limit quotas.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_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.

  • 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.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • file_system_ids (list[str], optional) – A list of file system IDs. If after filtering, there is not at least one resource that matches each of the elements of file_system_ids, then an error is returned. This cannot be provided together with the file_system_names query parameter.

  • file_system_names (list[str], optional) – A list of file system names. If there is not at least one resource that matches each of the elements of file_system_names, then an error is returned.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • gids (list[int], optional) – A list of group IDs. If there is not at least one resource that matches each of the elements of gids, then an error is returned. This cannot be provided together with group_names query parameter.

  • group_names (list[str], optional) – A list of group names. If there is not at least one resource that matches each of the elements of group_names, then an error is returned. This cannot be provided together with gids query parameter.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_quotas_settings(references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → QuotaSettingGetResponse

List notification attributes of a group or user quota.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_quotas_users(contexts: Optional[List[ReferenceType]] = None, file_systems: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, users: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, context_names: Optional[List[str]] = None, continuation_token: Optional[str] = None, file_system_ids: Optional[List[str]] = None, file_system_names: Optional[List[str]] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, uids: Optional[List[int]] = None, user_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → UserQuotaGetResponse

List users with hard limit file system quotas.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_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.

  • users (list[FixedReference], optional) – A list of users to query for. Overrides user_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • file_system_ids (list[str], optional) – A list of file system IDs. If after filtering, there is not at least one resource that matches each of the elements of file_system_ids, then an error is returned. This cannot be provided together with the file_system_names query parameter.

  • file_system_names (list[str], optional) – A list of file system names. If there is not at least one resource that matches each of the elements of file_system_names, then an error is returned.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • uids (list[int], optional) – A list of user IDs. If there is not at least one resource that matches each of the elements of uids, then an error is returned. This cannot be provided together with user_names query parameter.

  • user_names (list[str], optional) – A list of user names. If there is not at least one resource that matches each of the elements of user_names, then an error is returned. This cannot be provided together with uids query parameter.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_rapid_data_locking(x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → RapidDataLockingResponse

Displays the status of the Rapid Data Locking feature.

Parameters

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_rapid_data_locking_test(x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → TestResultResponse

Displays a detailed result of a Rapid Data Locking test.

Parameters

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

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_remote_arrays(references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, current_fleet_only: 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) → RemoteArraysResponse

Lists arrays in the current fleet, as well as arrays that the current array has existing replication connections to.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • current_fleet_only (bool, optional) – If current_fleet_only is specified, then results will only show arrays from the same fleet to which the current array is a member of.

  • 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) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_roles(references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → RoleGetResponse

List roles and permission attributes for role-based access control (RBAC).

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • 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_servers(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, context_names: Optional[List[str]] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ServerGetResponse

List servers.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

  • 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_sessions(references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SessionGetResponse

Displays session data for user login events performed in the Purity//FB GUI, CLI, and REST API.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • 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_smb_client_policies(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, context_names: Optional[List[str]] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SmbClientPolicyGetResponse

Display SMB Client policies and their attributes.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

  • 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_smb_client_policies_rules(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, context_names: Optional[List[str]] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SmbClientPolicyRuleGetResponse

Displays a list of SMB Client policy rules. The default sort is by policy name, then index.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • 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.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • policy_ids (list[str], optional) – A list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (list[str], optional) – A list of policy names.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_smb_share_policies(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, context_names: Optional[List[str]] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SmbSharePolicyGetResponse

Display SMB Share policies and their attributes.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

  • 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_smb_share_policies_rules(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, context_names: Optional[List[str]] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SmbSharePolicyRuleGetResponse

Displays a list of SMB Share policy rules.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • 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.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • policy_ids (list[str], optional) – A list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (list[str], optional) – A list of policy names.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_smtp_servers(references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SmtpServerGetResponse

List SMTP server attributes for the array network.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_snmp_agents(references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SnmpAgentGetResponse

List SNMP agent attributes.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_snmp_agents_mib(x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SnmpAgentMibResponse

List the SNMP MIB text.

Parameters

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_snmp_managers(references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SnmpManagerGetResponse

List SNMP managers and their attributes.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_snmp_managers_test(references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → TestResultGetResponse

Test if the configuration of an SNMP manager is valid.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • 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_software_check(references: Optional[List[ReferenceType]] = None, softwares: Optional[List[ReferenceType]] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, software_names: Optional[List[str]] = None, software_versions: Optional[List[str]] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SoftwareChecksGetResponse

Displays a list of software check tasks.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • softwares (list[FixedReference], optional) – A list of softwares to query for. Overrides software_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.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • software_names (list[str], optional) – A list of software names.

  • software_versions (list[str], optional) – A list of target software versions.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

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_ssh_certificate_authority_policies(references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SshCertificateAuthorityPolicyGetResponse

List SSH Certificate Authority configurations

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • 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_ssh_certificate_authority_policies_admins(members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, offset: Optional[int] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberGetResponse

List SSH Certificate Authority policies mapped to specific users.

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.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • member_ids (list[str], optional) – A list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (list[str], optional) – A list of member names.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • policy_ids (list[str], optional) – A list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (list[str], optional) – A list of policy names.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_ssh_certificate_authority_policies_arrays(members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, offset: Optional[int] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberGetResponse

List SSH Certificate Authority policies mapped as defaults for admins.

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.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • member_ids (list[str], optional) – A list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (list[str], optional) – A list of member names.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • policy_ids (list[str], optional) – A list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (list[str], optional) – A list of policy names.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_ssh_certificate_authority_policies_members(members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, offset: Optional[int] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberGetResponse

List SSH Certificate Authority policies mapped to the admin default settings, or to one or more specific users.

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.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • member_ids (list[str], optional) – A list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (list[str], optional) – A list of member names.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • policy_ids (list[str], optional) – A list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (list[str], optional) – A list of policy names.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_sso_oidc_idps(references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → OidcSsoGetResponse

Displays the OIDC SSO configuration settings in the array.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • 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_sso_saml2_idps(references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → Saml2SsoGetResponse

Displays the SAML2 SSO service provider and identity provider configuration settings in the array.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • 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_sso_saml2_idps_test(references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, 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 the existing SAML2 SSO configurations in the array.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • 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_subnets(references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SubnetGetResponse

List the array’s subnets.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_support(references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SupportGetResponse

List Phone Home and Remote Assistance settings.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_support_diagnostics(references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SupportDiagnosticsGetResponse

Lists the support diagnostics tasks.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_support_diagnostics_details(references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SupportDiagnosticsDetailsGetResponse

Lists the diagnostics tasks details.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_support_test(x_request_id: Optional[str] = None, filter: Optional[str] = None, sort: Optional[List[str]] = None, test_type: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → TestResultGetResponse

Test if the Phone Home and Remote Assistance settings are functioning properly.

Parameters

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • test_type (str, optional) – Specifies the type of test. Valid values are all, phonehome, and remote- assist. If not specified, defaults to all.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_support_verification_keys(x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → VerificationKeyGetResponse

List the key used to verify the signed challenges that are used by Pure Support to access the FlashBlade.

Parameters

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_syslog_servers(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, context_names: Optional[List[str]] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SyslogServerGetResponse

Return a list of configured syslog servers.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_syslog_servers_settings(references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SyslogServerSettingsGetResponse

List the certificate or certificate group associated with the syslog servers.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_syslog_servers_test(x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → TestResultGetResponse

Send test messages to conifgured remote syslog servers.

Parameters

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_targets(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, context_names: Optional[List[str]] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → TargetGetResponse

List targets used for replication.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_targets_performance_replication(references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, end_time: Optional[int] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, resolution: Optional[int] = None, sort: Optional[List[str]] = None, start_time: Optional[int] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ResourcePerformanceReplicationGetResponse

List replication performance metrics for targets.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • end_time (int, optional) – When the time window ends (in milliseconds since epoch).

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • resolution (int, optional) – The desired ms between samples. Available resolutions may depend on data type, start_time and end_time. In general 1000, 30000, 300000, 1800000, 7200000, and 86400000 are possible values.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • start_time (int, optional) – When the time window starts (in milliseconds since epoch).

  • total_only (bool, optional) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

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_tls_policies(references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, effective: 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, purity_defined: 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) → TlsPolicyGetResponse

List TLS policies

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • effective (bool, optional) – If true, then the TLS policies returned will be fully evaluated. This involves expanding shortened TLS ciphers, removing disabled TLS ciphers from the list of expanded enabled TLS ciphers, and converting values such as default and legacy into concrete values, in order to return the discrete effective TLS settings that the policies encode. Defaults to false.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • purity_defined (bool, optional) – If true, then the results returned will be include the specification for purity-defined values on the current purity version. These values may be used in configurations in order to dynamically adopt new behavior across upgrades, and this option allows the exact behavior for the current version to be returned. 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_tls_policies_members(members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, offset: Optional[int] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberGetResponse

List TLS policies mapped to the array as a whole, or to one or more specific objects on the array (such as network interfaces).

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.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • member_ids (list[str], optional) – A list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (list[str], optional) – A list of member names.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • policy_ids (list[str], optional) – A list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (list[str], optional) – A list of policy names.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_tls_policies_network_interfaces(members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, offset: Optional[int] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberGetResponse

List network interface TLS policies.

Parameters

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • member_ids (list[str], optional) – A list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (list[str], optional) – A list of member names.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • policy_ids (list[str], optional) – A list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (list[str], optional) – A list of policy names.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_usage_groups(contexts: Optional[List[ReferenceType]] = None, file_systems: Optional[List[ReferenceType]] = None, groups: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, context_names: Optional[List[str]] = None, continuation_token: Optional[str] = None, file_system_ids: Optional[List[str]] = None, file_system_names: Optional[List[str]] = None, filter: Optional[str] = None, gids: Optional[List[int]] = None, group_names: Optional[List[str]] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → GroupQuotaGetResponse

List groups with hard limit quotas and their file system usage.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_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.

  • groups (list[FixedReference], optional) – A list of groups to query for. Overrides group_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • file_system_ids (list[str], optional) – A list of file system IDs. If after filtering, there is not at least one resource that matches each of the elements of file_system_ids, then an error is returned. This cannot be provided together with the file_system_names query parameter.

  • file_system_names (list[str], optional) – A list of file system names. If there is not at least one resource that matches each of the elements of file_system_names, then an error is returned.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • gids (list[int], optional) – A list of group IDs. If there is not at least one resource that matches each of the elements of gids, then an error is returned. This cannot be provided together with group_names query parameter.

  • group_names (list[str], optional) – A list of group names. If there is not at least one resource that matches each of the elements of group_names, then an error is returned. This cannot be provided together with gids query parameter.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_usage_users(contexts: Optional[List[ReferenceType]] = None, file_systems: Optional[List[ReferenceType]] = None, users: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, context_names: Optional[List[str]] = None, continuation_token: Optional[str] = None, file_system_ids: Optional[List[str]] = None, file_system_names: Optional[List[str]] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, uids: Optional[List[int]] = None, user_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → UserQuotaGetResponse

List users with hard limit quotas and their file system usage.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_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.

  • users (list[FixedReference], optional) – A list of users to query for. Overrides user_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • file_system_ids (list[str], optional) – A list of file system IDs. If after filtering, there is not at least one resource that matches each of the elements of file_system_ids, then an error is returned. This cannot be provided together with the file_system_names query parameter.

  • file_system_names (list[str], optional) – A list of file system names. If there is not at least one resource that matches each of the elements of file_system_names, then an error is returned.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • uids (list[int], optional) – A list of user IDs. If there is not at least one resource that matches each of the elements of uids, then an error is returned. This cannot be provided together with user_names query parameter.

  • user_names (list[str], optional) – A list of user names. If there is not at least one resource that matches each of the elements of user_names, then an error is returned. This cannot be provided together with uids query parameter.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_versions(async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → dict

Get available API versions. No authentication is required to access this endpoint. The response will be a ValidResponse with version ids listed as items.

Parameters

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_worm_data_policies(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, context_names: Optional[List[str]] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → WormDataPoliciesGetResponse

List WORM data policies.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

  • 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_worm_data_policies_members(contexts: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, allow_errors: Optional[bool] = None, context_names: Optional[List[str]] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, offset: Optional[int] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → WormDataPoliciesMembersGetResponse

List members mapped to a WORM data policy.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_errors (bool, optional) – If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • member_ids (list[str], optional) – A list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (list[str], optional) – A list of member names.

  • offset (int, optional) – The offset of the first resource to return from a collection.

  • policy_ids (list[str], optional) – A list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (list[str], optional) – A list of policy names.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

logout(async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Invalidate a REST session token.

Parameters

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_active_directory(references: Optional[List[ReferenceType]] = None, active_directory: Optional[ActiveDirectoryPatch] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ActiveDirectoryResponse

Modify the configuration of an Active Directory account.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • active_directory (ActiveDirectoryPatch, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_admins(references: Optional[List[ReferenceType]] = None, admin: Optional[AdminPatch] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → AdminResponse

Modify the attributes of an administrator.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • admin (AdminPatch, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_admins_settings(admin_setting: Optional[AdminSetting] = None, x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → AdminSettingsResponse

Update properties for global admin settings.

Parameters

  • admin_setting (AdminSetting, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_alert_watchers(references: Optional[List[ReferenceType]] = None, alert_watcher: Optional[AlertWatcher] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → AlertWatcherResponse

Modify an alert watcher’s configuration. Enable or disable an alert watcher privilege and select the level of alert notification of an alert watcher. Alert notification levels are info, warning, or critical.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • alert_watcher (AlertWatcher, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_alerts(references: Optional[List[ReferenceType]] = None, alerts_settings: Optional[Alert] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → AlertResponse

Make changes to an alert. This is currently limited to the alert’s flagged property.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • alerts_settings (Alert, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_api_clients(references: Optional[List[ReferenceType]] = None, api_clients: Optional[ApiClient] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ApiClientsResponse

Modify an API client. Newly created API clients can be enabled by setting the enabled parameter to true.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • api_clients (ApiClient, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_array_connections(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, remotes: Optional[List[ReferenceType]] = None, array_connection: Optional[ArrayConnection] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, ids: Optional[List[str]] = None, remote_ids: Optional[List[str]] = None, remote_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ArrayConnectionResponse

Modify the configuration of a connected array.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids keyword arguments.

  • remotes (list[FixedReference], optional) – A list of remotes to query for. Overrides remote_ids and remote_names keyword arguments.

  • array_connection (ArrayConnection, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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. Deprecated, best practice is to reference connections with 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. Deprecated, best practice is to reference connections with 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 remote_ids query parameter.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_arrays(array: Optional[Array] = None, x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ArrayResponse

Modify the general configuration of the array including banner text, array name, NTP servers, and time zone.

Parameters

  • array (Array, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_arrays_eula(eula: Optional[Eula] = None, x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → EulaResponse

Modifies the signature on the End User Agreement.

Parameters

  • eula (Eula, optional) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_audit_file_systems_policies(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, policy: Optional[AuditFileSystemsPoliciesPatch] = None, x_request_id: Optional[str] = None, context_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) → AuditFileSystemsPoliciesResponse

Modify an existing audit policy’s attributes.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • policy (AuditFileSystemsPoliciesPatch, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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.

Modify the configuration of a bucket replica link including whether the link is paused and the object store remote credentials used.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids keyword arguments.

  • local_buckets (list[FixedReference], optional) – A list of local_buckets to query for. Overrides local_bucket_ids and local_bucket_names keyword arguments.

  • remote_buckets (list[FixedReference], optional) – A list of remote_buckets to query for. Overrides remote_bucket_names keyword arguments.

  • remotes (list[FixedReference], optional) – A list of remotes to query for. Overrides remote_ids and remote_names keyword arguments.

  • bucket_replica_link (BucketReplicaLink, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_ids query parameter.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_buckets(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, bucket: Optional[BucketPatch] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, ids: Optional[List[str]] = None, ignore_usage: Optional[bool] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → BucketResponse

Modify object store bucket attributes such as destroyed and versioning.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • bucket (BucketPatch, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • ignore_usage (bool, optional) – Allow update operations that lead to a hard_limit_enabled object store account, bucket, or file system with usage over its limiting value. For object store accounts and buckets, the limiting value is that of quota_limit, and for file systems it is that of provisioned. The operation can be setting hard_limit_enabled when usage is higher than the limiting value, modifying the limiting value to a value under usage when hard_limit_enabled, recovering a destroyed bucket of an object store account that causes an account’s space usage to go over its hard quota_limit. Also allows update operations that would cause usage of the requested storage class to go over its warning threshold.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_certificates(references: Optional[List[ReferenceType]] = None, certificate: Optional[CertificatePatch] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → CertificateResponse

Modify SSL certificate attributes such as passphrases and intermediate certificates.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • certificate (CertificatePatch, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_directory_services(references: Optional[List[ReferenceType]] = None, directory_service: Optional[DirectoryService] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → DirectoryServiceResponse

Modifies and tests the directory service configuration.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • directory_service (DirectoryService, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_directory_services_roles(references: Optional[List[ReferenceType]] = None, roles: Optional[List[ReferenceType]] = None, directory_service_roles: Optional[DirectoryServiceRole] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, role_ids: Optional[List[str]] = None, role_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → DirectoryServiceRolesResponse

Update an RBAC group configuration setting for manageability.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • roles (list[FixedReference], optional) – A list of roles to query for. Overrides role_ids and role_names keyword arguments.

  • directory_service_roles (DirectoryServiceRole, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the names, role_names, or role_ids query parameters.

  • names (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of names, then an error is returned. This cannot be provided together with the ids, role_names, or role_ids query parameters.

  • role_ids (list[str], optional) – A list of role_ids. If after filtering, there is not at least one resource that matches each of the elements of role_ids, then an error is returned. This cannot be provided together with the ids, names or role_names query parameters. This query parameter is deprecated for use with directory service roles. If this parameter is used to query or modify directory service roles, but more than 1 configuration exists with a given role id, an error will be returned in order to avoid ambiguous operation.

  • role_names (list[str], optional) – A list of role_names. If there is not at least one resource that matches each of the elements of role_names, then an error is returned. This cannot be provided together with the ids, names, or role_ids query parameters. This query parameter is deprecated for use with directory service roles. If this parameter is used to query or modify directory service roles, but more than 1 configuration exists with a given role name, an error will be returned in order to avoid ambiguous operation.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_directory_services_test(references: Optional[List[ReferenceType]] = None, directory_service: Optional[DirectoryService] = None, x_request_id: Optional[str] = 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 the configured directory services on the array. Optionally, provide modifications which will be used to perform the tests, but will not be applied to the current configuration.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • directory_service (DirectoryService, optional) – An optional directory service configuration that, if provided, will be used to overwrite aspects of the existing directory service objects when performing tests.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • 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.

patch_dns(references: Optional[List[ReferenceType]] = None, dns: Optional[Dns] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → DnsResponse

Modify a DNS configuration.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • dns (Dns, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_file_system_exports(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, file_system_export: Optional[FileSystemExport] = None, x_request_id: Optional[str] = None, context_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) → FileSystemExportResponse

Modify a file system export’s attributes.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • file_system_export (FileSystemExport, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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.

Update a file system replication link.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • 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.

  • remotes (list[FixedReference], optional) – A list of remotes to query for. Overrides remote_ids and remote_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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_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, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_ids query parameter.

  • replicate_now (bool, optional) – If set to true, replicates the contents to the specified targets. The replicate_now parameters can only be true with the partial-replica file system links.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_file_system_snapshots(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, file_system_snapshot: Optional[FileSystemSnapshot] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, ids: Optional[List[str]] = None, latest_replica: Optional[bool] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → FileSystemSnapshotResponse

Modify file system snapshot attributes.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • file_system_snapshot (FileSystemSnapshot, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • latest_replica (bool, optional) – Used when destroying a snapshot. If not present or false, and the snapshot is the latest replicated snapshot, then destroy will fail. If true or the snapshot is not the latest replicated snapshot, then destroy will be successful.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_file_systems(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, file_system: Optional[FileSystemPatch] = None, x_request_id: Optional[str] = None, cancel_in_progress_storage_class_transition: Optional[bool] = None, context_names: Optional[List[str]] = None, delete_link_on_eradication: Optional[bool] = None, discard_detailed_permissions: Optional[bool] = None, discard_non_snapshotted_data: Optional[bool] = None, ids: Optional[List[str]] = None, ignore_usage: Optional[bool] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → FileSystemResponse

Modify a file system’s attributes including its export protocols and limits.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • file_system (FileSystemPatch, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • cancel_in_progress_storage_class_transition (bool, optional) – If set to true, the storage class policy of this file system will be set to the requested storage class policy, even if a transition to a different storage class is in-progress. Setting this parameter to true is acknowledgement that any in-progress transition on this file system will be cancelled. If not specified, the default value is false.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • delete_link_on_eradication (bool, optional) – If set to true, the file system can be destroyed, even if it has a replica link. If set to false, the file system cannot be destroyed if it has a replica link. Defaults to false.

  • discard_detailed_permissions (bool, optional) – This parameter must be set to true in order to change a file system’s access_control_style from a style that supports more detailed access control lists to a style that only supports less detailed mode bits as a form of permission control. This parameter may not be set to true any other time. Setting this parameter to true is acknowledgement that any more detailed access control lists currently set within the file system will be lost, and NFS permission controls will only be enforced at the granularity level of NFS mode bits.

  • discard_non_snapshotted_data (bool, optional) – This parameter must be set to true in order to restore a file system from a snapshot or to demote a file system (which restores the file system from the common baseline snapshot). Setting this parameter to true is acknowledgement that any non-snapshotted data currently in the file system will be irretrievably lost.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • ignore_usage (bool, optional) – Allow update operations that lead to a hard_limit_enabled object store account, bucket, or file system with usage over its limiting value. For object store accounts and buckets, the limiting value is that of quota_limit, and for file systems it is that of provisioned. The operation can be setting hard_limit_enabled when usage is higher than the limiting value, modifying the limiting value to a value under usage when hard_limit_enabled, recovering a destroyed bucket of an object store account that causes an account’s space usage to go over its hard quota_limit. Also allows update operations that would cause usage of the requested storage class to go over its warning threshold.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_fleets(references: Optional[List[ReferenceType]] = None, fleet: Optional[FleetPatch] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → FleetResponse

Rename a fleet by passing the old name in name query parameter, and the new name in the name parameter in the request body.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • fleet (FleetPatch, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – Performs the operation on the unique resource IDs specified. Only one value is supported.

  • names (list[str], optional) – Performs the operation on the unique resource names specified. Only one value is supported.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_hardware(references: Optional[List[ReferenceType]] = None, hardware: Optional[Hardware] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → HardwareResponse

Controls the visual identification light of the specified hardware component.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • hardware (Hardware, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_hardware_connectors(references: Optional[List[ReferenceType]] = None, hardware_connector: Optional[HardwareConnector] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → HardwareConnectorResponse

The endpoint is deprecated. Use the /network-interfaces/connectors endpoint instead. Modify array connection information.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • hardware_connector (HardwareConnector, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_kmip(references: Optional[List[ReferenceType]] = None, kmip_server: Optional[KmipServer] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → KmipServerResponse

Modifies KMIP server properties - URI, certificate, certificate group.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • kmip_server (KmipServer, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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.

Update a legal hold instance.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • hold (LegalHold, optional) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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.

Release this legal hold from the given entity. The names, file_system_names, paths and released query parameters are required. The recursive flag is required when releasing a hold from a directory.

Parameters

  • file_systems (list[FixedReference], optional) – A list of file_systems to query for. Overrides file_system_ids and file_system_names keyword arguments.

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • released (bool, required) – This is a flag to set when releasing an attached legal hold from a path.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • 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.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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.

  • 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) – This is a flag to set when recursively applying/releasing legal holds on entities. By default, it is set to be false. The recursive flag is required when applying/releasing a hold to/from a directory.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_lifecycle_rules(buckets: Optional[List[ReferenceType]] = None, contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, lifecycle: Optional[LifecycleRulePatch] = None, x_request_id: Optional[str] = None, bucket_ids: Optional[List[str]] = None, bucket_names: Optional[List[str]] = None, confirm_date: Optional[bool] = None, context_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) → LifecycleRuleResponse

Modify an existing lifecycle rule by name or id. If ids is specified, bucket_names or bucket_ids is also required.

Parameters

  • buckets (list[FixedReference], optional) – A list of buckets to query for. Overrides bucket_ids and bucket_names keyword arguments.

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • lifecycle (LifecycleRulePatch, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • 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.

  • confirm_date (bool, optional) – If set to true, then confirm the date of keep_current_version_until is correct.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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.

Modify link aggregation groups by adding and removing Ethernet ports.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • link_aggregation_group (Linkaggregationgroup, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_logs_async(logs_async: Optional[LogsAsync] = None, x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → LogsAsyncResponse

Start the preparation for a history of log events from the array to provide to Pure Technical Services for analysis.

Parameters

  • logs_async (LogsAsync, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_network_access_policies(references: Optional[List[ReferenceType]] = None, policy: Optional[NetworkAccessPolicy] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, versions: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → NetworkAccessPolicyResponse

Modify an existing network access policy’s attributes.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • policy (NetworkAccessPolicy, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • versions (list[str], optional) – A list of versions. This is an optional query param used for concurrency control. The ordering should match the names or ids query param. This will fail with a 412 Precondition failed if the resource was changed and the current version of the resource doesn’t match the value in the query param.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_network_access_policies_rules(references: Optional[List[ReferenceType]] = None, rule: Optional[NetworkAccessPolicyRule] = None, x_request_id: Optional[str] = None, before_rule_id: Optional[str] = None, before_rule_name: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, versions: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → NetworkAccessPolicyRuleResponse

Modify an existing network access policy rule.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • rule (NetworkAccessPolicyRule, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • before_rule_id (str, optional) – The id of the rule to insert or move a rule before. This cannot be provided together with the before_rule_name query parameter.

  • before_rule_name (str, optional) – The name of the rule to insert or move a rule before. This cannot be provided together with the before_rule_id query parameter.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • versions (list[str], optional) – A list of versions. This is an optional query param used for concurrency control. The ordering should match the names or ids query param. This will fail with a 412 Precondition failed if the resource was changed and the current version of the resource doesn’t match the value in the query param.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_network_interfaces(references: Optional[List[ReferenceType]] = None, network_interface: Optional[NetworkInterfacePatch] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → NetworkInterfaceResponse

Modify the attributes of a VIP.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • network_interface (NetworkInterfacePatch, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_network_interfaces_connectors(references: Optional[List[ReferenceType]] = None, network_connector: Optional[HardwareConnector] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → NetworkInterfacesConnectorsResponse

Modify network connector information.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • network_connector (HardwareConnector, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_nfs_export_policies(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, policy: Optional[NfsExportPolicy] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, versions: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → NfsExportPolicyResponse

Modify an existing NFS export policy’s attributes.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • policy (NfsExportPolicy, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • versions (list[str], optional) – A list of versions. This is an optional query param used for concurrency control. The ordering should match the names or ids query param. This will fail with a 412 Precondition failed if the resource was changed and the current version of the resource doesn’t match the value in the query param.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_nfs_export_policies_rules(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, rule: Optional[NfsExportPolicyRule] = None, x_request_id: Optional[str] = None, before_rule_id: Optional[str] = None, before_rule_name: Optional[str] = None, context_names: Optional[List[str]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, versions: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → NfsExportPolicyRuleResponse

Modify an existing NFS export policy rule. If before_rule_id or before_rule_name are specified, the rule will be moved before that rule. Rules are ordered in three groups; ip addresses, other and * and can only be moved within the appropriate group. One of the following is required: ids or names.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • rule (NfsExportPolicyRule, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • before_rule_id (str, optional) – The id of the rule to insert or move a rule before. This cannot be provided together with the before_rule_name query parameter.

  • before_rule_name (str, optional) – The name of the rule to insert or move a rule before. This cannot be provided together with the before_rule_id query parameter.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • versions (list[str], optional) – A list of versions. This is an optional query param used for concurrency control. The ordering should match the names or ids query param. This will fail with a 412 Precondition failed if the resource was changed and the current version of the resource doesn’t match the value in the query param.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_object_store_access_keys(references: Optional[List[ReferenceType]] = None, contexts: Optional[List[ReferenceType]] = None, object_store_access_key: Optional[ObjectStoreAccessKey] = None, names: Optional[List[str]] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ObjectStoreAccessKeyResponse

Enable or disable object store access keys.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • object_store_access_key (ObjectStoreAccessKey, required) –

  • names (list[str], required) – A list of resource names.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_object_store_access_policies(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, policy: Optional[ObjectStoreAccessPolicyPatch] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, enforce_action_restrictions: Optional[bool] = 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) → ObjectStoreAccessPolicyResponse

Modify the rules of an object store access policy.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • policy (ObjectStoreAccessPolicyPatch, optional) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • enforce_action_restrictions (bool, optional) – Certain combinations of actions and other rule elements are inherently ignored if specified together in a rule. If set to true, operations which attempt to set these combinations will fail. If set to false, such operations will instead be allowed. Defaults to true.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_object_store_access_policies_rules(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, rule: Optional[PolicyRuleObjectAccessPost] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, enforce_action_restrictions: Optional[bool] = None, names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ObjectStoreAccessPolicyRuleResponse

Modify an access policy rule’s attributes.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_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_ids and policy_names keyword arguments.

  • rule (PolicyRuleObjectAccessPost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • enforce_action_restrictions (bool, optional) – Certain combinations of actions and other rule elements are inherently ignored if specified together in a rule. If set to true, operations which attempt to set these combinations will fail. If set to false, such operations will instead be allowed. Defaults to true.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • policy_ids (list[str], optional) – A list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (list[str], optional) – A list of policy names.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_object_store_accounts(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, object_store_account: Optional[ObjectStoreAccountPatch] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, ids: Optional[List[str]] = None, ignore_usage: Optional[bool] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ObjectStoreAccountResponse

Modify object store account attributes such as quota limit and bucket defaults.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • object_store_account (ObjectStoreAccountPatch, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • ignore_usage (bool, optional) – Allow update operations that lead to a hard_limit_enabled object store account, bucket, or file system with usage over its limiting value. For object store accounts and buckets, the limiting value is that of quota_limit, and for file systems it is that of provisioned. The operation can be setting hard_limit_enabled when usage is higher than the limiting value, modifying the limiting value to a value under usage when hard_limit_enabled, recovering a destroyed bucket of an object store account that causes an account’s space usage to go over its hard quota_limit. Also allows update operations that would cause usage of the requested storage class to go over its warning threshold.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_object_store_remote_credentials(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, remote_credentials: Optional[ObjectStoreRemoteCredentials] = None, x_request_id: Optional[str] = None, context_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) → ObjectStoreRemoteCredentialsResp

Rename and/or change the access key/secret key pair for object store remote credentials.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • remote_credentials (ObjectStoreRemoteCredentials, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_object_store_roles(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, object_store_role: Optional[ObjectStoreRole] = None, x_request_id: Optional[str] = None, context_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) → ObjectStoreRoleResponse

Modify existing object store roles.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • object_store_role (ObjectStoreRole, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_object_store_roles_object_store_trust_policies_rules(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, roles: Optional[List[ReferenceType]] = None, rule: Optional[TrustPolicyRulePost] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, indices: Optional[List[int]] = None, names: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, role_ids: Optional[List[str]] = None, role_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ObjectStoreTrustPolicyRuleResponse

Modify a trust policy rule’s attributes.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_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.

  • roles (list[FixedReference], optional) – A list of roles to query for. Overrides role_ids and role_names keyword arguments.

  • rule (TrustPolicyRulePost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • indices (list[int], optional) – A list of resource indices. If there is not at least one resource that matches each of the elements of indices, then an error is returned.

  • names (list[str], optional) – A list 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.

  • role_ids (list[str], optional) – A list of object store role IDs. If after filtering, there is not at least one resource that matches each of the elements of role_ids, then an error is returned. This cannot be provided together with the role_names query parameter.

  • role_names (list[str], optional) – A list of object store role names. If there is not at least one resource that matches each of the elements of role_names, then an error is returned. This cannot be provided together with the role_ids query parameter.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_object_store_roles_object_store_trust_policies_upload(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, roles: Optional[List[ReferenceType]] = None, policy_document: Optional[ObjectStoreTrustPolicyIam] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, names: Optional[List[str]] = None, role_ids: Optional[List[str]] = None, role_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ObjectStoreTrustPolicyResponse

Upload object store roles and their trust policies in native AWS format.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • roles (list[FixedReference], optional) – A list of roles to query for. Overrides role_ids and role_names keyword arguments.

  • policy_document (ObjectStoreTrustPolicyIam, required) – The trust policy document to upload.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma- separated format. For example, name01,name02.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • role_ids (list[str], optional) – A list of object store role IDs. If after filtering, there is not at least one resource that matches each of the elements of role_ids, then an error is returned. This cannot be provided together with the role_names query parameter.

  • role_names (list[str], optional) – A list of object store role names. If there is not at least one resource that matches each of the elements of role_names, then an error is returned. This cannot be provided together with the role_ids query parameter.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_password_policies(references: Optional[List[ReferenceType]] = None, policy: Optional[PasswordPolicy] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PasswordPoliciesResponse

Modifies one or more password policies. To enable a policy, set enabled=true. To disable a policy, set enabled=false.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • policy (PasswordPolicy, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_policies(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, policy: Optional[PolicyPatch] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, destroy_snapshots: Optional[bool] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyResponse

Modify a snapshot scheduling policy’s attributes for when and how often snapshots are created and how long they are retained.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • policy (PolicyPatch, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • destroy_snapshots (bool, optional) – This parameter must be set to true in order to modify a policy such that local or remote snapshots would be destroyed.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_qos_policies(references: Optional[List[ReferenceType]] = None, policy: Optional[QosPolicy] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → QosPoliciesResponse

Modify a QoS policy.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • policy (QosPolicy, optional) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_quotas_groups(contexts: Optional[List[ReferenceType]] = None, file_systems: Optional[List[ReferenceType]] = None, groups: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, quota: Optional[GroupQuotaPatch] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, file_system_ids: Optional[List[str]] = None, file_system_names: Optional[List[str]] = None, gids: Optional[List[int]] = None, group_names: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → GroupQuotaResponse

Modify a quota for a group. Note that if you modify a group’s quota to a lower value and that group’s usage has already exceeded the new value, writes will automatically halt until usage decreases below the new quota setting.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_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.

  • 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.

  • quota (GroupQuotaPatch, optional) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • file_system_ids (list[str], optional) – A list of file system IDs. If after filtering, there is not at least one resource that matches each of the elements of file_system_ids, then an error is returned. This cannot be provided together with the file_system_names query parameter.

  • file_system_names (list[str], optional) – A list of file system names. If there is not at least one resource that matches each of the elements of file_system_names, then an error is returned.

  • gids (list[int], optional) – A list of group IDs. If there is not at least one resource that matches each of the elements of gids, then an error is returned. This cannot be provided together with group_names query parameter.

  • group_names (list[str], optional) – A list of group names. If there is not at least one resource that matches each of the elements of group_names, then an error is returned. This cannot be provided together with gids query parameter.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_quotas_settings(quota_setting: Optional[QuotaSetting] = None, x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → QuotaSettingResponse

Modify the notification attributes of a group or user quota.

Parameters

  • quota_setting (QuotaSetting, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_quotas_users(contexts: Optional[List[ReferenceType]] = None, file_systems: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, users: Optional[List[ReferenceType]] = None, quota: Optional[UserQuotaPatch] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, file_system_ids: Optional[List[str]] = None, file_system_names: 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) → UserQuotaResponse

Modify the attributes of a hard limit file system quota. Note that if you modify a user’s quota to a lower value and that user’s usage has already exceeded the new value, writes will automatically halt until usage decreases below the new quota setting.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_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.

  • users (list[FixedReference], optional) – A list of users to query for. Overrides user_names keyword arguments.

  • quota (UserQuotaPatch, optional) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • 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.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • uids (list[int], optional) – A list of user IDs. If there is not at least one resource that matches each of the elements of uids, then an error is returned. This cannot be provided together with user_names query parameter.

  • user_names (list[str], optional) – A list of user names. If there is not at least one resource that matches each of the elements of user_names, then an error is returned. This cannot be provided together with uids query parameter.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_rapid_data_locking(rapid_data_locking: Optional[RapidDataLocking] = None, x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → RapidDataLockingResponse

Modifies the Rapid Data Locking feature. Note that the feature can only be enabled if there are no file systems nor buckets created on the array. Once enabled, the feature cannot be modified.

Parameters

  • rapid_data_locking (RapidDataLocking, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_servers(references: Optional[List[ReferenceType]] = None, server: Optional[ServerPost] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ServerResponse

Modify the server attributes.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • server (ServerPost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_smb_client_policies(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, policy: Optional[SmbClientPolicy] = None, x_request_id: Optional[str] = None, context_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) → SmbClientPolicyResponse

Modify an existing SMB Client policy’s attributes.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • policy (SmbClientPolicy, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_smb_client_policies_rules(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, rule: Optional[SmbClientPolicyRule] = None, x_request_id: Optional[str] = None, before_rule_id: Optional[str] = None, before_rule_name: Optional[str] = None, context_names: Optional[List[str]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, versions: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SmbClientPolicyRuleResponse

Modify an existing SMB Client policy rule. If before_rule_id or before_rule_name are specified, the rule will be moved before that rule. Rules are ordered in three groups; ip addresses, other and * and can only be moved within the appropriate group. One of the following is required: ids or names.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • rule (SmbClientPolicyRule, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • before_rule_id (str, optional) – The id of the rule to insert or move a rule before. This cannot be provided together with the before_rule_name query parameter.

  • before_rule_name (str, optional) – The name of the rule to insert or move a rule before. This cannot be provided together with the before_rule_id query parameter.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • versions (list[str], optional) – A list of versions. This is an optional query param used for concurrency control. The ordering should match the names or ids query param. This will fail with a 412 Precondition failed if the resource was changed and the current version of the resource doesn’t match the value in the query param.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_smb_share_policies(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, policy: Optional[SmbSharePolicy] = None, x_request_id: Optional[str] = None, context_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) → SmbSharePolicyResponse

Modify an existing SMB Share policy’s attributes.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • policy (SmbSharePolicy, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_smb_share_policies_rules(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, rule: Optional[SmbSharePolicyRule] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = 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) → SmbSharePolicyRuleResponse

Modify an existing SMB Share policy rule. One of the following is required: ids or names. If names is provided, the policy_ids or policy_names parameter is also required.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • 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.

  • rule (SmbSharePolicyRule, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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.

patch_smtp_servers(smtp: Optional[SmtpServer] = None, x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SmtpServerResponse

Modify SMTP server attributes such as the relay host and sender domain.

Parameters

  • smtp (SmtpServer, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_snmp_agents(snmp_agent: Optional[SnmpAgent] = None, x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SnmpAgentResponse

Modify SNMP agent attributes.

Parameters

  • snmp_agent (SnmpAgent, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_snmp_managers(references: Optional[List[ReferenceType]] = None, snmp_manager: Optional[SnmpManager] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SnmpManagerResponse

Modify SNMP manager attributes such as versions.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • snmp_manager (SnmpManager, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_ssh_certificate_authority_policies(references: Optional[List[ReferenceType]] = None, policy: Optional[SshCertificateAuthorityPolicy] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SshCertificateAuthorityPolicyResponse

Modifies one or more attributes of SSH Certificate Authority configurations.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • policy (SshCertificateAuthorityPolicy, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_sso_oidc_idps(references: Optional[List[ReferenceType]] = None, idp: Optional[OidcSsoPatch] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → OidcSsoResponse

Modify one or more attributes of OIDC SSO configuration.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • idp (OidcSsoPatch, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_sso_saml2_idps(references: Optional[List[ReferenceType]] = None, idp: Optional[Saml2Sso] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → Saml2SsoResponse

Modifies one or more attributes of SAML2 SSO configurations.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • idp (Saml2Sso, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_sso_saml2_idps_test(references: Optional[List[ReferenceType]] = None, idp: Optional[Saml2Sso] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → TestResultResponse

Modifies and test the provided SAML2 SSO configurations. If the configurations with the specified ids or names exist, the provided configurations will overwrite the existing configurations, but will not be persisted in the array.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • idp (Saml2Sso, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_subnets(references: Optional[List[ReferenceType]] = None, subnet: Optional[Subnet] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SubnetResponse

Modify array subnet attributes.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • subnet (Subnet, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_support(support: Optional[Support] = None, x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SupportResponse

Modify Phone Home and Remote Assistance settings.

Parameters

  • support (Support, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_support_verification_keys(key: Optional[VerificationKeyPatch] = None, x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → VerificationKeyResponse

Update the key used to verify the signed challenges that are used by Pure Support to access the FlashBlade.

Parameters

  • key (VerificationKeyPatch, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_syslog_servers(references: Optional[List[ReferenceType]] = None, syslog_server: Optional[SyslogServerPatch] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SyslogServerResponse

Modify the URI or services of a configured syslog server.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • syslog_server (SyslogServerPatch, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_syslog_servers_settings(references: Optional[List[ReferenceType]] = None, syslog_server_settings: Optional[SyslogServerSettings] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SyslogServerSettingsResponse

Modify the certificate or certificate group associated with the syslog servers.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • syslog_server_settings (SyslogServerSettings, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_targets(references: Optional[List[ReferenceType]] = None, target: Optional[Target] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → TargetResponse

Modify the target attributes for replication.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • target (Target, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_tls_policies(references: Optional[List[ReferenceType]] = None, policy: Optional[TlsPolicy] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → TlsPolicyResponse

Modifies one or more attributes of TLS policies.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • policy (TlsPolicy, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_worm_data_policies(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, policy: Optional[WormDataPolicy] = None, x_request_id: Optional[str] = None, context_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) → WormDataPoliciesResponse

Modify a WORM data policy.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • policy (WormDataPolicy, optional) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_active_directory(references: Optional[List[ReferenceType]] = None, active_directory: Optional[ActiveDirectoryPost] = None, x_request_id: Optional[str] = None, join_existing_account: 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) → ActiveDirectoryResponse

Join an Active Directory domain and generate keytabs for the registered SPNs and supported encryption types.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • active_directory (ActiveDirectoryPost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • join_existing_account (bool, optional) – If specified as true, the domain is searched for a pre-existing computer account to join to, and no new account will be created within the domain. The user specified when joining to a pre-existing account must have permissions to ‘read attributes from’ and ‘reset the password of’ the pre-existing account. service_principal_names, encryption_types, and join_ou will be read from the pre-existing account and cannot be specified when joining to an existing account. If not specified, defaults to false.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_admins(references: Optional[List[ReferenceType]] = None, admin: Optional[AdminPost] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → AdminResponse

Create a new local administrator.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • admin (AdminPost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_admins_api_tokens(admins: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, admin_ids: Optional[List[str]] = None, admin_names: Optional[List[str]] = None, timeout: Optional[int] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → AdminApiTokenResponse

Creates API tokens for the specified administrators.

Parameters

  • admins (list[FixedReference], optional) – A list of admins to query for. Overrides admin_ids and admin_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • admin_ids (list[str], optional) – A list of admin IDs. If after filtering, there is not at least one admin resource that matches each of the elements, then an error is returned. This cannot be provided together with the admin_names query parameter.

  • admin_names (list[str], optional) – A list of admin names. If there is not at least one admin resource that matches each of the elements, then an error is returned. This cannot be provided together with admin_ids query parameter.

  • timeout (int, optional) – The duration of API token validity, in milliseconds.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_admins_ssh_certificate_authority_policies(members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberResponse

Map a SSH Certificate Authority policy to a specific user.

Parameters

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • member_ids (list[str], optional) – A list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (list[str], optional) – A list of member names.

  • policy_ids (list[str], optional) – A list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (list[str], optional) – A list of policy names.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_alert_watchers(references: Optional[List[ReferenceType]] = None, names: Optional[List[str]] = None, alert_watcher: Optional[AlertWatcherPost] = None, x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → AlertWatcherResponse

Create an alert watcher to receive array alert messages.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • names (list[str], required) – A list of resource names.

  • alert_watcher (AlertWatcherPost, optional) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_api_clients(references: Optional[List[ReferenceType]] = None, api_client: Optional[ApiClientsPost] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ApiClientsResponse

Create an API client to authorize Access Token or Bearer Tokens for use on the array. Required fields include issuer, public_key, and access_token_ttl_in_ms. After creating an API client, it can only be enabled by an authorized user.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • api_client (ApiClientsPost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_array_connections(contexts: Optional[List[ReferenceType]] = None, array_connection: Optional[ArrayConnectionPost] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ArrayConnectionResponse

Create a connection to an array for replication and configure network settings.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • array_connection (ArrayConnectionPost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_array_connections_connection_key(x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ArrayConnectionKeyResponse

Create an array connection key allowing one array to connect to another for replication.

Parameters

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_arrays_factory_reset_token(x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ArrayFactoryResetTokenResponse

Creates a token that can be used to perform a factory reset on the array. Factory reset tokens can only be created after the array has been prepared for reset (e.g., all file systems, buckets, and snapshots must first be eradicated). After a token has been created, operations that would take the array out of the prepared state (e.g., creating file systems) are disabled until all tokens have been deleted.

Parameters

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_arrays_ssh_certificate_authority_policies(members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberResponse

Map a SSH Certificate Authority policy as a default for admins.

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.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • member_ids (list[str], optional) – A list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (list[str], optional) – A list of member names.

  • policy_ids (list[str], optional) – A list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (list[str], optional) – A list of policy names.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_audit_file_systems_policies(references: Optional[List[ReferenceType]] = None, contexts: Optional[List[ReferenceType]] = None, names: Optional[List[str]] = None, policy: Optional[AuditFileSystemsPoliciesPost] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → AuditFileSystemsPoliciesResponse

Create a new audit policy for file systems.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • names (list[str], required) – A list of resource names.

  • policy (AuditFileSystemsPoliciesPost, optional) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_audit_file_systems_policies_members(contexts: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → AuditFileSystemsPoliciesMembersResponse

Map a file system to a audit policy.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • 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.

Create a bucket replica link for object replication.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names 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.

  • remote_credential (list[FixedReference], optional) – A list of remote_credential to query for. Overrides remote_credentials_ids and remote_credentials_names keyword arguments.

  • bucket_replica_link (BucketReplicaLinkPost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • 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_credentials_ids (list[str], optional) – A list of remote credentials IDs. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_credentials_names query parameter.

  • remote_credentials_names (list[str], optional) – A list of remote credentials names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_credentials_ids query parameter.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_buckets(references: Optional[List[ReferenceType]] = None, contexts: Optional[List[ReferenceType]] = None, bucket: Optional[BucketPost] = None, names: Optional[List[str]] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → BucketResponse

Create a new object store bucket.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • bucket (BucketPost, required) –

  • names (list[str], required) – A list of resource names.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_buckets_bucket_access_policies(buckets: Optional[List[ReferenceType]] = None, contexts: Optional[List[ReferenceType]] = None, policy: Optional[BucketAccessPolicyPost] = None, x_request_id: Optional[str] = None, bucket_ids: Optional[List[str]] = None, bucket_names: Optional[List[str]] = None, context_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → BucketAccessPolicyResponse

Create a new policy for the specified bucket. Policy’s name will be autogenerated by the system.

Parameters

  • buckets (list[FixedReference], optional) – A list of buckets to query for. Overrides bucket_ids and bucket_names keyword arguments.

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • policy (BucketAccessPolicyPost, optional) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • 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.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_buckets_bucket_access_policies_rules(references: Optional[List[ReferenceType]] = None, buckets: Optional[List[ReferenceType]] = None, contexts: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, rule: Optional[BucketAccessPolicyRulePost] = None, names: Optional[List[str]] = None, x_request_id: Optional[str] = None, bucket_ids: Optional[List[str]] = None, bucket_names: Optional[List[str]] = None, context_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) → BucketAccessPolicyRuleResponse

Create a new bucket policy rule for the specified bucket. Either policy_names or bucket_names/bucket_ids query parameters can be used.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • buckets (list[FixedReference], optional) – A list of buckets to query for. Overrides bucket_ids and bucket_names keyword arguments.

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_names keyword arguments.

  • rule (BucketAccessPolicyRulePost, required) –

  • names (list[str], required) – A list of resource names.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • 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.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • policy_names (list[str], optional) – A list of policy names.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_buckets_cross_origin_resource_sharing_policies(buckets: Optional[List[ReferenceType]] = None, contexts: Optional[List[ReferenceType]] = None, policy: Optional[CrossOriginResourceSharingPolicyPatch] = None, x_request_id: Optional[str] = None, bucket_ids: Optional[List[str]] = None, bucket_names: Optional[List[str]] = None, context_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → CrossOriginResourceSharingPolicyResponse

Create a new cross origin resource sharing policy for the specified bucket. Policy’s name will be autogenerated by the system.

Parameters

  • buckets (list[FixedReference], optional) – A list of buckets to query for. Overrides bucket_ids and bucket_names keyword arguments.

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • policy (CrossOriginResourceSharingPolicyPatch, optional) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • 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.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_buckets_cross_origin_resource_sharing_policies_rules(references: Optional[List[ReferenceType]] = None, buckets: Optional[List[ReferenceType]] = None, contexts: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, rule: Optional[CrossOriginResourceSharingPolicyRulePost] = None, names: Optional[List[str]] = None, x_request_id: Optional[str] = None, bucket_ids: Optional[List[str]] = None, bucket_names: Optional[List[str]] = None, context_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) → CrossOriginResourceSharingPolicyRuleResponse

Create a new cross origin resource sharing policy rule for the specified bucket. Either policy_names or bucket_names query parameters can be used.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • buckets (list[FixedReference], optional) – A list of buckets to query for. Overrides bucket_ids and bucket_names keyword arguments.

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_names keyword arguments.

  • rule (CrossOriginResourceSharingPolicyRulePost, required) –

  • names (list[str], required) – A list of resource names.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • 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.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • policy_names (list[str], optional) – A list of policy names.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_certificate_groups(references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → CertificateGroupResponse

Create one or more certificate groups on the array.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_certificate_groups_certificates(certificate_groups: Optional[List[ReferenceType]] = None, certificates: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, certificate_group_ids: Optional[List[str]] = None, certificate_group_names: Optional[List[str]] = None, certificate_ids: Optional[List[str]] = None, certificate_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → CertificateGroupCertificateResponse

Add one or more certificates to one or more certificate groups on the array.

Parameters

  • certificate_groups (list[FixedReference], optional) – A list of certificate_groups to query for. Overrides certificate_group_ids and certificate_group_names keyword arguments.

  • certificates (list[FixedReference], optional) – A list of certificates to query for. Overrides certificate_ids and certificate_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • 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 no resource 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_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_names (list[str], optional) – A list of certificate names. If there is not at least one resource that matches each of the elements of certificate_names, then an error is returned. This cannot be provided in conjunction with the certificate_ids parameter.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_certificates(references: Optional[List[ReferenceType]] = None, certificate: Optional[CertificatePost] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → CertificateResponse

Upload a CA certificate to the array.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • certificate (CertificatePost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_certificates_certificate_groups(certificate_groups: Optional[List[ReferenceType]] = None, certificates: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, certificate_group_ids: Optional[List[str]] = None, certificate_group_names: Optional[List[str]] = None, certificate_ids: Optional[List[str]] = None, certificate_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → CertificateCertificateGroupResponse

Add one or more certificates to one or more certificate groups.

Parameters

  • certificate_groups (list[FixedReference], optional) – A list of certificate_groups to query for. Overrides certificate_group_ids and certificate_group_names keyword arguments.

  • certificates (list[FixedReference], optional) – A list of certificates to query for. Overrides certificate_ids and certificate_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • 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 no resource 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_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_names (list[str], optional) – A list of certificate names. If there is not at least one resource that matches each of the elements of certificate_names, then an error is returned. This cannot be provided in conjunction with the certificate_ids parameter.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_directory_services_roles(references: Optional[List[ReferenceType]] = None, directory_service_roles: Optional[DirectoryServiceRole] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → DirectoryServiceRolesResponse

Create an RBAC group configuration setting for manageability.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • directory_service_roles (DirectoryServiceRole, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_dns(references: Optional[List[ReferenceType]] = None, dns: Optional[DnsPost] = None, names: Optional[List[str]] = None, x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → DnsResponse

Creates new DNS configuration with parameters including the domain suffix, the list of DNS name server IP addresses, and the list of services that DNS parameters apply to.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • dns (DnsPost, required) –

  • names (list[str], required) – A list of resource names.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_file_system_exports(contexts: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, file_system_export: Optional[FileSystemExportPost] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → FileSystemExportResponse

Create a file system export.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • file_system_export (FileSystemExportPost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • 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.

Create a file system replication link.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids keyword arguments.

  • local_file_systems (list[FixedReference], optional) – A list of local_file_systems to query for. Overrides local_file_system_ids and local_file_system_names keyword arguments.

  • remote_file_systems (list[FixedReference], optional) – A list of remote_file_systems to query for. Overrides remote_file_system_names keyword arguments.

  • remotes (list[FixedReference], optional) – A list of remotes to query for. Overrides remote_ids and remote_names keyword arguments.

  • file_system_replica_link (FileSystemReplicaLink, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

  • local_file_system_ids (list[str], optional) – A list of local file system IDs. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the local_file_system_names query parameter.

  • local_file_system_names (list[str], optional) – A list of local file system names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with local_file_system_ids query parameter.

  • remote_file_system_names (list[str], optional) – A list of remote file system names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_file_system_ids query parameter.

  • remote_ids (list[str], optional) – A list of remote array IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_names query parameter.

  • remote_names (list[str], optional) – A list of remote array names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_ids query parameter.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

Add a policy to a file system replication link.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names 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.

  • 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.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • 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, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_ids query parameter.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_file_system_snapshots(contexts: Optional[List[ReferenceType]] = None, sources: Optional[List[ReferenceType]] = None, file_system_snapshot: Optional[FileSystemSnapshotPost] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, send: Optional[bool] = None, source_ids: Optional[List[str]] = None, source_names: Optional[List[str]] = None, targets: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → FileSystemSnapshotResponse

Create a snapshot for a specified source file system. If a source file system is not specified, creates snapshots for all file systems on the array.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • sources (list[FixedReference], optional) – A list of sources to query for. Overrides source_ids and source_names keyword arguments.

  • file_system_snapshot (FileSystemSnapshotPost, optional) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • send (bool, optional) – Whether to replicate created snapshots immediately to other arrays. If it’s false, created snapshots may still be replicated to other arrays according to policy.

  • source_ids (list[str], optional) – A list of source file system IDs. If after filtering, there is not at least one resource that matches each of the elements of source_ids, then an error is returned. This cannot be provided together with the names_or_sources or sources query parameters.

  • source_names (list[str], optional) – A list of names for the source of the object. If there is not at least one resource that matches each of the elements of source_names, an error is returned.

  • targets (list[str], optional) – The target arrays to replicate created snapshots to. Only valid when send is true.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_file_systems(references: Optional[List[ReferenceType]] = None, contexts: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, file_system: Optional[FileSystemPost] = None, names: Optional[List[str]] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, default_exports: Optional[List[str]] = None, discard_non_snapshotted_data: Optional[bool] = None, overwrite: Optional[bool] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → FileSystemResponse

Create a file system on the current array.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • file_system (FileSystemPost, required) –

  • names (list[str], required) – A list of resource names.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • default_exports (list[str], optional) – A list of export types to be created using default access. Creating a file system with an explicit nfs.rules or nfs.export_policy value will always create a NFS export to the default server regardless of this flag. If these are not set and default_exports includes nfs, then nfs.rules will be set to “*(rw,no_root_squash)” and a NFS export to the default server will be created. Otherwise nfs.rules will be set to “” and no NFS export will be created. Creating a file system with an explicit smb.client_policy or smb.share_policy value will always create a SMB export to the default server regardless of this flag. If these are not set and default_exports includes smb, then a SMB export to the default server will be created with default policies. Otherwise no SMB export will be created. Use empty string (“”) to not create these default exports. Default is nfs,smb.

  • discard_non_snapshotted_data (bool, optional) – This parameter must be set to true in order to restore a file system from a snapshot or to demote a file system (which restores the file system from the common baseline snapshot). Setting this parameter to true is acknowledgement that any non-snapshotted data currently in the file system will be irretrievably lost.

  • overwrite (bool, optional) – When used for snapshot restore, overwrites (true) an existing file system.

  • policy_ids (list[str], optional) – A list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (list[str], optional) – A list of policy names.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_file_systems_audit_policies(contexts: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → AuditFileSystemsPoliciesMembersResponse

Map a audit policy to a file system.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • member_ids (list[str], optional) – A list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (list[str], optional) – A list of member names.

  • policy_ids (list[str], optional) – A list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (list[str], optional) – A list of policy names.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_file_systems_locks_nlm_reclamations(x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → FileLockNlmReclamationResponse

NLM reclamation is a system-wide operation, affecting all clients, and so only one may be in progress at a time. Attempting to initiate reclamation while one is in progress will result in an error. When NLM reclamation is initiated, all NLM locks are deleted and client applications are notified that they can reacquire their locks within a grace period.

Parameters

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_file_systems_policies(contexts: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberContextResponse

Apply a snapshot scheduling policy to a file system. Only one file system can be mapped to a policy at a time.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • member_ids (list[str], optional) – A list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (list[str], optional) – A list of member names.

  • policy_ids (list[str], optional) – A list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (list[str], optional) – A list of policy names.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_fleets(references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → FleetResponse

Creates a fleet and adds the current array as its first member. Additional arrays can be added to the fleet with POST /fleets/members

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • names (list[str], optional) – Performs the operation on the unique resource names specified. Only one value is supported.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_fleets_fleet_key(x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → FleetKeyResponse

Creates a fleet key allowing an array to be added to a fleet. This is the only time the fleet key is displayed, it cannot be retrieved subsequently. Note: Creation of a subsequent key invalidates all keys created earlier.

Parameters

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_fleets_members(fleets: Optional[List[ReferenceType]] = None, members: Optional[FleetMemberPost] = None, x_request_id: Optional[str] = None, fleet_ids: Optional[List[str]] = None, fleet_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → FleetMemberResponse

Adds arrays to an existing fleet. This API needs to be run from the array that’s joining the fleet. To add the current array to the fleet, specify its own array id or name as well as the fleet key generated on any array already in the fleet. resource_type is remote-arrays. The array’s ID and name can be retrieved with a call to GET /arrays on the array.

Parameters

  • fleets (list[FixedReference], optional) – A list of fleets to query for. Overrides fleet_ids and fleet_names keyword arguments.

  • members (FleetMemberPost, optional) – Info about the members being added to fleet.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • fleet_ids (list[str], optional) – Performs the operation on the unique Fleet IDs specified. This query currently accepts only 1 ID.

  • fleet_names (list[str], optional) – Performs the operation on the unique Fleet names specified. Enter multiple names in comma-separated format. For example, name01,name02. This query currently accepts only 1 name.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_keytabs(keytab: Optional[KeytabPost] = None, x_request_id: Optional[str] = None, name_prefixes: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → KeytabResponse

Import a Kerberos keytab file from a Key Distribution Center.

Parameters

  • keytab (KeytabPost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • name_prefixes (str, optional) – The prefix to use for the names of all Kerberos keytab objects that are being created.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_keytabs_upload(keytab_file: Optional[str] = None, x_request_id: Optional[str] = None, name_prefixes: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → KeytabFileResponse

Upload a Kerberos keytab file to the array. The file can be uploaded in the native binary format or a base64 encoded format. If not specified, defaults to binary. The procedure to upload a file may vary depending on the type of REST client.

Parameters

  • keytab_file (str, required) – The keytab file to upload.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • name_prefixes (str, optional) – The prefix to use for the names of all Kerberos keytab objects that are being created.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_kmip(references: Optional[List[ReferenceType]] = None, kmip_server: Optional[KmipServer] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → KmipServerResponse

Creates a KMIP server configuration.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • kmip_server (KmipServer, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • names (list[str], optional) – A list 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.

Create a legal hold instance.

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.

  • hold (LegalHold, optional) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

Apply this legal hold to a new entity. The names, file_system_names and paths query parameters are required. The recursive flag is required when applying a hold to a directory.

Parameters

  • file_systems (list[FixedReference], optional) – A list of file_systems to query for. Overrides file_system_ids and file_system_names keyword arguments.

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • 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.

  • ids (list[str], optional) – A list of resource IDs. If after filtering, there is not at least one resource that 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.

  • 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) – This is a flag to set when recursively applying/releasing legal holds on entities. By default, it is set to be false. The recursive flag is required when applying/releasing a hold to/from a directory.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_lifecycle_rules(contexts: Optional[List[ReferenceType]] = None, rule: Optional[LifecycleRulePost] = None, x_request_id: Optional[str] = None, confirm_date: Optional[bool] = None, context_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → LifecycleRuleResponse

Creates a lifecycle rule. bucket and keep_previous_version_for are required. If rule_id is not specified, it will be automatically generated in the format “fbRuleIdX”.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • rule (LifecycleRulePost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • confirm_date (bool, optional) – If set to true, then confirm the date of keep_current_version_until is correct.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

Create a link aggregation group of Ethernet ports on the array.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • link_aggregation_group (LinkAggregationGroup, required) –

  • names (list[str], required) – A list of resource names.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_maintenance_windows(references: Optional[List[ReferenceType]] = None, maintenance_window: Optional[MaintenanceWindowPost] = None, names: Optional[List[str]] = None, x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → MaintenanceWindowsResponse

Creates a maintenance window that suppresses alerts for a specified period of time. A maintenance window can be manually closed at any time. The names and timeout parameters are required. Set the names parameter to array.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • maintenance_window (MaintenanceWindowPost, required) –

  • names (list[str], required) – A list of resource names.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_network_access_policies_rules(policies: Optional[List[ReferenceType]] = None, rule: Optional[NetworkAccessPolicyRulePost] = None, x_request_id: Optional[str] = None, before_rule_id: Optional[str] = None, before_rule_name: Optional[str] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, versions: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → NetworkAccessPolicyRuleResponse

Create a new network access policy rule. Either policy_ids or policy_names parameter is required.

Parameters

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • rule (NetworkAccessPolicyRulePost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • before_rule_id (str, optional) – The id of the rule to insert or move a rule before. This cannot be provided together with the before_rule_name query parameter.

  • before_rule_name (str, optional) – The name of the rule to insert or move a rule before. This cannot be provided together with the before_rule_id query parameter.

  • policy_ids (list[str], optional) – A list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (list[str], optional) – A list of policy names.

  • versions (list[str], optional) – A list of versions. This is an optional query param used for concurrency control. The ordering should match the names or ids query param. This will fail with a 412 Precondition failed if the resource was changed and the current version of the resource doesn’t match the value in the query param.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_network_interfaces(references: Optional[List[ReferenceType]] = None, network_interface: Optional[NetworkInterface] = None, names: Optional[List[str]] = None, x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → NetworkInterfaceResponse

Create a VIP to export data or perform replication.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • network_interface (NetworkInterface, required) –

  • names (list[str], required) – A list of resource names.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_network_interfaces_tls_policies(members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberResponse

Apply a TLS policy to a specific network interface. A given network interface may only have 1 TLS policy applied to it at any given time.

Parameters

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • member_ids (list[str], optional) – A list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (list[str], optional) – A list of member names.

  • policy_ids (list[str], optional) – A list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (list[str], optional) – A list of policy names.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_nfs_export_policies(references: Optional[List[ReferenceType]] = None, contexts: Optional[List[ReferenceType]] = None, names: Optional[List[str]] = None, policy: Optional[NfsExportPolicyPost] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → NfsExportPolicyResponse

Create a new NFS export policy.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • names (list[str], required) – A list of resource names.

  • policy (NfsExportPolicyPost, optional) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_nfs_export_policies_rules(contexts: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, rule: Optional[NfsExportPolicyRule] = None, x_request_id: Optional[str] = None, before_rule_id: Optional[str] = None, before_rule_name: Optional[str] = None, context_names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, versions: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → NfsExportPolicyRuleResponse

Add a NFS export policy rule. Rules are ordered in three groups; ip addresses, other and *. The new rule will be added at the end of the appropriate group if neither before_rule_id and before_rule_name are specified. Rules can only be inserted into the appropriate group. Either policy_ids or policy_names parameter is required.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • rule (NfsExportPolicyRule, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • before_rule_id (str, optional) – The id of the rule to insert or move a rule before. This cannot be provided together with the before_rule_name query parameter.

  • before_rule_name (str, optional) – The name of the rule to insert or move a rule before. This cannot be provided together with the before_rule_id query parameter.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • policy_ids (list[str], optional) – A list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (list[str], optional) – A list of policy names.

  • versions (list[str], optional) – A list of versions. This is an optional query param used for concurrency control. The ordering should match the names or ids query param. This will fail with a 412 Precondition failed if the resource was changed and the current version of the resource doesn’t match the value in the query param.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_object_store_access_keys(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, object_store_access_key: Optional[ObjectStoreAccessKeyPost] = None, x_request_id: Optional[str] = None, context_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) → ObjectStoreAccessKeyResponse

Create or import object store access keys.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • object_store_access_key (ObjectStoreAccessKeyPost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • names (list[str], optional) – A list of resource names to import. To import a set of credentials, this field must be specified with the secret_access_key body parameter. If both of these are not specified, the system will generate a new set of credentials.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_object_store_access_policies(references: Optional[List[ReferenceType]] = None, contexts: Optional[List[ReferenceType]] = None, names: Optional[List[str]] = None, policy: Optional[ObjectStoreAccessPolicyPost] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, enforce_action_restrictions: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ObjectStoreAccessPolicyResponse

Create a new access policy.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • names (list[str], required) – A list of resource names.

  • policy (ObjectStoreAccessPolicyPost, optional) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • enforce_action_restrictions (bool, optional) – Certain combinations of actions and other rule elements are inherently ignored if specified together in a rule. If set to true, operations which attempt to set these combinations will fail. If set to false, such operations will instead be allowed. Defaults to true.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_object_store_access_policies_object_store_roles(contexts: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberContextResponse

Grant access policies to an object store role.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • member_ids (list[str], optional) – A list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (list[str], optional) – A list of member names.

  • policy_ids (list[str], optional) – A list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (list[str], optional) – A list of policy names.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_object_store_access_policies_object_store_users(contexts: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberContextResponse

Grant access policies to an object store user.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • member_ids (list[str], optional) – A list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (list[str], optional) – A list of member names.

  • policy_ids (list[str], optional) – A list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (list[str], optional) – A list of policy names.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_object_store_access_policies_rules(references: Optional[List[ReferenceType]] = None, contexts: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, rule: Optional[PolicyRuleObjectAccessPost] = None, names: Optional[List[str]] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, enforce_action_restrictions: Optional[bool] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ObjectStoreAccessPolicyRuleResponse

Create a new access policy rule.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • rule (PolicyRuleObjectAccessPost, required) –

  • names (list[str], required) – A list of resource names.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • enforce_action_restrictions (bool, optional) – Certain combinations of actions and other rule elements are inherently ignored if specified together in a rule. If set to true, operations which attempt to set these combinations will fail. If set to false, such operations will instead be allowed. Defaults to true.

  • policy_ids (list[str], optional) – A list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (list[str], optional) – A list of policy names.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_object_store_accounts(references: Optional[List[ReferenceType]] = None, contexts: Optional[List[ReferenceType]] = None, names: Optional[List[str]] = None, object_store_account: Optional[ObjectStoreAccountPost] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ObjectStoreAccountResponse

Create an object store account.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • names (list[str], required) – A list of resource names.

  • object_store_account (ObjectStoreAccountPost, optional) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_object_store_remote_credentials(references: Optional[List[ReferenceType]] = None, contexts: Optional[List[ReferenceType]] = None, remote_credentials: Optional[ObjectStoreRemoteCredentialsPost] = None, names: Optional[List[str]] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ObjectStoreRemoteCredentialsResp

Create object store remote credentials to set up bucket replicat links to a remote array or target.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • remote_credentials (ObjectStoreRemoteCredentialsPost, required) –

  • names (list[str], required) – A list of resource names.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_object_store_roles(references: Optional[List[ReferenceType]] = None, contexts: Optional[List[ReferenceType]] = None, object_store_role: Optional[ObjectStoreRolePost] = None, names: Optional[List[str]] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ObjectStoreRoleResponse

Create new object store roles.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • object_store_role (ObjectStoreRolePost, required) –

  • names (list[str], required) – A list of resource names.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_object_store_roles_object_store_access_policies(contexts: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberContextResponse

Grant access policies to an object store role.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • member_ids (list[str], optional) – A list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (list[str], optional) – A list of member names.

  • policy_ids (list[str], optional) – A list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (list[str], optional) – A list of policy names.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_object_store_roles_object_store_trust_policies_rules(contexts: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, roles: Optional[List[ReferenceType]] = None, rule: Optional[TrustPolicyRulePost] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, names: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, role_ids: Optional[List[str]] = None, role_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ObjectStoreTrustPolicyRuleResponse

Create a new trust policy rule.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_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.

  • roles (list[FixedReference], optional) – A list of roles to query for. Overrides role_ids and role_names keyword arguments.

  • rule (TrustPolicyRulePost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • names (list[str], optional) – A list 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.

  • role_ids (list[str], optional) – A list of object store role IDs. If after filtering, there is not at least one resource that matches each of the elements of role_ids, then an error is returned. This cannot be provided together with the role_names query parameter.

  • role_names (list[str], optional) – A list of object store role names. If there is not at least one resource that matches each of the elements of role_names, then an error is returned. This cannot be provided together with the role_ids query parameter.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_object_store_users(references: Optional[List[ReferenceType]] = None, contexts: Optional[List[ReferenceType]] = None, names: Optional[List[str]] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, full_access: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ObjectStoreUserResponse

Create object store users to administer object storage for an object store account.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • names (list[str], required) – A list of resource names.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • full_access (bool, optional) – If set to true, creates an object store user with full permissions. If set to false, creates an object store user with no permission. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_object_store_users_object_store_access_policies(contexts: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberContextResponse

Grant access policies to an object store user.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • member_ids (list[str], optional) – A list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (list[str], optional) – A list of member names.

  • policy_ids (list[str], optional) – A list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (list[str], optional) – A list of policy names.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_object_store_virtual_hosts(references: Optional[List[ReferenceType]] = None, contexts: Optional[List[ReferenceType]] = None, names: Optional[List[str]] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ObjectStoreVirtualHostResponse

Create an object store virtual host. An example of a hostname is buckethost.example.com. A hostname cannot exceed 255 characters in length, it cannot be an IP address, only 10 hostnames are supported, supersets or subsets of existing hostnames with the same root are not allowed. The default hostname is s3.amazonaws.com and it cannot be deleted.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • names (list[str], required) – A list of resource names.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_policies(references: Optional[List[ReferenceType]] = None, contexts: Optional[List[ReferenceType]] = None, names: Optional[List[str]] = None, policy: Optional[Policy] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyResponse

Create a new snapshot scheduling policy with rule attributes to capture file system snapshots for a set period of time and frequency, as well as how long snapshots are retained before being destroyed and eradicated.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • names (list[str], required) – A list of resource names.

  • policy (Policy, optional) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

Add a snapshot scheduling policy to a file system replica link.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names 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.

  • 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.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • 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, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_ids query parameter.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_policies_file_systems(contexts: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberContextResponse

Map a file system to a snapshot scheduling policy.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • member_ids (list[str], optional) – A list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (list[str], optional) – A list of member names.

  • policy_ids (list[str], optional) – A list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (list[str], optional) – A list of policy names.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_public_keys(references: Optional[List[ReferenceType]] = None, public_key: Optional[PublicKeyPost] = None, names: Optional[List[str]] = None, x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PublicKeyResponse

Creates public key configurations.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • public_key (PublicKeyPost, required) –

  • names (list[str], required) – A list of resource names.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_qos_policies(references: Optional[List[ReferenceType]] = None, policy: Optional[QosPolicy] = None, names: Optional[List[str]] = None, x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → QosPoliciesResponse

Create a QoS policy.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • policy (QosPolicy, required) –

  • names (list[str], required) – A list of resource names.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_quotas_groups(contexts: Optional[List[ReferenceType]] = None, file_systems: Optional[List[ReferenceType]] = None, groups: Optional[List[ReferenceType]] = None, quota: Optional[GroupQuotaPost] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, file_system_ids: Optional[List[str]] = None, file_system_names: Optional[List[str]] = None, gids: Optional[List[int]] = None, group_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → GroupQuotaResponse

Create a hard limit quota for a group.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_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.

  • groups (list[FixedReference], optional) – A list of groups to query for. Overrides group_names keyword arguments.

  • quota (GroupQuotaPost, optional) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • file_system_ids (list[str], optional) – A list of file system IDs. If after filtering, there is not at least one resource that matches each of the elements of file_system_ids, then an error is returned. This cannot be provided together with the file_system_names query parameter.

  • file_system_names (list[str], optional) – A list of file system names. If there is not at least one resource that matches each of the elements of file_system_names, then an error is returned.

  • gids (list[int], optional) – A list of group IDs. If there is not at least one resource that matches each of the elements of gids, then an error is returned. This cannot be provided together with group_names query parameter.

  • group_names (list[str], optional) – A list of group names. If there is not at least one resource that matches each of the elements of group_names, then an error is returned. This cannot be provided together with gids query parameter.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_quotas_users(contexts: Optional[List[ReferenceType]] = None, file_systems: Optional[List[ReferenceType]] = None, users: Optional[List[ReferenceType]] = None, quota: Optional[UserQuotaPost] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, file_system_ids: Optional[List[str]] = None, file_system_names: Optional[List[str]] = None, uids: Optional[List[int]] = None, user_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → UserQuotaResponse

Create a hard limit file system quota for a user.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_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.

  • users (list[FixedReference], optional) – A list of users to query for. Overrides user_names keyword arguments.

  • quota (UserQuotaPost, optional) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • file_system_ids (list[str], optional) – A list of file system IDs. If after filtering, there is not at least one resource that matches each of the elements of file_system_ids, then an error is returned. This cannot be provided together with the file_system_names query parameter.

  • file_system_names (list[str], optional) – A list of file system names. If there is not at least one resource that matches each of the elements of file_system_names, then an error is returned.

  • uids (list[int], optional) – A list of user IDs. If there is not at least one resource that matches each of the elements of uids, then an error is returned. This cannot be provided together with user_names query parameter.

  • user_names (list[str], optional) – A list of user names. If there is not at least one resource that matches each of the elements of user_names, then an error is returned. This cannot be provided together with uids query parameter.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_rapid_data_locking_rotate(x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Rotates the external keys on the associated EKM appliance.

Parameters

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_servers(references: Optional[List[ReferenceType]] = None, server: Optional[ServerPost] = None, create_ds: Optional[str] = None, names: Optional[List[str]] = None, x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ServerResponse

Add a server.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • server (ServerPost, required) –

  • create_ds (str, required) – The name of the directory service object to create used for NFS access to this server. The name must be the server name followed by _nfs.

  • names (list[str], required) – A list of resource names.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_smb_client_policies(references: Optional[List[ReferenceType]] = None, contexts: Optional[List[ReferenceType]] = None, names: Optional[List[str]] = None, policy: Optional[SmbClientPolicyPost] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SmbClientPolicyResponse

Create a new SMB Client policy.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • names (list[str], required) – A list of resource names.

  • policy (SmbClientPolicyPost, optional) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_smb_client_policies_rules(contexts: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, rule: Optional[SmbClientPolicyRulePost] = None, x_request_id: Optional[str] = None, before_rule_id: Optional[str] = None, before_rule_name: Optional[str] = None, context_names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, versions: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SmbClientPolicyRuleResponse

Add an SMB Client policy rule. Rules are ordered in three groups; ip addresses, other and *. The new rule will be added at the end of the appropriate group if neither before_rule_id nor before_rule_name are specified. Rules can only be inserted into the appropriate group. The policy_ids or policy_names parameter is required, but they cannot be set together.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • rule (SmbClientPolicyRulePost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • before_rule_id (str, optional) – The id of the rule to insert or move a rule before. This cannot be provided together with the before_rule_name query parameter.

  • before_rule_name (str, optional) – The name of the rule to insert or move a rule before. This cannot be provided together with the before_rule_id query parameter.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • policy_ids (list[str], optional) – A list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (list[str], optional) – A list of policy names.

  • versions (list[str], optional) – A list of versions. This is an optional query param used for concurrency control. The ordering should match the names or ids query param. This will fail with a 412 Precondition failed if the resource was changed and the current version of the resource doesn’t match the value in the query param.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_smb_share_policies(references: Optional[List[ReferenceType]] = None, contexts: Optional[List[ReferenceType]] = None, names: Optional[List[str]] = None, policy: Optional[SmbSharePolicyPost] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SmbSharePolicyResponse

Create a new SMB Share policy.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • names (list[str], required) – A list of resource names.

  • policy (SmbSharePolicyPost, optional) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_smb_share_policies_rules(contexts: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, rule: Optional[SmbSharePolicyRulePost] = None, x_request_id: Optional[str] = None, context_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) → SmbSharePolicyRuleResponse

Add an SMB Share policy rule. The policy_ids or policy_names parameter is required, but they cannot be set together.

Parameters

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • rule (SmbSharePolicyRulePost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • policy_ids (list[str], optional) – A list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (list[str], optional) – A list of policy names.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_snmp_managers(references: Optional[List[ReferenceType]] = None, snmp_manager: Optional[SnmpManagerPost] = None, names: Optional[List[str]] = None, x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SnmpManagerResponse

Create an SNMP manager.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • snmp_manager (SnmpManagerPost, required) –

  • names (list[str], required) – A list of resource names.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_software_check(softwares: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, software_names: Optional[List[str]] = None, software_versions: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SoftwareChecksResponse

Creates a software check task. To create a task, use a software name and version. If a task is already running, an error is returned.

Parameters

  • softwares (list[FixedReference], optional) – A list of softwares to query for. Overrides software_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • software_names (list[str], optional) – A list of software names.

  • software_versions (list[str], optional) – A list of target software versions.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_ssh_certificate_authority_policies(references: Optional[List[ReferenceType]] = None, policy: Optional[SshCertificateAuthorityPolicyPost] = None, names: Optional[List[str]] = None, x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SshCertificateAuthorityPolicyResponse

Creates SSH Certificate Authority configurations.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • policy (SshCertificateAuthorityPolicyPost, required) –

  • names (list[str], required) – A list of resource names.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_ssh_certificate_authority_policies_admins(members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberResponse

Map a SSH Certificate Authority policy to a specific user.

Parameters

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • member_ids (list[str], optional) – A list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (list[str], optional) – A list of member names.

  • policy_ids (list[str], optional) – A list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (list[str], optional) – A list of policy names.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_ssh_certificate_authority_policies_arrays(members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberResponse

Map a SSH Certificate Authority policy as a default for admins.

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.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • member_ids (list[str], optional) – A list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (list[str], optional) – A list of member names.

  • policy_ids (list[str], optional) – A list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (list[str], optional) – A list of policy names.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_sso_oidc_idps(references: Optional[List[ReferenceType]] = None, idp: Optional[OidcSsoPost] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → OidcSsoResponse

Create OIDC SSO configuration.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • idp (OidcSsoPost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • names (list[str], optional) – A list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_sso_saml2_idps(references: Optional[List[ReferenceType]] = None, idp: Optional[Saml2SsoPost] = None, names: Optional[List[str]] = None, x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → Saml2SsoResponse

Creates SAML2 SSO configurations.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • idp (Saml2SsoPost, required) –

  • names (list[str], required) – A list of resource names.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_subnets(references: Optional[List[ReferenceType]] = None, subnet: Optional[Subnet] = None, names: Optional[List[str]] = None, x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SubnetResponse

Create an array subnet.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • subnet (Subnet, required) –

  • names (list[str], required) – A list of resource names.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_support_diagnostics(x_request_id: Optional[str] = None, analysis_period_end_time: Optional[int] = None, analysis_period_start_time: Optional[int] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SupportDiagnosticsGetResponse

Creates a diagnostics task for a given time interval. If start_time is not provided, defaults to Current System Time - 1 hour. If end_time is not provided, defaults to Current System Time. If a task is already running, an error is returned.

Parameters

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • analysis_period_end_time (int, optional) – When the analysis time window ends (in milliseconds since epoch).

  • analysis_period_start_time (int, optional) – When the analysis 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.

post_syslog_servers(references: Optional[List[ReferenceType]] = None, syslog_server: Optional[SyslogServerPost] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SyslogServerResponse

Configure a new syslog server.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • syslog_server (SyslogServerPost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_targets(references: Optional[List[ReferenceType]] = None, target: Optional[TargetPost] = None, names: Optional[List[str]] = None, x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → TargetResponse

Add a target for replication.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • target (TargetPost, required) –

  • names (list[str], required) – A list of resource names.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_tls_policies(references: Optional[List[ReferenceType]] = None, policy: Optional[TlsPolicyPost] = None, names: Optional[List[str]] = None, x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → TlsPolicyResponse

Creates TLS policies.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • policy (TlsPolicyPost, required) –

  • names (list[str], required) – A list of resource names.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_tls_policies_network_interfaces(members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberResponse

Apply a TLS policy to a specific network interface. A given network interface may only have 1 TLS policy applied to it at any given time.

Parameters

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • member_ids (list[str], optional) – A list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

  • member_names (list[str], optional) – A list of member names.

  • policy_ids (list[str], optional) – A list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

  • policy_names (list[str], optional) – A list of policy names.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_worm_data_policies(references: Optional[List[ReferenceType]] = None, contexts: Optional[List[ReferenceType]] = None, names: Optional[List[str]] = None, policy: Optional[WormDataPolicy] = None, x_request_id: Optional[str] = None, context_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → WormDataPoliciesResponse

Create a WORM data policy.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • contexts (list[FixedReference], optional) – A list of contexts to query for. Overrides context_names keyword arguments.

  • names (list[str], required) – A list of resource names.

  • policy (WormDataPolicy, optional) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • context_names (list[str], optional) – Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

Properties

Property

class pypureclient.flashblade.Property(value)

A Property object models a property of a resource and allows for easy compounding, sorting, and filtering with them. It is converted to a string when calling any API and can also be replaced by a string.

__add__(other)

The + operator. Create a subproperty.

Parameters

other (Property) – The Property to be the subproperty of the given Property.

Returns

Property

Raises

PureError – If other is not of the proper type.

__eq__(other)

The == operator. Create a Filter that checks for equality.

Parameters

other (str, int, bool) – The value to compare to.

Returns

Filter

Raises

PureError – If other is not of the proper type.

__ge__(other)

The >= operator. Create a Filter that checks for greater than or equal.

Parameters

other (str, int) – The value to compare to.

Returns

Filter

Raises

PureError – If other is not of the proper type.

__getitem__(index)

The [] operator. Create a list Property with the given index.

Parameters

index (str) – The list index to use.

Returns

Property

Raises

PureError – If index is not “all” or “any”.

__gt__(other)

The > operator. Create a Filter that checks for greater than.

Parameters

other (str, int) – The value to compare to.

Returns

Filter

Raises

PureError – If other is not of the proper type.

__init__(value)

Initialize a Property.

Parameters

value (str) – The name of the property.

__le__(other)

The <= operator. Create a Filter that checks for less than or equal.

Parameters

other (str, int) – The value to compare to.

Returns

Filter

Raises

PureError – If other is not of the proper type.

__lt__(other)

The < operator. Create a Filter that checks for less than.

Parameters

other (str, int) – The value to compare to.

Returns

Filter

Raises

PureError – If other is not of the proper type.

__ne__(other)

The != operator. Create a Filter that checks for inequality.

Parameters

other (str, int, bool) – The value to compare to.

Returns

Filter

Raises

PureError – If other is not of the proper type.

__repr__()

Return the string value of the Property.

Returns

str

all()

Create a list Property indexed by “all”.

Returns

Property

any()

Create a list Property indexed by “any”.

Returns

Property

ascending()

Create a Property that can be sorted in ascending order.

Returns

Property

descending()

Create a property that can be sorted in descending order.

Returns

Property

exists()

Create a Filter that checks for existance of the given Property.

Returns

Filter

subproperty(other)

Create a subproperty.

Parameters

other (Property) – The Property to be the subproperty of the given Property.

Returns

Property

Raises

PureError – If other is not of the proper type.

Filter

class pypureclient.flashblade.Filter(operation, operand1, operand2=None)

A Filter object models a filter string by keeping track of operations between Properties, values, and other Filters. It is converted to a string when calling any API and can also be replaced by a string.

__and__(other)

The & operator. Create a Filter that is the AND of two Filters.

Parameters

other (Filter) – The Filter to AND.

Returns

Filter

Raises

PureError – If other is not of the proper type.

__init__(operation, operand1, operand2=None)

Initialize a Filter. Should not be used directly. Instead, use the static methods to create Filters.

Parameters

  • operation (_Operation) – The operation.

  • operand1 (any) – The first operand.

  • operand2 (any, optional) – The second operand, if the operation is binary. Defaults to None.

__invert__()

The ~ operator. Create a Filter that is the inverse of another Filter.

Returns

Filter

__or__(other)

The | operator. Create a Filter that is the OR of two Filters.

Parameters

other (Filter) – The Filter to OR.

Returns

Filter

Raises

PureError – If other is not of the proper type.

__repr__()

Return the string value of the Filter.

Returns

str

static and_(operand1, operand2)

Create a Filter that is the AND of two Filters.

Parameters

  • operand1 (Filter) – The first Filter.

  • operand2 (Filter) – The second Filter.

Returns

Filter

Raises

PureError – If either operand is not of the proper type.

static contains(operand1, operand2)

Create a Filter that checks for substring containment.

Parameters

  • operand1 (Property, str) – The Property to check.

  • operand2 (str) – The value to check for.

Returns

Filter

Raises

PureError – If either operand is not of the proper type.

static eq(operand1, operand2)

Create a Filter that checks for equality.

Parameters

  • operand1 (Property, str) – The Property to compare.

  • operand2 (str, int, bool) – The value to compare to.

Returns

Filter

Raises

PureError – If either operand is not of the proper type.

static exists(operand1)

Create a Filter that checks for existance of a Property.

Parameters

operand1 (Property, str) – The Property to check for.

Returns

Filter

Raises

PureError – If the operand is not of the proper type.

static ge(operand1, operand2)

Create a Filter that checks for greater than or equal.

Parameters

  • operand1 (Property, str) – The Property to compare.

  • operand2 (str, int) – The value to compare to.

Returns

Filter

Raises

PureError – If either operand is not of the proper type.

static gt(operand1, operand2)

Create a Filter that checks for greater than.

Parameters

  • operand1 (Property, str) – The Property to compare.

  • operand2 (str, int) – The value to compare to.

Returns

Filter

Raises

PureError – If either operand is not of the proper type.

static in_(operand1, operand2)

Create a Filter that checks if a Property is in a list of values.

Parameters

  • operand1 (Property, str) – The Property to check.

  • operand2 (list[str], list[int]) – The list of values.

Returns

Filter

Raises

PureError – If either operand is not of the proper type.

static le(operand1, operand2)

Create a Filter that checks for less than or equal.

Parameters

  • operand1 (Property, str) – The Property to compare.

  • operand2 (str, int) – The value to compare to.

Returns

Filter

Raises

PureError – If either operand is not of the proper type.

static lt(operand1, operand2)

Create a Filter that checks for less than.

Parameters

  • operand1 (Property, str) – The Property to compare.

  • operand2 (str, int) – The value to compare to.

Returns

Filter

Raises

PureError – If either operand is not of the proper type.

static ne(operand1, operand2)

Create a Filter that checks for inequality.

Parameters

  • operand1 (Property, str) – The Property to compare.

  • operand2 (str, int, bool) – The value to compare to.

Returns

Filter

Raises

PureError – If either operand is not of the proper type.

static not_(operand1)

Create a Filter that is the inverse of another Filter.

Parameters

operand1 (Filter) – The Filter to invert.

Returns

Filter

Raises

PureError – If the operand is not of the proper type.

static or_(operand1, operand2)

Create a Filter that is the OR of two Filters.

Parameters

  • operand1 (Filter) – The first Filter.

  • operand2 (Filter) – The second Filter.

Returns

Filter

Raises

PureError – If either operand is not of the proper type.

static tags(operand1, operand2)

Create a Filter that checks for a key-value tag.

Parameters

  • operand1 (str) – The key of the tag.

  • operand2 (str) – The value of the tag.

Returns

Filter

Raises

PureError – If either operand is not of the proper type.

Responses

ResponseHeaders

class pypureclient.flashblade.ResponseHeaders(x_request_id, x_ratelimit_limit_second, x_ratelimit_limit_minute, x_ratelimit_remaining_second, x_ratelimit_remaining_minute)

An object that includes headers from the server response.

__init__(x_request_id, x_ratelimit_limit_second, x_ratelimit_limit_minute, x_ratelimit_remaining_second, x_ratelimit_remaining_minute)

Initialize a ResponseHeaders.

Parameters

  • x_request_id (str) – The X-Request-ID from the client or generated by the server.

  • x_ratelimit_limit_second (int) – The number of requests available per second.

  • x_ratelimit_limit_minute (int) – The number of requests available per minute.

  • x_ratelimit_remaining_second (int) – The number of requests remaining in that second.

  • x_ratelimit_remaining_minute (int) – The number of requests remaining in that minute.

__repr__()

Return a pretty formatted string of the object.

Returns

str

to_dict()

Return a dictionary of the class attributes.

Returns

dict

ValidResponse

class pypureclient.flashblade.ValidResponse(status_code, continuation_token, total_item_count, items, headers, total=None, more_items_remaining=None, errors=None)

A response that indicates the request was successful and has the returned data.

__init__(status_code, continuation_token, total_item_count, items, headers, total=None, more_items_remaining=None, errors=None)

Initialize a ValidResponse.

Parameters

  • status_code (int) – The HTTP status code.

  • continuation_token (str) – An opaque token to iterate over a collection of resources. May be None.

  • total_item_count (int) – The total number of items available in the collection.

  • items (ItemIterator) – An iterator over the items in the collection.

  • headers (dict) – Response headers from the server.

__repr__()

Return a pretty formatted string of the object. Does not convert the items to a list of items by using the iterator.

Returns

str

to_dict()

Return a dictionary of the class attributes. It will convert the items to a list of items by exhausting the iterator. If any items were previously iterated, they will be missed.

Returns

dict

ApiError

class pypureclient.flashblade.ApiError(context, message, location_context=None)

An object that models the error response from the server.

__init__(context, message, location_context=None)

Initialize an ApiError.

Parameters

  • context (str) – The context in which the error occurred.

  • message (str) – The error message.

  • location_context (str) – The execution context where the error occurred.

__repr__()

Return a pretty formatted string of the object.

Returns

str

to_dict()

Return a dictionary of the class attributes.

Returns

dict

ErrorResponse

class pypureclient.flashblade.ErrorResponse(status_code, errors, headers)

A response that indicates there was an error with the request and has the list of errors.

__init__(status_code, errors, headers)

Initialize an ErrorResponse.

Parameters

  • status_code (int) – The HTTP status code.

  • errors (list[ApiError]) – The list of errors encountered.

  • headers (dict) – Response headers from the server.

__repr__()

Return a pretty formatted string of the object.

Returns

str

to_dict()

Return a dictionary of the class attributes.

Returns

dict

Models

ActiveDirectory

class pypureclient.flashblade.ActiveDirectory(name=None, id=None, global_catalog_servers=None, kerberos_servers=None, computer_name=None, server=None, join_ou=None, directory_servers=None, domain=None, service_principal_names=None, encryption_types=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, global_catalog_servers=None, kerberos_servers=None, computer_name=None, server=None, join_ou=None, directory_servers=None, domain=None, service_principal_names=None, encryption_types=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • global_catalog_servers (list[str]) – A list of global catalog servers that will be used for lookups related to user authorization. Accepted server formats are IP address and DNS name with optional @domain suffix. If the suffix is ommited, the joined domain is assumed. All specified servers must be registered to the domain appropriately in the array’s configured DNS and will only be communicated with over the secure LDAP (LDAPS) protocol.

  • kerberos_servers (list[str]) – A list of key distribution servers to use for Kerberos protocol. Accepted server formats are IP address and DNS name. All specified servers must be registered to the domain appropriately in the array’s configured DNS.

  • computer_name (str) – The common name of the computer account to be created in the Active Directory domain. If not specified, defaults to the name of the Active Directory configuration.

  • server (FixedReference) – The server containing this active directory account.

  • join_ou (str) – The relative distinguished name of the organizational unit in which the computer account was created when joining the domain.

  • directory_servers (list[str]) – A list of directory servers that will be used for lookups related to user authorization. Accepted server formats are IP address and DNS name with optional @domain suffix. If the suffix is ommited, the joined domain is assumed. All specified servers must be registered to the domain appropriately in the array’s configured DNS and will only be communicated with over the secure LDAP (LDAPS) protocol.

  • domain (str) – The Active Directory domain to join.

  • service_principal_names (list[str]) – A list of service principal names registered for the machine account, which can be used for the creation of keys for Kerberos authentication.

  • encryption_types (list[str]) – The encryption types that are supported for use by clients for Kerberos authentication.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ActiveDirectoryDirectoryServers

class pypureclient.flashblade.ActiveDirectoryDirectoryServers(global_catalog_servers=None, directory_servers=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(global_catalog_servers=None, directory_servers=None)
Keyword Arguments

  • global_catalog_servers (list[str]) – A list of global catalog servers that will be used for lookups related to user authorization. Accepted server formats are IP address and DNS name with optional @domain suffix. If the suffix is ommited, the joined domain is assumed. All specified servers must be registered to the domain appropriately in the array’s configured DNS and will only be communicated with over the secure LDAP (LDAPS) protocol. The specified list can have a maximum length of 50.

  • directory_servers (list[str]) – A list of directory servers that will be used for lookups related to user authorization. Accepted server formats are IP address and DNS name with optional @domain suffix. If the suffix is ommited, the joined domain is assumed. All specified servers must be registered to the domain appropriately in the array’s configured DNS and will only be communicated with over the secure LDAP (LDAPS) protocol. The specified list can have a maximum length of 50.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ActiveDirectoryPatch

class pypureclient.flashblade.ActiveDirectoryPatch(global_catalog_servers=None, directory_servers=None, kerberos_servers=None, join_ou=None, service_principal_names=None, encryption_types=None, fqdns=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(global_catalog_servers=None, directory_servers=None, kerberos_servers=None, join_ou=None, service_principal_names=None, encryption_types=None, fqdns=None)
Keyword Arguments

  • global_catalog_servers (list[str]) – A list of global catalog servers that will be used for lookups related to user authorization. Accepted server formats are IP address and DNS name with optional @domain suffix. If the suffix is ommited, the joined domain is assumed. All specified servers must be registered to the domain appropriately in the array’s configured DNS and will only be communicated with over the secure LDAP (LDAPS) protocol. The specified list can have a maximum length of 50.

  • directory_servers (list[str]) – A list of directory servers that will be used for lookups related to user authorization. Accepted server formats are IP address and DNS name. All specified servers must be registered to the domain appropriately in the array’s configured DNS and will only be communicated with over the secure LDAP (LDAPS) protocol. If not specified, servers are resolved for the domain in DNS. The specified list can have a maximum length of 5.

  • kerberos_servers (list[str]) – A list of key distribution servers to use for Kerberos protocol. Accepted server formats are IP address and DNS name. All specified servers must be registered to the domain appropriately in the array’s configured DNS. If not specified, servers are resolved for the domain in DNS. The specified list can have a maximum length of 5.

  • join_ou (str) – The relative distinguished name of the organizational unit in which the computer account should be created when joining the domain.

  • service_principal_names (list[str]) – A list of service principal names to register for the machine account, which can be used for the creation of keys for Kerberos authentication. If neither service_principal_names nor fqdns is specified, the default service_principal_names are constructed using the computer_name and domain fields. Cannot be provided in combination with fqdns.

  • encryption_types (list[str]) – The encryption types that will be supported for use by clients for Kerberos authentication. Valid values include aes256-cts-hmac-sha1-96, aes128-cts-hmac-sha1-96, and arcfour-hmac.

  • fqdns (list[str]) – A list of fully qualified domain names to use to register service principal names for the machine account. If specified, every service principal that is supported by the array will be registered for each fully qualified domain name specified. If neither fqdns nor service_principal_names is specified, the default service_principal_names are constructed using the computer_name and domain fields. Cannot be provided in combination with service_principal_names.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ActiveDirectoryPost

class pypureclient.flashblade.ActiveDirectoryPost(password, domain, user, global_catalog_servers=None, directory_servers=None, kerberos_servers=None, computer_name=None, join_ou=None, service_principal_names=None, encryption_types=None, fqdns=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(password, domain, user, global_catalog_servers=None, directory_servers=None, kerberos_servers=None, computer_name=None, join_ou=None, service_principal_names=None, encryption_types=None, fqdns=None)
Keyword Arguments

  • global_catalog_servers (list[str]) – A list of global catalog servers that will be used for lookups related to user authorization. Accepted server formats are IP address and DNS name with optional @domain suffix. If the suffix is ommited, the joined domain is assumed. All specified servers must be registered to the domain appropriately in the array’s configured DNS and will only be communicated with over the secure LDAP (LDAPS) protocol. The specified list can have a maximum length of 50.

  • directory_servers (list[str]) – A list of directory servers that will be used for lookups related to user authorization. Accepted server formats are IP address and DNS name. All specified servers must be registered to the domain appropriately in the array’s configured DNS and will only be communicated with over the secure LDAP (LDAPS) protocol. If not specified, servers are resolved for the domain in DNS. The specified list can have a maximum length of 5.

  • kerberos_servers (list[str]) – A list of key distribution servers to use for Kerberos protocol. Accepted server formats are IP address and DNS name. All specified servers must be registered to the domain appropriately in the array’s configured DNS. If not specified, servers are resolved for the domain in DNS. The specified list can have a maximum length of 5.

  • computer_name (str) – The common name of the computer account to be created in the Active Directory domain. If not specified, defaults to the name of the Active Directory configuration.

  • join_ou (str) – The relative distinguished name of the organizational unit in which the computer account should be created when joining the domain. Cannot be provided if using an existing machine account. If not specified, defaults to CN=Computers.

  • password (str, required) – The login password of the user with privileges to create the computer account in the domain. If using an existing computer account, the user must have privileges to read attributes from the computer account and reset the password on that account. This is not persisted on the array.

  • domain (str, required) – The Active Directory domain to join.

  • service_principal_names (list[str]) – A list of service principal names to register for the machine account, which can be used for the creation of keys for Kerberos authentication. If neither service_principal_names nor fqdns is specified, the default service_principal_names are constructed using the computer_name and domain fields. Cannot be provided in combination with fqdns. Cannot be provided if using an existing machine account.

  • encryption_types (list[str]) – The encryption types that will be supported for use by clients for Kerberos authentication. Defaults to aes256-cts-hmac-sha1-96. Valid values include aes256-cts-hmac-sha1-96, aes128-cts-hmac-sha1-96, and arcfour-hmac. Cannot be provided if using an existing machine account.

  • fqdns (list[str]) – A list of fully qualified domain names to use to register service principal names for the machine account. If specified, every service principal that is supported by the array will be registered for each fully qualified domain name specified. If neither fqdns nor service_principal_names is specified, the default service_principal_names are constructed using the computer_name and domain fields. Cannot be provided in combination with service_principal_names. Cannot be provided if using an existing machine account.

  • user (str, required) – The login name of the user with privileges to create the computer account in the domain. If using an existing computer account, the user must have privileges to read attributes from the computer account and reset the password on that account. This is not persisted on the array.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Admin

class pypureclient.flashblade.Admin(name=None, id=None, public_key=None, role=None, api_token=None, lockout_remaining=None, is_local=None, locked=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, public_key=None, role=None, api_token=None, lockout_remaining=None, is_local=None, locked=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • public_key (str) – Public key for SSH access. Supported key types are Ed25519 and RSA.

  • role (Reference) – A reference to this administrator’s management role.

  • api_token (ApiToken) –

  • lockout_remaining (int) – The remaining lockout period, in milliseconds, if the user is locked out. This field is only visible to array_admin roles. For all other users, the value is always null.

  • is_local (bool) – Returns a value of true if the user is local to the machine, otherwise false.

  • locked (bool) – Returns a value of true if the user is currently locked out, otherwise false. Can be patched to false to unlock a user. This field is only visible to array_admin roles. For all other users, the value is always null.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

AdminApiToken

class pypureclient.flashblade.AdminApiToken(api_token=None, admin=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(api_token=None, admin=None)
Keyword Arguments

  • api_token (ApiToken) –

  • admin (Reference) – A reference to the admin to whom this token belongs.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

AdminCache

class pypureclient.flashblade.AdminCache(name=None, id=None, role=None, time=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, role=None, time=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • role (FixedReference) – A reference to the role of this user.

  • time (int) – Time the role was cached in milliseconds since UNIX epoch.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

AdminPatch

class pypureclient.flashblade.AdminPatch(public_key=None, old_password=None, password=None, role=None, locked=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(public_key=None, old_password=None, password=None, role=None, locked=None)
Keyword Arguments

  • public_key (str) – Public key for SSH access. Supported key types are Ed25519 and RSA.

  • old_password (str) – Old user password.

  • password (str) – New user password.

  • role (ReferenceWritable) – A reference to this administrator’s management role. This may only be modified for non-built-in users for whom is_local is true.

  • locked (bool) – If set to false, the specified user is unlocked. Setting to true is not allowed.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

AdminPost

class pypureclient.flashblade.AdminPost(public_key=None, password=None, role=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(public_key=None, password=None, role=None)
Keyword Arguments

  • public_key (str) – Public key for SSH access. Supported key types include Ed25519 and RSA.

  • password (str) – New user password.

  • role (ReferenceWritable) – A reference to this administrator’s management role.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

AdminSetting

class pypureclient.flashblade.AdminSetting(lockout_duration=None, min_password_length=None, max_login_attempts=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(lockout_duration=None, min_password_length=None, max_login_attempts=None)
Keyword Arguments

  • lockout_duration (int) – The lockout duration, in milliseconds, if a user has reached the maximum number of login attempts. Ranges from 1 second to 90 days. Default value is null. Use 0 to reset the value to null.

  • min_password_length (int) – The minimum password length. If not specified, defaults to 1 character.

  • max_login_attempts (int) – The maximum number of failed login attempts allowed before the user is locked out. Default value is null. Use 0 to reset the value to null.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Alert

class pypureclient.flashblade.Alert(name=None, id=None, severity=None, summary=None, variables=None, code=None, knowledge_base_url=None, created=None, notified=None, component_name=None, description=None, index=None, component_type=None, flagged=None, action=None, state=None, updated=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, severity=None, summary=None, variables=None, code=None, knowledge_base_url=None, created=None, notified=None, component_name=None, description=None, index=None, component_type=None, flagged=None, action=None, state=None, updated=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • severity (str) – Severity of the alert. Valid values are info, warning, and critical.

  • summary (str) – The summary of the alert.

  • variables (dict(str, str)) – Key-value pairs of additional information of the alert.

  • code (int) – Alert code.

  • knowledge_base_url (str) – URL of the relevant Knowledge Base page.

  • created (int) – The creation timestamp of the alert.

  • notified (int) – The last notification timestamp of the alert.

  • component_name (str) – The component name of the alert.

  • description (str) – The description of the alert.

  • index (int) – The unique index of the alert.

  • component_type (str) – The component type of the alert.

  • flagged (bool) – Flagged state of the alert.

  • action (str) – The action of the alert.

  • state (str) – The current state of the alert. Valid values are open, closing, closed, and waiting to downgrade.

  • updated (int) – The last updated timestamp of the alert.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

AlertWatcher

class pypureclient.flashblade.AlertWatcher(name=None, id=None, minimum_notification_severity=None, enabled=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, minimum_notification_severity=None, enabled=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • minimum_notification_severity (str) – The minimum severity that an alert must have in order for emails to be sent to the watcher. Possible values include info, warning, and critical.

  • enabled (bool) – Is email notification enabled? If not specified, defaults to true.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

AlertWatcherPost

class pypureclient.flashblade.AlertWatcherPost(minimum_notification_severity=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(minimum_notification_severity=None)
Keyword Arguments

minimum_notification_severity (str) – The minimum severity that an alert must have in order for emails to be sent to the watcher. Possible values include info, warning, and critical. If not specified, defaults to info.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ApiClient

class pypureclient.flashblade.ApiClient(name=None, id=None, public_key=None, max_role=None, key_id=None, enabled=None, issuer=None, access_token_ttl_in_ms=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, public_key=None, max_role=None, key_id=None, enabled=None, issuer=None, access_token_ttl_in_ms=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • public_key (str) – The API client’s PEM formatted (Base64 encoded) RSA public key.

  • max_role (FixedReference) – The maximum role allowed for ID Tokens issued by this API client. The bearer of an access token will be authorized to perform actions within the intersection of this max_role and the role of the array user specified as the JWT sub (subject) claim. The max_role field is a reference to a role. Valid role`s are `readonly, ops_admin, array_admin, and storage_admin. Users with the readonly (Read Only) role can perform operations that convey the state of the array. Read Only users cannot alter the state of the array. Users with the ops_admin (Ops Admin) role can perform the same operations as Read Only users plus enable and disable remote assistance sessions. Ops Admin users cannot alter the state of the array. Users with the storage_admin (Storage Admin) role can perform the same operations as Read Only users plus storage related operations, such as administering file systems, snapshots, and buckets. Storage Admin users cannot perform operations that deal with global and system configurations. Users with the array_admin (Array Admin) role can perform the same operations as Storage Admin users plus array-wide changes dealing with global and system configurations. In other words, Array Admin users can perform all operations.

  • key_id (str) – The unique identifier for the associated public key of this API client. This string must match the JWT kid (key ID) claim in ID Tokens issued for this API client.

  • enabled (bool) – If true, the API client is permitted to exchange ID Tokens for access tokens. API clients are disabled by default.

  • issuer (str) – The name of the identity provider that will be issuing ID Tokens for this API client. This string represents the JWT iss (issuer) claim in ID Tokens issued for this API client.

  • access_token_ttl_in_ms (int) – The TTL (Time To Live) duration for which the exchanged access token is valid. Measured in milliseconds.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ApiClientsPost

class pypureclient.flashblade.ApiClientsPost(public_key, max_role, issuer=None, access_token_ttl_in_ms=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(public_key, max_role, issuer=None, access_token_ttl_in_ms=None)
Keyword Arguments

  • public_key (str, required) – The API client’s PEM formatted (Base64 encoded) RSA public key. It must include the —–BEGIN PUBLIC KEY—– and —–END PUBLIC KEY—– lines.

  • max_role (ReferenceWritable, required) – The maximum role allowed for ID Tokens issued by this API client. The bearer of an access token will be authorized to perform actions within the intersection of this max_role and the role of the array user specified as the JWT sub (subject) claim. The max_role field is a reference to a role. Valid role`s are `readonly, ops_admin, array_admin, and storage_admin. Users with the readonly (Read Only) role can perform operations that convey the state of the array. Read Only users cannot alter the state of the array. Users with the ops_admin (Ops Admin) role can perform the same operations as Read Only users plus enable and disable remote assistance sessions. Ops Admin users cannot alter the state of the array. Users with the storage_admin (Storage Admin) role can perform the same operations as Read Only users plus storage related operations, such as administering volumes, hosts, and host groups. Storage Admin users cannot perform operations that deal with global and system configurations. Users with the array_admin (Array Admin) role can perform the same operations as Storage Admin users plus array-wide changes dealing with global and system configurations. In other words, Array Admin users can perform all operations.

  • issuer (str) – The name of the identity provider that will be issuing ID Tokens for this API client. The iss claim in the JWT issued must match this string. If not specified, defaults to the API client name.

  • access_token_ttl_in_ms (int) – The TTL (Time To Live) duration for which the exchanged access token is valid. Measured in milliseconds. If not specified, defaults to 86400000.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ApiToken

class pypureclient.flashblade.ApiToken(expires_at=None, created_at=None, token=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(expires_at=None, created_at=None, token=None)
Keyword Arguments

  • expires_at (int) – Expiration time in milliseconds since the UNIX epoch.

  • created_at (int) – Creation time in milliseconds since the UNIX epoch.

  • token (str) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ApiVersion

class pypureclient.flashblade.ApiVersion(versions=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(versions=None)
Keyword Arguments

versions (list[str]) – A list of supported API versions.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Array

class pypureclient.flashblade.Array(name=None, id=None, network_access_policy=None, os=None, banner=None, eradication_config=None, ntp_servers=None, as_of=None, time_zone=None, default_inbound_tls_policy=None, security_update=None, smb_mode=None, version=None, revision=None, product_type=None, encryption=None, idle_timeout=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, network_access_policy=None, os=None, banner=None, eradication_config=None, ntp_servers=None, as_of=None, time_zone=None, default_inbound_tls_policy=None, security_update=None, smb_mode=None, version=None, revision=None, product_type=None, encryption=None, idle_timeout=None)
Keyword Arguments

  • name (str) – A name chosen by the user. Can be changed. Must be locally unique.

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • network_access_policy (FixedReference) – The network access policy governing which clients are allowed or denied access to different array interfaces.

  • os (str) – Valid values are Purity//FA and Purity//FB.

  • banner (str) – A string to be shown when logging in to the array.

  • eradication_config (ArrayEradicationConfig) –

  • ntp_servers (list[str]) –

  • as_of (int) – Array time in milliseconds since UNIX epoch.

  • time_zone (str) – The time zone to use for the array. In particular this affects the CLI formatting and the default snapshot policy time zone.

  • default_inbound_tls_policy (ReferenceWritable) – The default TLS policy governing inbound traffic from clients accessing the array. This TLS policy will be applied for any IP addresses on the system that do not have a specific policy applied to them at a more granular level.

  • security_update (str) – The name of the installed security update that currently applies to the system. This field will be null if either no security update has been installed, or if the most recently installed security update is no longer needed by the current FlashBlade software due to the current software fully incorporating the update.

  • smb_mode (str) – The current SMB mode of the array. This controls the type of authentication that is used by the array for SMB. Possible values include ad-auto, ad-rfc2307, guest, and native. Modifying this value requires the assistance of Pure Storage Support.

  • version (str) –

  • revision (str) –

  • product_type (str) – For FlashBlade//S arrays, the value is determined by the blades in the system. The value will be FlashBlade for all older arrays. Valid values are FlashBlade, FlashBlade//S, FlashBlade//S200, and FlashBladeS500.

  • encryption (ArrayEncryption) –

  • idle_timeout (int) – Idle timeout in milliseconds. Valid values are in the range of 300000 and 10800000. Setting this value to 0 disables timeouts.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ArrayConnection

class pypureclient.flashblade.ArrayConnection(id=None, context=None, replication_addresses=None, throttle=None, encrypted=None, os=None, management_address=None, ca_certificate_group=None, remote=None, type=None, version=None, status=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(id=None, context=None, replication_addresses=None, throttle=None, encrypted=None, os=None, management_address=None, ca_certificate_group=None, remote=None, type=None, version=None, status=None)
Keyword Arguments

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • context (Reference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • replication_addresses (list[str]) – IP addresses and/or FQDNs of the target arrays. Settable on POST only. If not set on POST, will be set to all the replication addresses available on the target array at the time of the POST.

  • throttle (Throttle) –

  • encrypted (bool) – If this is set to true, then all customer data replicated over the connection will be sent over an encrypted connection using TLS, or will not be sent if a secure connection cannot be established. If this is set to false, then all customer data replicated over the connection will be sent over an unencrypted connection. Defaults to false.

  • os (str) – The operating system of the connected array.

  • management_address (str) – Management address of the target array. Settable on POST only.

  • ca_certificate_group (FixedReference) – The group of CA certificates that can be used, in addition to well-known Certificate Authority certificates, in order to establish a secure connection to the target array. Defaults to a reference to the _default_replication_certs group if secure_connection is true, or null otherwise.

  • remote (FixedReference) – The remote array.

  • type (str) – The type of connection. Valid values include async-replication and fleet-management.

  • version (str) – The version of the target array.

  • status (str) – Status of the connection. Valid values include connected, partially_connected, connecting, and incompatible. connected - The connection is OK. partially_connected - Some replication addresses are working, but others are not. connecting - No connection exists and the array is trying to reconnect. incompatible - The target array is not compatible.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ArrayConnectionKey

class pypureclient.flashblade.ArrayConnectionKey(expires=None, connection_key=None, created=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(expires=None, connection_key=None, created=None)
Keyword Arguments

  • expires (int) – Expiration time in milliseconds since UNIX epoch.

  • connection_key (str) – Connection-key, used on another array to connect to this array. After creation, listing will only show ****.

  • created (int) – Creation time in milliseconds since UNIX epoch.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ArrayConnectionPath

class pypureclient.flashblade.ArrayConnectionPath(id=None, context=None, destination=None, source=None, remote=None, type=None, status_details=None, status=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(id=None, context=None, destination=None, source=None, remote=None, type=None, status_details=None, status=None)
Keyword Arguments

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • context (Reference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • destination (str) – IP address with the port of the target array.

  • source (str) – IP address of the source array.

  • remote (FixedReference) – The remote array.

  • type (str) – The type of path. Valid values include async-replication and fleet-management.

  • status_details (str) – Additional information describing any issues encountered when connecting, or null if the status is connected.

  • status (str) – Status of the connection. Valid values are connected and connecting. connected - The connection is OK. connecting - No connection exists and the array is trying to reconnect.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ArrayConnectionPost

class pypureclient.flashblade.ArrayConnectionPost(id=None, context=None, replication_addresses=None, throttle=None, encrypted=None, os=None, management_address=None, ca_certificate_group=None, remote=None, type=None, version=None, status=None, connection_key=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(id=None, context=None, replication_addresses=None, throttle=None, encrypted=None, os=None, management_address=None, ca_certificate_group=None, remote=None, type=None, version=None, status=None, connection_key=None)
Keyword Arguments

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • context (Reference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • replication_addresses (list[str]) – IP addresses and/or FQDNs of the target arrays. Settable on POST only. If not set on POST, will be set to all the replication addresses available on the target array at the time of the POST.

  • throttle (Throttle) –

  • encrypted (bool) – If this is set to true, then all customer data replicated over the connection will be sent over an encrypted connection using TLS, or will not be sent if a secure connection cannot be established. If this is set to false, then all customer data replicated over the connection will be sent over an unencrypted connection. Defaults to false.

  • os (str) – The operating system of the connected array.

  • management_address (str) – Management address of the target array. Settable on POST only.

  • ca_certificate_group (FixedReference) – The group of CA certificates that can be used, in addition to well-known Certificate Authority certificates, in order to establish a secure connection to the target array. Defaults to a reference to the _default_replication_certs group if secure_connection is true, or null otherwise.

  • remote (FixedReference) – The remote array.

  • type (str) – The type of connection. Valid values include async-replication and fleet-management.

  • version (str) – The version of the target array.

  • status (str) – Status of the connection. Valid values include connected, partially_connected, connecting, and incompatible. connected - The connection is OK. partially_connected - Some replication addresses are working, but others are not. connecting - No connection exists and the array is trying to reconnect. incompatible - The target array is not compatible.

  • connection_key (str) – The connection key of the target array. Settable on POST only.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ArrayEncryption

class pypureclient.flashblade.ArrayEncryption(data_at_rest=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(data_at_rest=None)
Keyword Arguments

data_at_rest (ArrayEncryptionDataAtRest) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ArrayEncryptionDataAtRest

class pypureclient.flashblade.ArrayEncryptionDataAtRest(algorithms=None, entropy_source=None, enabled=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(algorithms=None, entropy_source=None, enabled=None)
Keyword Arguments

  • algorithms (list[str]) – The algorithms used to encrypt data at rest on the array.

  • entropy_source (str) – The entropy source used to generate the Data at Rest Encryption key on the array.

  • enabled (bool) – Returns a value of true if Data at Rest Encryption is enabled.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ArrayEradicationConfig

class pypureclient.flashblade.ArrayEradicationConfig(eradication_delay=None, manual_eradication=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(eradication_delay=None, manual_eradication=None)
Keyword Arguments

  • eradication_delay (int) – The file eradication delay is in milliseconds. Automatically eradicate destroyed filesystems and snapshots after the delay time. Valid values are 86400000 and any multiple of 86400000 in the range of 86400000 and 2592000000. Any other values will be rounded down to the nearest multiple of 86400000.

  • manual_eradication (str) – Manual eradication status is applied on the array level. If status is all-disabled, you cannot eradicate buckets and file systems. If status is file-disabled then you can not eradicate files systems. If status is object-disabled then you can not eradicate buckets. If status is all-enabled then you can eradicate file systems and buckets. Values include all-enabled, file-disabled, object-disabled, and all-disabled.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ArrayFactoryResetToken

class pypureclient.flashblade.ArrayFactoryResetToken(name=None, token=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, token=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • token (int) – A random 7-digit number required as input to perform a factory reset of the array.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ArrayHttpSpecificPerformance

class pypureclient.flashblade.ArrayHttpSpecificPerformance(name=None, id=None, context=None, read_files_per_sec=None, others_per_sec=None, usec_per_write_file_op=None, usec_per_other_op=None, write_dirs_per_sec=None, usec_per_write_dir_op=None, time=None, usec_per_read_file_op=None, usec_per_read_dir_op=None, read_dirs_per_sec=None, write_files_per_sec=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, context=None, read_files_per_sec=None, others_per_sec=None, usec_per_write_file_op=None, usec_per_other_op=None, write_dirs_per_sec=None, usec_per_write_dir_op=None, time=None, usec_per_read_file_op=None, usec_per_read_dir_op=None, read_dirs_per_sec=None, write_files_per_sec=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • context (Reference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • read_files_per_sec (float) – Read file requests processed per second.

  • others_per_sec (float) – Other operations processed per second.

  • usec_per_write_file_op (float) – Average time, measured in microseconds, it takes the array to process a write file request.

  • usec_per_other_op (float) – Average time, measured in microseconds, it takes the array to process other operations.

  • write_dirs_per_sec (float) – Write directory requests processed per second.

  • usec_per_write_dir_op (float) – Average time, measured in microseconds, it takes the array to process a write directory request.

  • time (int) – Sample time in milliseconds since UNIX epoch.

  • usec_per_read_file_op (float) – Average time, measured in microseconds, it takes the array to process a read file request.

  • usec_per_read_dir_op (float) – Average time, measured in microseconds, it takes the array to process a read directory request.

  • read_dirs_per_sec (float) – Read directory requests processed per second.

  • write_files_per_sec (float) – Write file requests processed per second.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ArrayHttpSpecificPerformanceGet

class pypureclient.flashblade.ArrayHttpSpecificPerformanceGet(continuation_token=None, total_item_count=None, errors=None, items=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(continuation_token=None, total_item_count=None, errors=None, items=None)
Keyword Arguments

  • continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation_token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation_token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

  • total_item_count (int) – Total number of items after applying filter params.

  • errors (list[ErrorContextResponseErrors]) – The list of errors encountered when attempting to perform an operation.

  • items (list[ArrayHttpSpecificPerformance]) – A list of http specific array performance metrics objects.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ArrayNfsSpecificPerformance

class pypureclient.flashblade.ArrayNfsSpecificPerformance(name=None, id=None, context=None, aggregate_file_metadata_creates_per_sec=None, aggregate_usec_per_file_metadata_read_op=None, aggregate_file_metadata_modifies_per_sec=None, pathconfs_per_sec=None, usec_per_mkdir_op=None, setattrs_per_sec=None, reads_per_sec=None, usec_per_access_op=None, usec_per_lookup_op=None, usec_per_readlink_op=None, fsinfos_per_sec=None, usec_per_readdir_op=None, aggregate_other_per_sec=None, readlinks_per_sec=None, usec_per_remove_op=None, usec_per_readdirplus_op=None, usec_per_rename_op=None, usec_per_create_op=None, usec_per_pathconf_op=None, links_per_sec=None, usec_per_rmdir_op=None, fsstats_per_sec=None, usec_per_read_op=None, usec_per_fsinfo_op=None, usec_per_getattr_op=None, aggregate_file_metadata_reads_per_sec=None, usec_per_fsstat_op=None, usec_per_link_op=None, usec_per_setattr_op=None, aggregate_usec_per_file_metadata_modify_op=None, writes_per_sec=None, aggregate_share_metadata_reads_per_sec=None, symlinks_per_sec=None, usec_per_symlink_op=None, usec_per_write_op=None, aggregate_usec_per_other_op=None, readdirpluses_per_sec=None, removes_per_sec=None, aggregate_usec_per_file_metadata_create_op=None, renames_per_sec=None, creates_per_sec=None, accesses_per_sec=None, lookups_per_sec=None, getattrs_per_sec=None, readdirs_per_sec=None, mkdirs_per_sec=None, rmdirs_per_sec=None, time=None, aggregate_usec_per_share_metadata_read_op=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, context=None, aggregate_file_metadata_creates_per_sec=None, aggregate_usec_per_file_metadata_read_op=None, aggregate_file_metadata_modifies_per_sec=None, pathconfs_per_sec=None, usec_per_mkdir_op=None, setattrs_per_sec=None, reads_per_sec=None, usec_per_access_op=None, usec_per_lookup_op=None, usec_per_readlink_op=None, fsinfos_per_sec=None, usec_per_readdir_op=None, aggregate_other_per_sec=None, readlinks_per_sec=None, usec_per_remove_op=None, usec_per_readdirplus_op=None, usec_per_rename_op=None, usec_per_create_op=None, usec_per_pathconf_op=None, links_per_sec=None, usec_per_rmdir_op=None, fsstats_per_sec=None, usec_per_read_op=None, usec_per_fsinfo_op=None, usec_per_getattr_op=None, aggregate_file_metadata_reads_per_sec=None, usec_per_fsstat_op=None, usec_per_link_op=None, usec_per_setattr_op=None, aggregate_usec_per_file_metadata_modify_op=None, writes_per_sec=None, aggregate_share_metadata_reads_per_sec=None, symlinks_per_sec=None, usec_per_symlink_op=None, usec_per_write_op=None, aggregate_usec_per_other_op=None, readdirpluses_per_sec=None, removes_per_sec=None, aggregate_usec_per_file_metadata_create_op=None, renames_per_sec=None, creates_per_sec=None, accesses_per_sec=None, lookups_per_sec=None, getattrs_per_sec=None, readdirs_per_sec=None, mkdirs_per_sec=None, rmdirs_per_sec=None, time=None, aggregate_usec_per_share_metadata_read_op=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • context (Reference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • aggregate_file_metadata_creates_per_sec (float) – Sum of file-level or directory-level create-like metadata requests per second. Includes CREATE, LINK, MKDIR, and SYMLINK.

  • aggregate_usec_per_file_metadata_read_op (float) – Average time, measured in microseconds, it takes the array to process a file-level or directory-level read-like metadata request. Includes GETATTR, LOOKUP, PATHCONF, READDIR, READDIRPLUS, and READLINK.

  • aggregate_file_metadata_modifies_per_sec (float) – Sum of file-level or directory-level modify-like and delete-like metadata requests per second. Includes REMOVE, RENAME, RMDIR, and SETATTR.

  • pathconfs_per_sec (float) – PATHCONF requests processed per second.

  • usec_per_mkdir_op (float) – Average time, measured in microseconds, it takes the array to process a MKDIR request.

  • setattrs_per_sec (float) – SETATTR requests processed per second.

  • reads_per_sec (float) – READ requests processed per second.

  • usec_per_access_op (float) – Average time, measured in microseconds, it takes the array to process an ACCESS request.

  • usec_per_lookup_op (float) – Average time, measured in microseconds, it takes the array to process a LOOKUP request.

  • usec_per_readlink_op (float) – Average time, measured in microseconds, it takes the array to process a READLINK request.

  • fsinfos_per_sec (float) – FSINFO requests processed per second.

  • usec_per_readdir_op (float) – Average time, measured in microseconds, it takes the array to process a READDIR request.

  • aggregate_other_per_sec (float) – Sum of all other requests processed per second. This includes COMMIT, MKNOD, NULL, NLM operations, and operations which are supported for NFSv4.1 but not NFSv3.

  • readlinks_per_sec (float) – READLINK requests processed per second.

  • usec_per_remove_op (float) – Average time, measured in microseconds, it takes the array to process a REMOVE request.

  • usec_per_readdirplus_op (float) – Average time, measured in microseconds, it takes the array to process a READDIRPLUS request.

  • usec_per_rename_op (float) – Average time, measured in microseconds, it takes the array to process a RENAME request.

  • usec_per_create_op (float) – Average time, measured in microseconds, it takes the array to process a CREATE request.

  • usec_per_pathconf_op (float) – Average time, measured in microseconds, it takes the array to process a PATHCONF request.

  • links_per_sec (float) – LINK requests processed per second.

  • usec_per_rmdir_op (float) – Average time, measured in microseconds, it takes the array to process an RMDIR request.

  • fsstats_per_sec (float) – FSSTAT requests processed per second.

  • usec_per_read_op (float) – Average time, measured in microseconds, it takes the array to process a READ request.

  • usec_per_fsinfo_op (float) – Average time, measured in microseconds, it takes the array to process an FSINFO request.

  • usec_per_getattr_op (float) – Average time, measured in microseconds, it takes the array to process a GETATTR request.

  • aggregate_file_metadata_reads_per_sec (float) – Sum of file-level or directory-level read-like metadata requests per second. Includes GETATTR, LOOKUP, PATHCONF, READDIR, READDIRPLUS, and READLINK.

  • usec_per_fsstat_op (float) – Average time, measured in microseconds, it takes the array to process an FSSTAT request.

  • usec_per_link_op (float) – Average time, measured in microseconds, it takes the array to process a LINK request.

  • usec_per_setattr_op (float) – Average time, measured in microseconds, it takes the array to process a SETATTR request.

  • aggregate_usec_per_file_metadata_modify_op (float) – Average time, measured in microseconds, it takes the array to process a file-level or directory-level modify-like or delete-like metadata request. Includes REMOVE, RENAME, RMDIR, and SETATTR.

  • writes_per_sec (float) – WRITE requests processed per second.

  • aggregate_share_metadata_reads_per_sec (float) – Sum of share-level read-like metadata requests per second. Includes ACCESS, FSINFO, and FSSTAT.

  • symlinks_per_sec (float) – SYMLINK requests processed per second.

  • usec_per_symlink_op (float) – Average time, measured in microseconds, it takes the array to process a SYMLINK request.

  • usec_per_write_op (float) – Average time, measured in microseconds, it takes the array to process a WRITE request.

  • aggregate_usec_per_other_op (float) – Average time, measured in microseconds, it takes the array to process all other requests. This includes COMMIT, MKNOD, NULL, NLM operations, and operations which are supported for NFSv4.1 but not NFSv3.

  • readdirpluses_per_sec (float) – READDIRPLUS requests processed per second.

  • removes_per_sec (float) – REMOVE requests processed per second.

  • aggregate_usec_per_file_metadata_create_op (float) – Average time, measured in microseconds, it takes the array to process a file-level or directory-level create-like metadata request. Includes CREATE, LINK, MKDIR, and SYMLINK.

  • renames_per_sec (float) – RENAME requests processed per second.

  • creates_per_sec (float) – CREATE requests processed per second.

  • accesses_per_sec (float) – ACCESS requests processed per second.

  • lookups_per_sec (float) – LOOKUP requests processed per second.

  • getattrs_per_sec (float) – GETATTR requests processed per second.

  • readdirs_per_sec (float) – READDIR requests processed per second.

  • mkdirs_per_sec (float) – MKDIR requests processed per second.

  • rmdirs_per_sec (float) – RMDIR requests processed per second.

  • time (int) – Sample time in milliseconds since UNIX epoch.

  • aggregate_usec_per_share_metadata_read_op (float) – Average time, measured in microseconds, it takes the array to process a share-level read-like metadata request. Includes ACCESS, FSINFO, and FSSTAT.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ArrayNfsSpecificPerformanceGet

class pypureclient.flashblade.ArrayNfsSpecificPerformanceGet(continuation_token=None, total_item_count=None, errors=None, items=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(continuation_token=None, total_item_count=None, errors=None, items=None)
Keyword Arguments

  • continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation_token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation_token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

  • total_item_count (int) – Total number of items after applying filter params.

  • errors (list[ErrorContextResponseErrors]) – The list of errors encountered when attempting to perform an operation.

  • items (list[ArrayNfsSpecificPerformance]) – A list of NFS specific array performance metrics objects.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ArrayPerformance

class pypureclient.flashblade.ArrayPerformance(name=None, id=None, context=None, read_bytes_per_sec=None, others_per_sec=None, reads_per_sec=None, write_bytes_per_sec=None, bytes_per_write=None, usec_per_other_op=None, writes_per_sec=None, time=None, bytes_per_op=None, usec_per_write_op=None, bytes_per_read=None, usec_per_read_op=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, context=None, read_bytes_per_sec=None, others_per_sec=None, reads_per_sec=None, write_bytes_per_sec=None, bytes_per_write=None, usec_per_other_op=None, writes_per_sec=None, time=None, bytes_per_op=None, usec_per_write_op=None, bytes_per_read=None, usec_per_read_op=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • context (Reference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • read_bytes_per_sec (float) – Bytes read per second.

  • others_per_sec (float) – Other operations processed per second.

  • reads_per_sec (float) – Read requests processed per second.

  • write_bytes_per_sec (float) – Bytes written per second.

  • bytes_per_write (float) – Average write size in bytes per write operation.

  • usec_per_other_op (float) – Average time, measured in microseconds, it takes the array to process other operations.

  • writes_per_sec (float) – Write requests processed per second.

  • time (int) – Sample time in milliseconds since UNIX epoch.

  • bytes_per_op (float) – Average operation size (read bytes+write bytes/read ops+write ops).

  • usec_per_write_op (float) – Average time, measured in microseconds, it takes the array to process a write request.

  • bytes_per_read (float) – Average read size in bytes per read operation.

  • usec_per_read_op (float) – Average time, measured in microseconds, it takes the array to process a read request.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ArrayPerformanceReplicationGetResp

class pypureclient.flashblade.ArrayPerformanceReplicationGetResp(continuation_token=None, total_item_count=None, errors=None, items=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(continuation_token=None, total_item_count=None, errors=None, items=None)
Keyword Arguments

  • continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation_token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation_token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

  • total_item_count (int) – Total number of items after applying filter params.

  • errors (list[ErrorContextResponseErrors]) – The list of errors encountered when attempting to perform an operation.

  • items (list[RelationshipPerformanceReplication]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ArrayS3SpecificPerformance

class pypureclient.flashblade.ArrayS3SpecificPerformance(name=None, id=None, context=None, read_objects_per_sec=None, usec_per_write_bucket_op=None, write_buckets_per_sec=None, others_per_sec=None, usec_per_other_op=None, read_buckets_per_sec=None, usec_per_write_object_op=None, time=None, usec_per_read_bucket_op=None, usec_per_read_object_op=None, write_objects_per_sec=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, context=None, read_objects_per_sec=None, usec_per_write_bucket_op=None, write_buckets_per_sec=None, others_per_sec=None, usec_per_other_op=None, read_buckets_per_sec=None, usec_per_write_object_op=None, time=None, usec_per_read_bucket_op=None, usec_per_read_object_op=None, write_objects_per_sec=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • context (Reference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • read_objects_per_sec (float) – Read object requests processed per second.

  • usec_per_write_bucket_op (float) – Average time, measured in microseconds, it takes the array to process a write bucket request.

  • write_buckets_per_sec (float) – Write buckets requests processed per second.

  • others_per_sec (float) – Other operations processed per second.

  • usec_per_other_op (float) – Average time, measured in microseconds, it takes the array to process other operations.

  • read_buckets_per_sec (float) – Read buckets requests processed per second.

  • usec_per_write_object_op (float) – Average time, measured in microseconds, it takes the array to process a write object request.

  • time (int) – Sample time in milliseconds since UNIX epoch.

  • usec_per_read_bucket_op (float) – Average time, measured in microseconds, it takes the array to process a read bucket request.

  • usec_per_read_object_op (float) – Average time, measured in microseconds, it takes the array to process a read object request.

  • write_objects_per_sec (float) – Write object requests processed per second.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ArrayS3SpecificPerformanceGetResp

class pypureclient.flashblade.ArrayS3SpecificPerformanceGetResp(continuation_token=None, total_item_count=None, errors=None, items=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(continuation_token=None, total_item_count=None, errors=None, items=None)
Keyword Arguments

  • continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation_token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation_token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

  • total_item_count (int) – Total number of items after applying filter params.

  • errors (list[ErrorContextResponseErrors]) – The list of errors encountered when attempting to perform an operation.

  • items (list[ArrayS3SpecificPerformance]) – A list of S3 specific array performance metrics objects.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ArraySpace

class pypureclient.flashblade.ArraySpace(name=None, id=None, context=None, parity=None, time=None, space=None, capacity=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, context=None, parity=None, time=None, space=None, capacity=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • context (Reference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • parity (float) – A representation of data redundancy on the array. Data redundancy is rebuilt automatically by the system whenever parity is less than 1.0.

  • time (int) – Sample time in milliseconds since UNIX epoch.

  • space (Space) –

  • capacity (int) – Usable capacity in bytes.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Audit

class pypureclient.flashblade.Audit(name=None, id=None, subcommand=None, origin=None, user_interface=None, arguments=None, ip_address=None, time=None, user=None, command=None, user_agent=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, subcommand=None, origin=None, user_interface=None, arguments=None, ip_address=None, time=None, user=None, command=None, user_agent=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • subcommand (str) –

  • origin (FixedReference) –

  • user_interface (str) – The user interface through which the user session event was performed. Valid values are CLI, GUI, and REST.

  • arguments (str) –

  • ip_address (str) –

  • time (int) –

  • user (str) –

  • command (str) –

  • user_agent (str) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

AuditFileSystemsPoliciesPatch

class pypureclient.flashblade.AuditFileSystemsPoliciesPatch(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, log_targets=None, remove_log_targets=None, add_log_targets=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, log_targets=None, remove_log_targets=None, add_log_targets=None)
Keyword Arguments

  • name (str) – A name chosen by the user. Can be changed. Must be locally unique.

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • policy_type (str) – Type of the policy. Valid values include alert, audit, bucket-access, cross-origin-resource-sharing, network-access, nfs, object-access, smb-client, smb-share, snapshot, ssh-certificate-authority, and worm-data.

  • location (FixedReference) – Reference to the array where the policy is defined.

  • is_local (bool) – Whether the policy is defined on the local array.

  • enabled (bool) – If true, the policy is enabled. If not specified, defaults to true.

  • log_targets (list[Reference]) – List of targets which will be utilized for audit log storage. These may either be file system targets or remote syslog server targets.

  • remove_log_targets (list[Reference]) – The log targets which will be removed from the existing log_targets list for the audit policy. The remove_log_targets field can not be used with log_targets field.

  • add_log_targets (list[Reference]) – The log targets which will be added to the existing log_targets list for the audit policy. These new log targets will be appended to the end of the existing list. The add_log_targets field can not be used with log_targets field.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

AuditFileSystemsPoliciesPost

class pypureclient.flashblade.AuditFileSystemsPoliciesPost(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, log_targets=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, log_targets=None)
Keyword Arguments

  • name (str) – A name chosen by the user. Can be changed. Must be locally unique.

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • policy_type (str) – Type of the policy. Valid values include alert, audit, bucket-access, cross-origin-resource-sharing, network-access, nfs, object-access, smb-client, smb-share, snapshot, ssh-certificate-authority, and worm-data.

  • location (FixedReference) – Reference to the array where the policy is defined.

  • is_local (bool) – Whether the policy is defined on the local array.

  • enabled (bool) – If true, the policy is enabled. If not specified, defaults to true.

  • log_targets (list[Reference]) – List of targets which will be utilized for audit log storage. These may either be file system targets or remote syslog server targets.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

AuditFileSystemsPolicy

class pypureclient.flashblade.AuditFileSystemsPolicy(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, log_targets=None, context=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, log_targets=None, context=None)
Keyword Arguments

  • name (str) – A name chosen by the user. Can be changed. Must be locally unique.

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • policy_type (str) – Type of the policy. Valid values include alert, audit, bucket-access, cross-origin-resource-sharing, network-access, nfs, object-access, smb-client, smb-share, snapshot, ssh-certificate-authority, and worm-data.

  • location (FixedReference) – Reference to the array where the policy is defined.

  • is_local (bool) – Whether the policy is defined on the local array.

  • enabled (bool) – If true, the policy is enabled. If not specified, defaults to true.

  • log_targets (list[Reference]) – List of targets which will be utilized for audit log storage. These may either be file system targets or remote syslog server targets.

  • context (Reference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

AuditFileSystemsPolicyNoContext

class pypureclient.flashblade.AuditFileSystemsPolicyNoContext(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, log_targets=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, log_targets=None)
Keyword Arguments

  • name (str) – A name chosen by the user. Can be changed. Must be locally unique.

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • policy_type (str) – Type of the policy. Valid values include alert, audit, bucket-access, cross-origin-resource-sharing, network-access, nfs, object-access, smb-client, smb-share, snapshot, ssh-certificate-authority, and worm-data.

  • location (FixedReference) – Reference to the array where the policy is defined.

  • is_local (bool) – Whether the policy is defined on the local array.

  • enabled (bool) – If true, the policy is enabled. If not specified, defaults to true.

  • log_targets (list[Reference]) – List of targets which will be utilized for audit log storage. These may either be file system targets or remote syslog server targets.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Blade

class pypureclient.flashblade.Blade(name=None, id=None, raw_capacity=None, progress=None, details=None, status=None, target=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, raw_capacity=None, progress=None, details=None, status=None, target=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • raw_capacity (int) –

  • progress (float) –

  • details (str) –

  • status (str) – Valid values are critical, evacuated, evacuating, healthy, identifying, unhealthy, unknown, and unused.

  • target (str) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Bucket

class pypureclient.flashblade.Bucket(name=None, id=None, context=None, quota_limit=None, time_remaining_status=None, versioning=None, bucket_type=None, public_access_config=None, created=None, public_status=None, object_count=None, eradication_config=None, space=None, object_lock_config=None, time_remaining=None, destroyed=None, hard_limit_enabled=None, retention_lock=None, account=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, context=None, quota_limit=None, time_remaining_status=None, versioning=None, bucket_type=None, public_access_config=None, created=None, public_status=None, object_count=None, eradication_config=None, space=None, object_lock_config=None, time_remaining=None, destroyed=None, hard_limit_enabled=None, retention_lock=None, account=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • context (Reference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • quota_limit (int) – The effective quota limit applied against the size of the bucket, displayed in bytes. If unset, the bucket is unlimited in size.

  • time_remaining_status (str) – Status of the time_remaining field. calculating means the bucket is retention-based, has been destroyed and the time_remaining is being calculated by a background process legal-hold means the bucket is retention-based, has been destroyed and will never be eradicated, because an object with legal hold status was found inside. null otherwise, i.e. when either the bucket is not destroyed or it’s destroyed and the time_remaining has been determined.

  • versioning (str) – The versioning state for objects within the bucket. Valid values are none, enabled, and suspended.

  • bucket_type (str) – The bucket type for the bucket.

  • public_access_config (PublicAccessConfig) –

  • created (int) – Creation timestamp of the object.

  • public_status (str) – Bucket’s public status. Valid values include bucket-and-objects-not-public, only-authorized-users-of-this-account and public.

  • object_count (int) – The count of objects within the bucket.

  • eradication_config (BucketEradicationConfig) –

  • space (Space) – The space specification of the bucket.

  • object_lock_config (ObjectLockConfigResponse) –

  • time_remaining (int) – Time in milliseconds before the bucket is eradicated. null if not destroyed or legal hold was found or the remaining time until eradication is not known yet.

  • destroyed (bool) – Is the bucket destroyed?

  • hard_limit_enabled (bool) – If set to true, the bucket’s size, as defined by quota_limit, is used as a hard limit quota. If set to false, a hard limit quota will not be applied to the bucket, but soft quota alerts will still be sent if the bucket has a value set for quota_limit.

  • retention_lock (str) – If set to ratcheted, then object_lock_config.default_retention_mode cannot be changed if set to compliance. In this case, the value of object_lock_config.default_retention can only be increased and object_lock_config.default_retention_mode cannot be changed once set to compliance. Valid values are unlocked and ratcheted. Contact Pure Technical Services to change ratcheted to unlocked.

  • account (FixedReference) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

BucketAccessPolicy

class pypureclient.flashblade.BucketAccessPolicy(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, context=None, bucket=None, rules=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, context=None, bucket=None, rules=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • policy_type (str) – Type of the policy. Valid values include alert, audit, bucket-access, cross-origin-resource-sharing, network-access, nfs, object-access, smb-client, smb-share, snapshot, ssh-certificate-authority, and worm-data.

  • location (FixedReference) – Reference to the array where the policy is defined.

  • is_local (bool) – Whether the policy is defined on the local array.

  • enabled (bool) – If true, the policy is enabled. If not specified, defaults to true.

  • context (Reference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • bucket (FixedReference) – The bucket to which this policy belongs.

  • rules (list[BucketAccessPolicyRule]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

BucketAccessPolicyPost

class pypureclient.flashblade.BucketAccessPolicyPost(rules=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(rules=None)
Keyword Arguments

rules (list[BucketAccessPolicyRuleBulkManage]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

BucketAccessPolicyRule

class pypureclient.flashblade.BucketAccessPolicyRule(name=None, effect=None, resources=None, principals=None, actions=None, policy=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, effect=None, resources=None, principals=None, actions=None, policy=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • effect (str) – Effect of this rule. When allow, the rule allows the given actions to be performed on the given resources, subject to the given conditions. The only currently supported effect is allow.

  • resources (list[str]) – The list of resources which this rule applies to. The only currently supported resource is all objects in a bucket to which the parent policy belongs.

  • principals (BucketAccessPolicyRulePrincipal) – The principals to which this rule applies. Currently, only all principals are supported.

  • actions (list[str]) – The list of actions granted by this rule. Each included action may restrict other properties of the rule. The only currently supported action is s3:GetObject.

  • policy (FixedReference) – The policy to which this rule belongs.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

BucketAccessPolicyRuleBulkManage

class pypureclient.flashblade.BucketAccessPolicyRuleBulkManage(effect=None, resources=None, principals=None, actions=None, name=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(effect=None, resources=None, principals=None, actions=None, name=None)
Keyword Arguments

  • effect (str) – Effect of this rule. When allow, the rule allows the given actions to be performed on the given resources, subject to the given conditions. The only currently supported effect is allow.

  • resources (list[str]) – The list of resources which this rule applies to. The only currently supported resource is all objects in a bucket to which the parent policy belongs.

  • principals (BucketAccessPolicyRulePrincipal) – The principals to which this rule applies. Currently, only all principals are supported.

  • actions (list[str]) – The list of actions granted by this rule. Each included action may restrict other properties of the rule. The only currently supported action is s3:GetObject.

  • name (str) – Name of the object (e.g., a file system or snapshot).

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

BucketAccessPolicyRulePost

class pypureclient.flashblade.BucketAccessPolicyRulePost(effect=None, resources=None, principals=None, actions=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(effect=None, resources=None, principals=None, actions=None)
Keyword Arguments

  • effect (str) – Effect of this rule. When allow, the rule allows the given actions to be performed on the given resources, subject to the given conditions. The only currently supported effect is allow.

  • resources (list[str]) – The list of resources which this rule applies to. The only currently supported resource is all objects in a bucket to which the parent policy belongs.

  • principals (BucketAccessPolicyRulePrincipal) – The principals to which this rule applies. Currently, only all principals are supported.

  • actions (list[str]) – The list of actions granted by this rule. Each included action may restrict other properties of the rule. The only currently supported action is s3:GetObject.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

BucketAccessPolicyRulePrincipal

class pypureclient.flashblade.BucketAccessPolicyRulePrincipal(all=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(all=None)
Keyword Arguments

all (bool) – If true, the rule will apply to all object store users regardless of their origin or principal.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

BucketAccessPolicyRuleWithContext

class pypureclient.flashblade.BucketAccessPolicyRuleWithContext(name=None, effect=None, resources=None, principals=None, actions=None, policy=None, context=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, effect=None, resources=None, principals=None, actions=None, policy=None, context=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • effect (str) – Effect of this rule. When allow, the rule allows the given actions to be performed on the given resources, subject to the given conditions. The only currently supported effect is allow.

  • resources (list[str]) – The list of resources which this rule applies to. The only currently supported resource is all objects in a bucket to which the parent policy belongs.

  • principals (BucketAccessPolicyRulePrincipal) – The principals to which this rule applies. Currently, only all principals are supported.

  • actions (list[str]) – The list of actions granted by this rule. Each included action may restrict other properties of the rule. The only currently supported action is s3:GetObject.

  • policy (FixedReference) – The policy to which this rule belongs.

  • context (Reference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

BucketDefaults

class pypureclient.flashblade.BucketDefaults(quota_limit=None, hard_limit_enabled=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(quota_limit=None, hard_limit_enabled=None)
Keyword Arguments

  • quota_limit (str) – The value of this field will be used to configure the quota_limit field of newly created buckets associated with this object store account, if the bucket creation does not specify its own value. If set to an empty string (“”), the bucket default is unlimited in size. If not specified, defaults to unlimited.

  • hard_limit_enabled (bool) – The value of this field will be used to configure the hard_limit_enabled field of newly created buckets associated with this object store account, if the bucket creation does not specify its own value. If not specified, defaults to false.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

BucketDefaultsReadonly

class pypureclient.flashblade.BucketDefaultsReadonly(quota_limit=None, hard_limit_enabled=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(quota_limit=None, hard_limit_enabled=None)
Keyword Arguments

  • quota_limit (int) – The value of this field will be used to configure the quota_limit field of newly created buckets associated with this object store account, if the bucket creation does not specify its own value. If unset, the bucket default is unlimited in size.

  • hard_limit_enabled (bool) – The value of this field will be used to configure the hard_limit_enabled field of newly created buckets associated with this object store account, if the bucket creation does not specify its own value. If not specified, defaults to false.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

BucketEradicationConfig

class pypureclient.flashblade.BucketEradicationConfig(eradication_delay=None, eradication_mode=None, manual_eradication=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(eradication_delay=None, eradication_mode=None, manual_eradication=None)
Keyword Arguments

  • eradication_delay (int) – Minimum eradication delay in milliseconds. Automatically eradicate destroyed buckets after the delay time passes unless automatic eradication is delayed due to other configuration values.

  • eradication_mode (str) – The eradication mode of the bucket. If it’s permission-based the bucket can be eradicated based on user permissions. If it’s retention-based the bucket can never be eradicated as long as there are locked objects still being retained. Valid values are permission-based and retention-based.

  • manual_eradication (str) – The manual eradication status of the bucket. If disabled, the bucket cannot be eradicated after it has been destroyed, unless it is empty. If enabled, the bucket can be eradicated. Valid values are disabled and enabled.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

BucketPatch

class pypureclient.flashblade.BucketPatch(object_lock_config=None, quota_limit=None, destroyed=None, versioning=None, hard_limit_enabled=None, public_access_config=None, eradication_config=None, retention_lock=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(object_lock_config=None, quota_limit=None, destroyed=None, versioning=None, hard_limit_enabled=None, public_access_config=None, eradication_config=None, retention_lock=None)
Keyword Arguments

  • object_lock_config (ObjectLockConfigRequestBody) –

  • quota_limit (str) – The effective quota limit applied against the size of the bucket, displayed in bytes. If set to an empty string (“”), the bucket is unlimited in size.

  • destroyed (bool) – Is the bucket destroyed?

  • versioning (str) – The versioning state for objects within the bucket. Valid values are none, enabled, and suspended.

  • hard_limit_enabled (bool) – If set to true, the bucket’s size, as defined by quota_limit, is used as a hard limit quota. If set to false, a hard limit quota will not be applied to the bucket, but soft quota alerts will still be sent if the bucket has a value set for quota_limit.

  • public_access_config (PublicAccessConfig) –

  • eradication_config (BucketEradicationConfig) –

  • retention_lock (str) – If set to ratcheted, then object_lock_config.default_retention_mode cannot be changed if set to compliance. In this case, the value of object_lock_config.default_retention can only be increased and object_lock_config.default_retention_mode cannot be changed once set to compliance. Valid values are unlocked and ratcheted. Contact Pure Technical Services to change ratcheted to unlocked.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

BucketPerformance

class pypureclient.flashblade.BucketPerformance(name=None, id=None, read_bytes_per_sec=None, others_per_sec=None, reads_per_sec=None, write_bytes_per_sec=None, bytes_per_write=None, usec_per_other_op=None, writes_per_sec=None, time=None, bytes_per_op=None, usec_per_write_op=None, bytes_per_read=None, usec_per_read_op=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, read_bytes_per_sec=None, others_per_sec=None, reads_per_sec=None, write_bytes_per_sec=None, bytes_per_write=None, usec_per_other_op=None, writes_per_sec=None, time=None, bytes_per_op=None, usec_per_write_op=None, bytes_per_read=None, usec_per_read_op=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • read_bytes_per_sec (float) – Bytes read per second.

  • others_per_sec (float) – Other operations processed per second.

  • reads_per_sec (float) – Read requests processed per second.

  • write_bytes_per_sec (float) – Bytes written per second.

  • bytes_per_write (float) – Average write size in bytes per write operation.

  • usec_per_other_op (float) – Average time, measured in microseconds, it takes the array to process other operations.

  • writes_per_sec (float) – Write requests processed per second.

  • time (int) – Sample time in milliseconds since UNIX epoch.

  • bytes_per_op (float) – Average operation size (read bytes+write bytes/read ops+write ops).

  • usec_per_write_op (float) – Average time, measured in microseconds, it takes the array to process a write request.

  • bytes_per_read (float) – Average read size in bytes per read operation.

  • usec_per_read_op (float) – Average time, measured in microseconds, it takes the array to process a read request.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

BucketPost

class pypureclient.flashblade.BucketPost(object_lock_config=None, quota_limit=None, hard_limit_enabled=None, bucket_type=None, eradication_config=None, retention_lock=None, account=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(object_lock_config=None, quota_limit=None, hard_limit_enabled=None, bucket_type=None, eradication_config=None, retention_lock=None, account=None)
Keyword Arguments

  • object_lock_config (ObjectLockConfigRequestBody) –

  • quota_limit (str) – The effective quota limit applied against the size of the bucket, displayed in bytes. If set to an empty string (“”), the bucket is unlimited in size. If not specified, defaults to the value of bucket_defaults.quota_limit of the object store account this bucket is associated with.

  • hard_limit_enabled (bool) – If set to true, the bucket’s size, as defined by quota_limit, is used as a hard limit quota. If set to false, a hard limit quota will not be applied to the bucket, but soft quota alerts will still be sent if the bucket has a value set for quota_limit. If not specified, defaults to the value of bucket_defaults.hard_limit_enabled of the object store account this bucket is associated with.

  • bucket_type (str) – The bucket type for the bucket. Valid values are classic, and multi-site-writable. Default value is multi-site-writable.

  • eradication_config (BucketEradicationConfig) –

  • retention_lock (str) – If set to ratcheted, then object_lock_config.default_retention_mode cannot be changed if set to compliance. In this case, the value of object_lock_config.default_retention can only be increased and object_lock_config.default_retention_mode cannot be changed once set to compliance. Valid values are unlocked and ratcheted. If not specified, defaults to unlocked.

  • account (ReferenceWritable) – The account name for bucket creation.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

BucketReplicaLinkPost

class pypureclient.flashblade.BucketReplicaLinkPost(paused=None, cascading_enabled=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(paused=None, cascading_enabled=None)
Keyword Arguments

  • paused (bool) – Create link in the paused state? Defaults to false.

  • cascading_enabled (bool) – If set to true, objects replicated to this bucket via a replica link from another array will also be replicated by this link to the remote bucket. Defaults to false.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

BucketS3SpecificPerformance

class pypureclient.flashblade.BucketS3SpecificPerformance(name=None, id=None, read_objects_per_sec=None, usec_per_write_bucket_op=None, write_buckets_per_sec=None, others_per_sec=None, usec_per_other_op=None, read_buckets_per_sec=None, usec_per_write_object_op=None, time=None, usec_per_read_bucket_op=None, usec_per_read_object_op=None, write_objects_per_sec=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, read_objects_per_sec=None, usec_per_write_bucket_op=None, write_buckets_per_sec=None, others_per_sec=None, usec_per_other_op=None, read_buckets_per_sec=None, usec_per_write_object_op=None, time=None, usec_per_read_bucket_op=None, usec_per_read_object_op=None, write_objects_per_sec=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • read_objects_per_sec (float) – Read object requests processed per second.

  • usec_per_write_bucket_op (float) – Average time, measured in microseconds, it takes the array to process a write bucket request.

  • write_buckets_per_sec (float) – Write buckets requests processed per second.

  • others_per_sec (float) – Other operations processed per second.

  • usec_per_other_op (float) – Average time, measured in microseconds, it takes the array to process other operations.

  • read_buckets_per_sec (float) – Read buckets requests processed per second.

  • usec_per_write_object_op (float) – Average time, measured in microseconds, it takes the array to process a write object request.

  • time (int) – Sample time in milliseconds since UNIX epoch.

  • usec_per_read_bucket_op (float) – Average time, measured in microseconds, it takes the array to process a read bucket request.

  • usec_per_read_object_op (float) – Average time, measured in microseconds, it takes the array to process a read object request.

  • write_objects_per_sec (float) – Write object requests processed per second.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

BucketS3SpecificPerformanceGetResp

class pypureclient.flashblade.BucketS3SpecificPerformanceGetResp(continuation_token=None, total_item_count=None, total=None, items=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(continuation_token=None, total_item_count=None, total=None, items=None)
Keyword Arguments

  • continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation_token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation_token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

  • total_item_count (int) – Total number of items after applying filter params.

  • total (list[BucketS3SpecificPerformance]) – Total of all records after filtering. If total_only query param is true, then no items will be returned.

  • items (list[BucketS3SpecificPerformance]) – A list of S3 specific bucket performance metrics objects.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

BuiltIn

class pypureclient.flashblade.BuiltIn(name=None, id=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

BuiltInNoId

class pypureclient.flashblade.BuiltInNoId(name=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None)
Keyword Arguments

name (str) – Name of the object (e.g., a file system or snapshot).

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

BuiltInRelationship

class pypureclient.flashblade.BuiltInRelationship(id=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(id=None)
Keyword Arguments

id (str) – A non-modifiable, globally unique ID chosen by the system.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Certificate

class pypureclient.flashblade.Certificate(name=None, id=None, country=None, issued_by=None, issued_to=None, subject_alternative_names=None, certificate=None, locality=None, valid_from=None, intermediate_certificate=None, organization=None, valid_to=None, state=None, certificate_type=None, common_name=None, email=None, organizational_unit=None, key_size=None, status=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, country=None, issued_by=None, issued_to=None, subject_alternative_names=None, certificate=None, locality=None, valid_from=None, intermediate_certificate=None, organization=None, valid_to=None, state=None, certificate_type=None, common_name=None, email=None, organizational_unit=None, key_size=None, status=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • country (str) – The country field listed in the certificate.

  • issued_by (str) – Who issued this certificate.

  • issued_to (str) – Who this certificate was issued to.

  • subject_alternative_names (list[str]) – The alternative names that are secured by this certificate. Alternative names may be IP addresses, DNS names, or URIs.

  • certificate (str) – The text of the certificate.

  • locality (str) – The locality field listed in the certificate.

  • valid_from (str) – The start date of when this certificate is valid.

  • intermediate_certificate (str) – Intermediate certificate chains.

  • organization (str) – The organization field listed in the certificate.

  • valid_to (str) – The end date of when this certificate is valid.

  • state (str) – The state/province field listed in the certificate.

  • certificate_type (str) – The type of certificate. Possible values are appliance and external. Certificates of type appliance are used by the array to verify its identity to clients. Certificates of type external are used by the array to identify external servers to which it is configured to communicate.

  • common_name (str) – FQDN or management IP address of the current array.

  • email (str) – The email field listed in the certificate.

  • organizational_unit (str) – The organizational unit field listed in the certificate.

  • key_size (int) – The size of the private key for this certificate in bits.

  • status (str) – The type of certificate. Valid values are self-signed and imported.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

CertificateCertificateGroupGetResp

class pypureclient.flashblade.CertificateCertificateGroupGetResp(continuation_token=None, total_item_count=None, items=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(continuation_token=None, total_item_count=None, items=None)
Keyword Arguments

  • continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation_token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation_token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

  • total_item_count (int) – Total number of items after applying filter params.

  • items (list[Member]) – A list of certificate and certificate group relationships.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

CertificateGroup

class pypureclient.flashblade.CertificateGroup(name=None, id=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

CertificateGroupCertificateGetResp

class pypureclient.flashblade.CertificateGroupCertificateGetResp(continuation_token=None, total_item_count=None, items=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(continuation_token=None, total_item_count=None, items=None)
Keyword Arguments

  • continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation_token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation_token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

  • total_item_count (int) – Total number of items after applying filter params.

  • items (list[Member]) – A list of certificate and certificate group relationships.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

CertificateGroupUse

class pypureclient.flashblade.CertificateGroupUse(name=None, id=None, use=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, use=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • use (FixedReferenceWithRemote) – A reference to an object using this certificate group.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

CertificatePatch

class pypureclient.flashblade.CertificatePatch(name=None, id=None, certificate=None, passphrase=None, private_key=None, intermediate_certificate=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, certificate=None, passphrase=None, private_key=None, intermediate_certificate=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • certificate (str) – The text of the certificate.

  • passphrase (str) – The passphrase used to encrypt private_key.

  • private_key (str) – The private key used to sign the certificate.

  • intermediate_certificate (str) – Intermediate certificate chains.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

CertificatePost

class pypureclient.flashblade.CertificatePost(name=None, country=None, issued_by=None, issued_to=None, certificate=None, locality=None, valid_from=None, private_key=None, intermediate_certificate=None, organization=None, valid_to=None, passphrase=None, state=None, certificate_type=None, common_name=None, email=None, organizational_unit=None, key_size=None, status=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, country=None, issued_by=None, issued_to=None, certificate=None, locality=None, valid_from=None, private_key=None, intermediate_certificate=None, organization=None, valid_to=None, passphrase=None, state=None, certificate_type=None, common_name=None, email=None, organizational_unit=None, key_size=None, status=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • country (str) – The country field listed in the certificate.

  • issued_by (str) – Who issued this certificate.

  • issued_to (str) – Who this certificate was issued to.

  • certificate (str) – The text of the certificate.

  • locality (str) – The locality field listed in the certificate.

  • valid_from (str) – The start date of when this certificate is valid.

  • private_key (str) – The private key used to sign the certificate.

  • intermediate_certificate (str) – Intermediate certificate chains.

  • organization (str) – The organization field listed in the certificate.

  • valid_to (str) – The end date of when this certificate is valid.

  • passphrase (str) – The passphrase used to encrypt private_key.

  • state (str) – The state/province field listed in the certificate.

  • certificate_type (str) – The type of certificate. Possible values are appliance and external. Certificates of type appliance are used by the array to verify its identity to clients. Certificates of type external are used by the array to identify external servers to which it is configured to communicate.

  • common_name (str) – FQDN or management IP address of the current array.

  • email (str) – The email field listed in the certificate.

  • organizational_unit (str) – The organizational unit field listed in the certificate.

  • key_size (int) – The size of the private key for this certificate in bits.

  • status (str) – The type of certificate. Valid values are self-signed and imported.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

CertificateUse

class pypureclient.flashblade.CertificateUse(name=None, id=None, use=None, group=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, use=None, group=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • use (FixedReferenceWithRemote) – A reference to an object using this certificate.

  • group (FixedReference) – A reference to a certificate group that is being used, if any, where this certificate is a member of the certificate-group. This field is null if the referenced use object is not using a group, but is rather using this certificate directly.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ClientPerformance

class pypureclient.flashblade.ClientPerformance(name=None, read_bytes_per_sec=None, others_per_sec=None, reads_per_sec=None, write_bytes_per_sec=None, bytes_per_write=None, usec_per_other_op=None, writes_per_sec=None, time=None, bytes_per_op=None, usec_per_write_op=None, bytes_per_read=None, usec_per_read_op=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, read_bytes_per_sec=None, others_per_sec=None, reads_per_sec=None, write_bytes_per_sec=None, bytes_per_write=None, usec_per_other_op=None, writes_per_sec=None, time=None, bytes_per_op=None, usec_per_write_op=None, bytes_per_read=None, usec_per_read_op=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • read_bytes_per_sec (int) – Bytes read per second.

  • others_per_sec (int) – Other operations processed per second.

  • reads_per_sec (int) – Read requests processed per second.

  • write_bytes_per_sec (int) – Bytes written per second.

  • bytes_per_write (int) – Average write size in bytes per write operation.

  • usec_per_other_op (int) – Average time, measured in microseconds, it takes the client to process other operations.

  • writes_per_sec (int) – Write requests processed per second.

  • time (int) – Sample time in milliseconds since UNIX epoch.

  • bytes_per_op (int) – Average operation size (read bytes+write bytes/read ops+write ops).

  • usec_per_write_op (int) – Average time, measured in microseconds, it takes the client to process a write request.

  • bytes_per_read (int) – Average read size in bytes per read operation.

  • usec_per_read_op (int) – Average time, measured in microseconds, it takes the client to process a read request.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ConnectionRelationshipPerformanceReplication

class pypureclient.flashblade.ConnectionRelationshipPerformanceReplication(id=None, periodic=None, continuous=None, time=None, remote=None, aggregate=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(id=None, periodic=None, continuous=None, time=None, remote=None, aggregate=None)
Keyword Arguments

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • periodic (ReplicationPerformance) – Total bytes transmitted or received per second for periodic replication. Periodic replication includes file system replication, which is snapshot based.

  • continuous (ContinuousReplicationPerformance) – Object backlog information and total bytes transmitted or received per second for continuous replication. Continuous replication includes object replication.

  • time (int) – Sample time in milliseconds since UNIX epoch.

  • remote (FixedReferenceNoResourceType) – Reference to a remote array.

  • aggregate (ReplicationPerformance) – Total bytes transmitted or received per second for all types of replication.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ConnectionRelationshipPerformanceReplicationGetResp

class pypureclient.flashblade.ConnectionRelationshipPerformanceReplicationGetResp(continuation_token=None, total_item_count=None, total=None, items=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(continuation_token=None, total_item_count=None, total=None, items=None)
Keyword Arguments

  • continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation_token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation_token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

  • total_item_count (int) – Total number of items after applying filter params.

  • total (list[ConnectionRelationshipPerformanceReplication]) – Total of all records after filtering. If total_only query param is true, then no items will be returned.

  • items (list[ConnectionRelationshipPerformanceReplication]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Context

class pypureclient.flashblade.Context(context=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(context=None)
Keyword Arguments

context (Reference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ContinuousReplicationPerformance

class pypureclient.flashblade.ContinuousReplicationPerformance(transmitted_bytes_per_sec=None, received_bytes_per_sec=None, object_backlog=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(transmitted_bytes_per_sec=None, received_bytes_per_sec=None, object_backlog=None)
Keyword Arguments

  • transmitted_bytes_per_sec (float) – Total bytes transmitted per second.

  • received_bytes_per_sec (float) – Total bytes received per second.

  • object_backlog (ObjectBacklog) – The total number of pending object operations and their size that are currently in the backlog.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

CrossOriginResourceSharingPolicy

class pypureclient.flashblade.CrossOriginResourceSharingPolicy(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, context=None, bucket=None, rules=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, context=None, bucket=None, rules=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • policy_type (str) – Type of the policy. Valid values include alert, audit, bucket-access, cross-origin-resource-sharing, network-access, nfs, object-access, smb-client, smb-share, snapshot, ssh-certificate-authority, and worm-data.

  • location (FixedReference) – Reference to the array where the policy is defined.

  • is_local (bool) – Whether the policy is defined on the local array.

  • enabled (bool) – If true, the policy is enabled. If not specified, defaults to true.

  • context (Reference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • bucket (FixedReference) – The bucket to which this policy belongs.

  • rules (list[CrossOriginResourceSharingPolicyRuleWithContext]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

CrossOriginResourceSharingPolicyPatch

class pypureclient.flashblade.CrossOriginResourceSharingPolicyPatch(rules=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(rules=None)
Keyword Arguments

rules (list[CrossOriginResourceSharingPolicyRuleBulkManage]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

CrossOriginResourceSharingPolicyRule

class pypureclient.flashblade.CrossOriginResourceSharingPolicyRule(name=None, allowed_methods=None, allowed_headers=None, allowed_origins=None, context=None, policy=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, allowed_methods=None, allowed_headers=None, allowed_origins=None, context=None, policy=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • allowed_methods (list[str]) – A list of HTTP methods that are permitted for cross-origin requests to access a bucket. The only currently supported combination of allowed methods is all methods [“GET”, “PUT”, “HEAD”, “POST”, “DELETE”].

  • allowed_headers (list[str]) – A list of headers that are permitted to be included in cross-origin requests to access a bucket. The only currently supported allowed header is *.

  • allowed_origins (list[str]) – A list of origins (domains) that are permitted to make cross-origin requests to access a bucket. The only currently supported allowed origin is *.

  • context (Reference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • policy (FixedReference) – The policy to which this rule belongs.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

CrossOriginResourceSharingPolicyRuleBulkManage

class pypureclient.flashblade.CrossOriginResourceSharingPolicyRuleBulkManage(allowed_methods=None, allowed_headers=None, allowed_origins=None, name=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(allowed_methods=None, allowed_headers=None, allowed_origins=None, name=None)
Keyword Arguments

  • allowed_methods (list[str]) – A list of HTTP methods that are permitted for cross-origin requests to access a bucket. The only currently supported combination of allowed methods is all methods [“GET”, “PUT”, “HEAD”, “POST”, “DELETE”].

  • allowed_headers (list[str]) – A list of headers that are permitted to be included in cross-origin requests to access a bucket. The only currently supported allowed header is *.

  • allowed_origins (list[str]) – A list of origins (domains) that are permitted to make cross-origin requests to access a bucket. The only currently supported allowed origin is *.

  • name (str) – Name of the object (e.g., a file system or snapshot).

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

CrossOriginResourceSharingPolicyRulePost

class pypureclient.flashblade.CrossOriginResourceSharingPolicyRulePost(allowed_methods=None, allowed_headers=None, allowed_origins=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(allowed_methods=None, allowed_headers=None, allowed_origins=None)
Keyword Arguments

  • allowed_methods (list[str]) – A list of HTTP methods that are permitted for cross-origin requests to access a bucket. The only currently supported combination of allowed methods is all methods [“GET”, “PUT”, “HEAD”, “POST”, “DELETE”].

  • allowed_headers (list[str]) – A list of headers that are permitted to be included in cross-origin requests to access a bucket. The only currently supported allowed header is *.

  • allowed_origins (list[str]) – A list of origins (domains) that are permitted to make cross-origin requests to access a bucket. The only currently supported allowed origin is *.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

CrossOriginResourceSharingPolicyRuleWithContext

class pypureclient.flashblade.CrossOriginResourceSharingPolicyRuleWithContext(name=None, allowed_methods=None, allowed_headers=None, allowed_origins=None, context=None, policy=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, allowed_methods=None, allowed_headers=None, allowed_origins=None, context=None, policy=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • allowed_methods (list[str]) – A list of HTTP methods that are permitted for cross-origin requests to access a bucket. The only currently supported combination of allowed methods is all methods [“GET”, “PUT”, “HEAD”, “POST”, “DELETE”].

  • allowed_headers (list[str]) – A list of headers that are permitted to be included in cross-origin requests to access a bucket. The only currently supported allowed header is *.

  • allowed_origins (list[str]) – A list of origins (domains) that are permitted to make cross-origin requests to access a bucket. The only currently supported allowed origin is *.

  • context (Reference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • policy (FixedReference) – The policy to which this rule belongs.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Direction

class pypureclient.flashblade.Direction
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__()

Keyword args:

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

DirectoryService

class pypureclient.flashblade.DirectoryService(name=None, id=None, ca_certificate=None, uris=None, base_dn=None, bind_password=None, management=None, smb=None, ca_certificate_group=None, nfs=None, services=None, bind_user=None, enabled=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, ca_certificate=None, uris=None, base_dn=None, bind_password=None, management=None, smb=None, ca_certificate_group=None, nfs=None, services=None, bind_user=None, enabled=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • ca_certificate (Reference) – CA certificate used to validate the authenticity of the configured servers.

  • uris (list[str]) – List of URIs for the configured directory servers.

  • base_dn (str) – Base of the Distinguished Name (DN) of the directory service groups.

  • bind_password (str) – Obfuscated password used to query the directory.

  • management (DirectoryServiceManagement) –

  • smb (DirectoryServiceSmb) –

  • ca_certificate_group (Reference) – A certificate group containing CA certificates that can be used to validate the authenticity of the configured servers.

  • nfs (DirectoryServiceNfs) –

  • services (list[str]) – Services that the directory service configuration is used for.

  • bind_user (str) – Username used to query the directory.

  • enabled (bool) – Is the directory service enabled or not?

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

DirectoryServiceManagement

class pypureclient.flashblade.DirectoryServiceManagement(user_login_attribute=None, user_object_class=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(user_login_attribute=None, user_object_class=None)
Keyword Arguments

  • user_login_attribute (str) – User login attribute in the structure of the configured LDAP servers. Typically the attribute field that holds the user’s unique login name. Default value is sAMAccountName for Active Directory or uid for all other directory services.

  • user_object_class (str) – Value of the object class for a management LDAP user. Defaults to User for Active Directory servers, posixAccount or shadowAccount for OpenLDAP servers dependent on the group type of the server, or person for all other directory servers.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

DirectoryServiceNfs

class pypureclient.flashblade.DirectoryServiceNfs(nis_domains=None, nis_servers=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(nis_domains=None, nis_servers=None)
Keyword Arguments

  • nis_domains (list[str]) – NIS domains to search.

  • nis_servers (list[str]) – A list of the IP addresses or hostnames of NIS servers to search.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

DirectoryServiceRole

class pypureclient.flashblade.DirectoryServiceRole(role=None, group_base=None, name=None, id=None, group=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(role=None, group_base=None, name=None, id=None, group=None)
Keyword Arguments

  • role (ReferenceWritable) – A reference to the role; can be any role that exists on the system.

  • group_base (str) – Specifies where the configured group is located in the directory tree.

  • name (str) – Name of the role mapping object.

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • group (str) – Common Name (CN) of the directory service group containing users with authority level of the specified role name.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

DirectoryServiceSmb

class pypureclient.flashblade.DirectoryServiceSmb(join_ou=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(join_ou=None)
Keyword Arguments

join_ou (str) – Optional organizational unit where the machine account for the directory service will be created.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Dns

class pypureclient.flashblade.Dns(name=None, id=None, nameservers=None, sources=None, domain=None, services=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, nameservers=None, sources=None, domain=None, services=None)
Keyword Arguments

  • name (str) – A name chosen by the user. Can be changed. Must be locally unique.

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • nameservers (list[str]) – List of DNS server IP addresses.

  • sources (list[Reference]) – The network interfaces used for communication with the DNS server. The network interfaces must have the services value of data. Clear this by setting an empty list.

  • domain (str) – Domain suffix to be appended by the appliance when performing DNS lookups.

  • services (list[str]) – The list of services utilizing the DNS configuration.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

DnsPost

class pypureclient.flashblade.DnsPost(nameservers=None, sources=None, domain=None, services=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(nameservers=None, sources=None, domain=None, services=None)
Keyword Arguments

  • nameservers (list[str]) – List of DNS server IP addresses.

  • sources (list[Reference]) – The network interfaces used for communication with the DNS server. The network interfaces must have the services value of data. Clear this by setting an empty list.

  • domain (str) – Domain suffix to be appended by the appliance when performing DNS lookups.

  • services (list[str]) – The list of services utilizing the DNS configuration.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Drive

class pypureclient.flashblade.Drive(name=None, id=None, raw_capacity=None, progress=None, details=None, type=None, status=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, raw_capacity=None, progress=None, details=None, type=None, status=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • raw_capacity (int) –

  • progress (float) – Reflects this drive’s current progress toward completing a planned evacuation. If a planned evacuation is not occurring, the value will be null.

  • details (str) – Details about the status of the drive if not healthy.

  • type (str) – The type of the module. Valid values are DFM and DFMe.

  • status (str) – Current status of the drive. Valid values are evacuated, evacuating, healthy, unhealthy, unused, and updating.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Eula

class pypureclient.flashblade.Eula(agreement=None, signature=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(agreement=None, signature=None)
Keyword Arguments

  • agreement (str) – The End User Agreement text.

  • signature (EulaSignature) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

EulaSignature

class pypureclient.flashblade.EulaSignature(name=None, accepted=None, company=None, title=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, accepted=None, company=None, title=None)
Keyword Arguments

  • name (str) – The name of the person who accepted the End User Agreement. This field is deprecated and the response will be null. Modification to this field will be ignored.

  • accepted (int) – Accepted time in milliseconds since the UNIX epoch.

  • company (str) – The company of the person who accepted the End User Agreement. This field is deprecated and the response will be null. Modification to this field will be ignored.

  • title (str) – The title of the person who accepted the End User Agreement. This field is deprecated and the response will be null. Modification to this field will be ignored.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

FileInfo

class pypureclient.flashblade.FileInfo(name=None, length=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, length=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • length (int) – Length of the file (in bytes).

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

FileLock

class pypureclient.flashblade.FileLock(name=None, inode=None, path=None, access_type=None, protocol=None, client=None, created_at=None, range=None, source=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, inode=None, path=None, access_type=None, protocol=None, client=None, created_at=None, range=None, source=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • inode (int) – The inode of the file where the lock is found relative to the specified source.

  • path (str) – Path to the file where the lock is found relative to source. If it is longer than 1023 characters, it will be truncated and only the last 1023 characters will be returned. If multiple hard links exist to the file on which the lock is held, only one is returned. This field will be null if the path cannot be resolved.

  • access_type (str) – Type of access the lock provides. Valid values are shared, exclusive and no-access.

  • protocol (str) – The protocol utilized for obtaining and managing the lock. Valid values include NLM, NFSv4.1 and SMB.

  • client (FixedReferenceNoId) – Reference to the file system client that holds the lock.

  • created_at (int) – Creation timestamp of the lock. Measured in milliseconds since the UNIX epoch.

  • range (FileLockRange) –

  • source (FixedReference) – Reference to location where the path/inode can be found.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

FileLockRange

class pypureclient.flashblade.FileLockRange(offset=None, length=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(offset=None, length=None)
Keyword Arguments

  • offset (int) –

  • length (int) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

FileSession

class pypureclient.flashblade.FileSession(name=None, connection_time=None, protocol=None, port=None, client=None, opens=None, idle_time=None, time=None, user=None, authentication=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, connection_time=None, protocol=None, port=None, client=None, opens=None, idle_time=None, time=None, user=None, authentication=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • connection_time (int) – Connection time in milliseconds since UNIX epoch.

  • protocol (str) – The protocol utilized for obtaining and managing the session. Valid values include nfs and smb.

  • port (int) – Port number the client is connected from.

  • client (FixedReferenceNameOnly) – Client that holds the session.

  • opens (int) – Number of opens for the given session.

  • idle_time (int) – Duration in milliseconds that indicates how long the session has been idle.

  • time (int) – Current time in milliseconds since UNIX epoch.

  • user (UserNoId) – The user who has created the session.

  • authentication (str) – Describes how was the user authenticated. Valid values include KRB and NTLMv2.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

FileSystem

class pypureclient.flashblade.FileSystem(name=None, id=None, context=None, promotion_status=None, storage_class=None, created=None, qos_policy=None, smb=None, eradication_config=None, source=None, multi_protocol=None, space=None, fast_remove_directory_enabled=None, writable=None, time_remaining=None, destroyed=None, hard_limit_enabled=None, provisioned=None, requested_promotion_state=None, default_user_quota=None, group_ownership=None, http=None, nfs=None, default_group_quota=None, snapshot_directory_enabled=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, context=None, promotion_status=None, storage_class=None, created=None, qos_policy=None, smb=None, eradication_config=None, source=None, multi_protocol=None, space=None, fast_remove_directory_enabled=None, writable=None, time_remaining=None, destroyed=None, hard_limit_enabled=None, provisioned=None, requested_promotion_state=None, default_user_quota=None, group_ownership=None, http=None, nfs=None, default_group_quota=None, snapshot_directory_enabled=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • context (Reference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • promotion_status (str) – Possible values are promoted and demoted. The current status of the file system with respect to replication. Changes via requested_promotion_state. The default for new file systems is promoted.

  • storage_class (StorageClassInfo) –

  • created (int) – Creation timestamp of the file system.

  • qos_policy (FixedReference) – The QoS policy for the File System defines the performance controls that can be applied to the aggregate performance of all the clients accessing the file system. If no policy is configured for a file system, then no performance controls are applied to it.

  • smb (Smb) – SMB configuration.

  • eradication_config (FileSystemEradicationConfig) –

  • source (LocationReference) – A reference to the source file system.

  • multi_protocol (MultiProtocol) – Multi-protocol configuration.

  • space (Space) – The space usage of the file system.

  • fast_remove_directory_enabled (bool) – If set to true, the file system, when mounted, will contain a directory that can be used for fast removal of other directories. Directories can be moved into the fast remove directory in order to have them deleted, and their space freed, more quickly than a normal removal operation.

  • writable (bool) – Whether the file system is writable or not. If false, this overrides any protocol or file permission settings and prevents changes. If true, then the protocol and file permission settings are evaluated. If not specified, defaults to true. Modifiable.

  • time_remaining (int) – Time in milliseconds before the file system is eradicated. null if not destroyed.

  • destroyed (bool) – Returns a value of true if the file system has been destroyed and is pending eradication. The file system cannot be modified while it is in the destroyed state. The time_remaining value displays the amount of time left until the destroyed file system is permanently eradicated. Once eradication has begun, the file system can no longer be recovered. Before the time_remaining period has elapsed, the destroyed file system can be recovered through the PATCH method by setting destroyed=false.

  • hard_limit_enabled (bool) – If set to true, the file system’s size, as defined by provisioned, is used as a hard limit quota.

  • provisioned (int) – The provisioned size of the file system, displayed in bytes. If set to an empty string (“”), the file system is unlimited in size.

  • requested_promotion_state (str) – Possible values are promoted and demoted. The demoted state is used for replication targets and is only allowed to be set if the file system is in a replica-link relationship. The additional query param discard-non-snapshotted-data must be set to true when demoting a file system. The default for new file systems is promoted.

  • default_user_quota (int) – The default space quota for a user writing to this file system.

  • group_ownership (str) – The group ownership for new files and directories in a file system. Possible values are creator and parent-directory. If creator is selected, the owning group of new files and directories is the primary group of the user who creates them. If parent-directory is selected, the owning group is the parent directory group. Note: Existing files and directories are unaffected by this change.

  • http (Http) – HTTP configuration.

  • nfs (Nfs) – NFS configuration.

  • default_group_quota (int) – The default space quota for a group writing to this file system.

  • snapshot_directory_enabled (bool) – If set to true, a hidden .snapshot directory will be present in each directory of the file system when it is mounted. The .snapshot directory allows clients read access to the contents of the snapshots that have been taken of a directory. If set to false, the .snapshot directory will not be present in any directories within a mounted file system.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

FileSystemClient

class pypureclient.flashblade.FileSystemClient(name=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None)
Keyword Arguments

name (str) – Name of the object (e.g., a file system or snapshot).

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

FileSystemEradicationConfig

class pypureclient.flashblade.FileSystemEradicationConfig(eradication_mode=None, manual_eradication=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(eradication_mode=None, manual_eradication=None)
Keyword Arguments

  • eradication_mode (str) – The eradication mode of the file system. If it’s permission-based the file system can be eradicated based on user permissions. If it’s retention-based the file system can not be eradicated until no files/inodes are locked or retained. Valid values are permission-based and retention-based.

  • manual_eradication (str) – The manual eradication status of the file system. If disabled, the file system cannot be eradicated after it has been destroyed, unless it is empty. If enabled, the file system can be eradicated. Valid values are disabled and enabled.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

FileSystemExport

class pypureclient.flashblade.FileSystemExport(name=None, id=None, context=None, server=None, policy_type=None, share_policy=None, export_name=None, member=None, enabled=None, policy=None, status=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, context=None, server=None, policy_type=None, share_policy=None, export_name=None, member=None, enabled=None, policy=None, status=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • context (Reference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • server (FixedReference) – Reference to the server the export will be visible on.

  • policy_type (str) – Policy type attached to the export. It is either SMB or NFS.

  • share_policy (Reference) – Reference to the SMB share policy (only used for SMB).

  • export_name (str) – The name of the export used by clients to mount the file system. Export names must be unique within the same protocol/server combination.

  • member (FixedReference) – Reference to the file system the policy is applied to.

  • enabled (bool) – Returns a value of true if and only if the export policy that manages this export is enabled AND the protocol is enabled on the file system.

  • policy (Reference) – Reference to the NFS export policy or SMB client policy.

  • status (str) – Explains why enabled is false. Valid values include policy_disabled and protocol_disabled.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

FileSystemExportPost

class pypureclient.flashblade.FileSystemExportPost(server=None, share_policy=None, export_name=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(server=None, share_policy=None, export_name=None)
Keyword Arguments

  • server (Reference) – Reference to the server the export will be visible on.

  • share_policy (Reference) – Reference to the SMB share policy (only used for SMB).

  • export_name (str) – The name of the export to create. Export names must be unique within the same protocol and server.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

FileSystemGroupPerformance

class pypureclient.flashblade.FileSystemGroupPerformance(name=None, read_bytes_per_sec=None, others_per_sec=None, write_bytes_per_sec=None, usec_per_other_op=None, bytes_per_op=None, bytes_per_read=None, usec_per_read_op=None, file_system=None, reads_per_sec=None, bytes_per_write=None, writes_per_sec=None, time=None, usec_per_write_op=None, group=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, read_bytes_per_sec=None, others_per_sec=None, write_bytes_per_sec=None, usec_per_other_op=None, bytes_per_op=None, bytes_per_read=None, usec_per_read_op=None, file_system=None, reads_per_sec=None, bytes_per_write=None, writes_per_sec=None, time=None, usec_per_write_op=None, group=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • read_bytes_per_sec (float) – Bytes read per second.

  • others_per_sec (float) – Other operations processed per second.

  • write_bytes_per_sec (float) – Bytes written per second.

  • usec_per_other_op (float) – Average time, measured in microseconds, it takes the array to process other operations.

  • bytes_per_op (float) – Average operation size (read bytes+write bytes/read ops+write ops).

  • bytes_per_read (float) – Average read size in bytes per read operation.

  • usec_per_read_op (float) – Average time, measured in microseconds, it takes the array to process a read request.

  • file_system (FixedReference) – The file system on which the performance was measured.

  • reads_per_sec (float) – Read requests processed per second.

  • bytes_per_write (float) – Average write size in bytes per write operation.

  • writes_per_sec (float) – Write requests processed per second.

  • time (int) – Sample time in milliseconds since UNIX epoch.

  • usec_per_write_op (float) – Average time, measured in microseconds, it takes the array to process a write request.

  • group (Group) – The group whose performance is represented.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

FileSystemLockNlmReclamation

class pypureclient.flashblade.FileSystemLockNlmReclamation(start=None, end=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(start=None, end=None)
Keyword Arguments

  • start (int) – Start time of the NLM reclamation in milliseconds since the UNIX epoch.

  • end (int) – End time of the NLM reclamation in milliseconds since the UNIX epoch.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

FileSystemOpenFile

class pypureclient.flashblade.FileSystemOpenFile(mode=None, lock_count=None, path=None, session=None, client=None, id=None, source=None, user=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(mode=None, lock_count=None, path=None, session=None, client=None, id=None, source=None, user=None)
Keyword Arguments

  • mode (str) – The mode in which the file is open: “ro” for Read-Only, “wo” for Write-Only, “rw” for Read-Write or “no-access” if no read or write access was granted.

  • lock_count (int) – The number of locks on the file.

  • path (str) – The path to the open file.

  • session (FixedReferenceNameOnly) – The name of the session with the open file.

  • client (FixedReferenceNameOnly) – Client that has the file open.

  • id (str) – The unique identifier of the open file.

  • source (FixedReference) – Reference to the file system.

  • user (UserNoId) – The user who has the file open.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

FileSystemPatch

class pypureclient.flashblade.FileSystemPatch(name=None, id=None, promotion_status=None, storage_class=None, created=None, qos_policy=None, smb=None, source=None, multi_protocol=None, fast_remove_directory_enabled=None, writable=None, time_remaining=None, destroyed=None, hard_limit_enabled=None, provisioned=None, requested_promotion_state=None, default_user_quota=None, group_ownership=None, http=None, nfs=None, default_group_quota=None, snapshot_directory_enabled=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, promotion_status=None, storage_class=None, created=None, qos_policy=None, smb=None, source=None, multi_protocol=None, fast_remove_directory_enabled=None, writable=None, time_remaining=None, destroyed=None, hard_limit_enabled=None, provisioned=None, requested_promotion_state=None, default_user_quota=None, group_ownership=None, http=None, nfs=None, default_group_quota=None, snapshot_directory_enabled=None)
Keyword Arguments

  • name (str) – A name chosen by the user. Can be changed. Must be locally unique.

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • promotion_status (str) – Possible values are promoted and demoted. The current status of the file system with respect to replication. Changes via requested_promotion_state. The default for new file systems is promoted.

  • storage_class (StorageClassInfo) –

  • created (int) – Creation timestamp of the file system.

  • qos_policy (Reference) – The QoS policy for the File System defines the performance controls that can be applied to the aggregate performance of all the clients accessing the file system. If no policy is configured for a file system, then no performance controls are applied to it. Use “” to clear an attached policy.

  • smb (Smb) – SMB configuration.

  • source (FixedLocationReference) – A reference to the source file system.

  • multi_protocol (MultiProtocol) – Multi-protocol configuration.

  • fast_remove_directory_enabled (bool) – If set to true, the file system, when mounted, will contain a directory that can be used for fast removal of other directories. Directories can be moved into the fast remove directory in order to have them deleted, and their space freed, more quickly than a normal removal operation.

  • writable (bool) – Whether the file system is writable or not. If false, this overrides any protocol or file permission settings and prevents changes. If true, then the protocol and file permission settings are evaluated. If not specified, defaults to true. Modifiable.

  • time_remaining (int) – Time in milliseconds before the file system is eradicated. null if not destroyed.

  • destroyed (bool) – Returns a value of true if the file system has been destroyed and is pending eradication. The file system cannot be modified while it is in the destroyed state. The time_remaining value displays the amount of time left until the destroyed file system is permanently eradicated. Once eradication has begun, the file system can no longer be recovered. Before the time_remaining period has elapsed, the destroyed file system can be recovered through the PATCH method by setting destroyed=false.

  • hard_limit_enabled (bool) – If set to true, the file system’s size, as defined by provisioned, is used as a hard limit quota.

  • provisioned (int) – The provisioned size of the file system, displayed in bytes. If set to an empty string (“”), the file system is unlimited in size.

  • requested_promotion_state (str) – Possible values are promoted and demoted. The demoted state is used for replication targets and is only allowed to be set if the file system is in a replica-link relationship. The additional query param discard-non-snapshotted-data must be set to true when demoting a file system. The default for new file systems is promoted.

  • default_user_quota (int) – The default space quota for a user writing to this file system.

  • group_ownership (str) – The group ownership for new files and directories in a file system. Possible values are creator and parent-directory. If creator is selected, the owning group of new files and directories is the primary group of the user who creates them. If parent-directory is selected, the owning group is the parent directory group. Note: Existing files and directories are unaffected by this change.

  • http (Http) – HTTP configuration.

  • nfs (NfsPatch) – NFS configuration.

  • default_group_quota (int) – The default space quota for a group writing to this file system.

  • snapshot_directory_enabled (bool) – If set to true, a hidden .snapshot directory will be present in each directory of the file system when it is mounted. The .snapshot directory allows clients read access to the contents of the snapshots that have been taken of a directory. If set to false, the .snapshot directory will not be present in any directories within a mounted file system.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

FileSystemPerformance

class pypureclient.flashblade.FileSystemPerformance(name=None, id=None, read_bytes_per_sec=None, others_per_sec=None, reads_per_sec=None, write_bytes_per_sec=None, bytes_per_write=None, usec_per_other_op=None, writes_per_sec=None, time=None, bytes_per_op=None, usec_per_write_op=None, bytes_per_read=None, usec_per_read_op=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, read_bytes_per_sec=None, others_per_sec=None, reads_per_sec=None, write_bytes_per_sec=None, bytes_per_write=None, usec_per_other_op=None, writes_per_sec=None, time=None, bytes_per_op=None, usec_per_write_op=None, bytes_per_read=None, usec_per_read_op=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • read_bytes_per_sec (float) – Bytes read per second.

  • others_per_sec (float) – Other operations processed per second.

  • reads_per_sec (float) – Read requests processed per second.

  • write_bytes_per_sec (float) – Bytes written per second.

  • bytes_per_write (float) – Average write size in bytes per write operation.

  • usec_per_other_op (float) – Average time, measured in microseconds, it takes the array to process other operations.

  • writes_per_sec (float) – Write requests processed per second.

  • time (int) – Sample time in milliseconds since UNIX epoch.

  • bytes_per_op (float) – Average operation size (read bytes+write bytes/read ops+write ops).

  • usec_per_write_op (float) – Average time, measured in microseconds, it takes the array to process a write request.

  • bytes_per_read (float) – Average read size in bytes per read operation.

  • usec_per_read_op (float) – Average time, measured in microseconds, it takes the array to process a read request.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

FileSystemPost

class pypureclient.flashblade.FileSystemPost(qos_policy=None, smb=None, eradication_config=None, source=None, multi_protocol=None, fast_remove_directory_enabled=None, writable=None, hard_limit_enabled=None, provisioned=None, requested_promotion_state=None, default_user_quota=None, group_ownership=None, http=None, nfs=None, default_group_quota=None, snapshot_directory_enabled=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(qos_policy=None, smb=None, eradication_config=None, source=None, multi_protocol=None, fast_remove_directory_enabled=None, writable=None, hard_limit_enabled=None, provisioned=None, requested_promotion_state=None, default_user_quota=None, group_ownership=None, http=None, nfs=None, default_group_quota=None, snapshot_directory_enabled=None)
Keyword Arguments

  • qos_policy (Reference) – The QoS policy for the File System defines the performance controls that can be applied to the aggregate performance of all the clients accessing the file system. If no policy is set here, no explicit performance controls are applied to the file system beyond the system’s default fairness.

  • smb (SmbPost) – SMB configuration.

  • eradication_config (FileSystemEradicationConfig) –

  • source (Reference) – The source snapshot whose data is copied to the file system specified.

  • multi_protocol (MultiProtocolPost) – Multi-protocol configuration.

  • fast_remove_directory_enabled (bool) – If set to true, the file system, when mounted, will contain a directory that can be used for fast removal of other directories. Directories can be moved into the fast remove directory in order to have them deleted, and their space freed, more quickly than a normal removal operation. If not specified, defaults to false.

  • writable (bool) – Whether the file system is writable or not. If false, this overrides any protocol or file permission settings and prevents changes. If true, then the protocol and file permission settings are evaluated. If not specified, defaults to true. Modifiable.

  • hard_limit_enabled (bool) – If set to true, the file system’s size, as defined by provisioned, is used as a hard limit quota. If not specified, defaults to false.

  • provisioned (int) – The provisioned size of the file system, displayed in bytes. If set to an empty string (“”), the file system is unlimited in size. If not specified, defaults to unlimited.

  • requested_promotion_state (str) – Possible values are promoted and demoted. The demoted state is used for replication targets and is only allowed to be set if the file system is in a replica-link relationship. The additional query param discard-non-snapshotted-data must be set to true when demoting a file system. The default for new file systems is promoted.

  • default_user_quota (int) – The default space quota for a user writing to this file system.

  • group_ownership (str) – The group ownership for new files and directories in a file system. Possible values are creator and parent-directory. If creator is selected, the owning group of new files and directories is the primary group of the user who creates them. If parent-directory is selected, the owning group is the parent directory group. Note: Existing files and directories are unaffected by this change. If not specified, defaults to creator.

  • http (Http) – HTTP configuration.

  • nfs (Nfs) – NFS configuration.

  • default_group_quota (int) – The default space quota for a group writing to this file system.

  • snapshot_directory_enabled (bool) – If set to true, a hidden .snapshot directory will be present in each directory of the file system when it is mounted. The .snapshot directory allows clients read access to the contents of the snapshots that have been taken of a directory. If set to false, the .snapshot directory will not be present in any directories within a mounted file system. If not specified, defaults to true.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

FileSystemSnapshot

class pypureclient.flashblade.FileSystemSnapshot(name=None, id=None, context=None, owner=None, time_remaining=None, destroyed=None, created=None, policies=None, source=None, suffix=None, owner_destroyed=None, policy=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, context=None, owner=None, time_remaining=None, destroyed=None, created=None, policies=None, source=None, suffix=None, owner_destroyed=None, policy=None)
Keyword Arguments

  • name (str) – A name chosen by the user. Can be changed. Must be locally unique.

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • context (Reference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • owner (FixedReference) – A reference to the file system that owns this snapshot. If the owner is destroyed, this will be destroyed.

  • time_remaining (int) – Time in milliseconds before the file system snapshot is eradicated. null if not destroyed.

  • destroyed (bool) – Is the file system snapshot destroyed? If not specified, defaults to false.

  • created (int) – Creation timestamp of the object.

  • policies (list[FixedLocationReference]) – An array of references to the associated policies.

  • source (FixedLocationReference) – A reference to the file system that was the source of the data in this snapshot. Normally this is the same as the owner, but if the snapshot is replicated, the source is the original file system.

  • suffix (str) – The suffix of the snapshot, e.g., snap1.

  • owner_destroyed (bool) – Is the owning file system destroyed?

  • policy (FixedLocationReference) – A reference to the associated policy that drives the behavior of the snapshot.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

FileSystemSnapshotPost

class pypureclient.flashblade.FileSystemSnapshotPost(suffix=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(suffix=None)
Keyword Arguments

suffix (str) – The suffix of the snapshot, e.g., snap1.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

FileSystemSnapshotTransfer

class pypureclient.flashblade.FileSystemSnapshotTransfer(name=None, id=None, context=None, data_transferred=None, progress=None, started=None, completed=None, remote=None, remote_snapshot=None, direction=None, local_snapshot=None, status=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, context=None, data_transferred=None, progress=None, started=None, completed=None, remote=None, remote_snapshot=None, direction=None, local_snapshot=None, status=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • context (Reference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • data_transferred (int) – The amount of data transferred to the target, in bytes.

  • progress (float) – A percentage that indicates how much progress has been made on the transfer.

  • started (int) – A timestamp at which the replication of the snapshot started.

  • completed (int) – A timestamp at which the replication of the snapshot completed.

  • remote (FixedReferenceNoResourceType) – The array where the remote file system snapshot is located.

  • remote_snapshot (FixedReferenceNoResourceType) – A reference to the associated remote file system snapshot.

  • direction (Direction) –

  • local_snapshot (FixedReferenceNoResourceType) – A reference to the associated local file system snapshot.

  • status (str) – The status of current replication. Valid values are completed, in-progress, and queued.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

FileSystemUserPerformance

class pypureclient.flashblade.FileSystemUserPerformance(name=None, read_bytes_per_sec=None, others_per_sec=None, write_bytes_per_sec=None, usec_per_other_op=None, bytes_per_op=None, bytes_per_read=None, usec_per_read_op=None, file_system=None, reads_per_sec=None, bytes_per_write=None, writes_per_sec=None, time=None, usec_per_write_op=None, user=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, read_bytes_per_sec=None, others_per_sec=None, write_bytes_per_sec=None, usec_per_other_op=None, bytes_per_op=None, bytes_per_read=None, usec_per_read_op=None, file_system=None, reads_per_sec=None, bytes_per_write=None, writes_per_sec=None, time=None, usec_per_write_op=None, user=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • read_bytes_per_sec (float) – Bytes read per second.

  • others_per_sec (float) – Other operations processed per second.

  • write_bytes_per_sec (float) – Bytes written per second.

  • usec_per_other_op (float) – Average time, measured in microseconds, it takes the array to process other operations.

  • bytes_per_op (float) – Average operation size (read bytes+write bytes/read ops+write ops).

  • bytes_per_read (float) – Average read size in bytes per read operation.

  • usec_per_read_op (float) – Average time, measured in microseconds, it takes the array to process a read request.

  • file_system (FixedReference) – The file system on which the performance was measured.

  • reads_per_sec (float) – Read requests processed per second.

  • bytes_per_write (float) – Average write size in bytes per write operation.

  • writes_per_sec (float) – Write requests processed per second.

  • time (int) – Sample time in milliseconds since UNIX epoch.

  • usec_per_write_op (float) – Average time, measured in microseconds, it takes the array to process a write request.

  • user (User) – The user whose performance is represented.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

FixedLocationReference

class pypureclient.flashblade.FixedLocationReference(name=None, resource_type=None, id=None, location=None, display_name=None, is_local=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, resource_type=None, id=None, location=None, display_name=None, is_local=None)
Keyword Arguments

  • name (str) –

  • resource_type (str) – Type of the object (full name of the endpoint). Valid values are the unique part of the resource’s REST endpoint. For example, a reference to a file system would have a resource_type of file-systems.

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • location (FixedReference) – A reference to the location where the object is defined.

  • display_name (str) – Full name of the source with remote array information. Response will be same as source name for local file systems and policies.

  • is_local (bool) – Is the location reference to the local array or somewhere remote?

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

FixedReference

class pypureclient.flashblade.FixedReference(name=None, resource_type=None, id=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, resource_type=None, id=None)
Keyword Arguments

  • name (str) –

  • resource_type (str) – Type of the object (full name of the endpoint). Valid values are the unique part of the resource’s REST endpoint. For example, a reference to a file system would have a resource_type of file-systems.

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

FixedReferenceNameOnly

class pypureclient.flashblade.FixedReferenceNameOnly(name=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None)
Keyword Arguments

name (str) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

FixedReferenceNoId

class pypureclient.flashblade.FixedReferenceNoId(name=None, resource_type=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, resource_type=None)
Keyword Arguments

  • name (str) –

  • resource_type (str) – Type of the object (full name of the endpoint). Valid values are the unique part of the resource’s REST endpoint. For example, a reference to a file system would have a resource_type of file-systems.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

FixedReferenceNoResourceType

class pypureclient.flashblade.FixedReferenceNoResourceType(name=None, id=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None)
Keyword Arguments

  • name (str) –

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

FixedReferenceWithIsLocal

class pypureclient.flashblade.FixedReferenceWithIsLocal(name=None, resource_type=None, id=None, is_local=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, resource_type=None, id=None, is_local=None)
Keyword Arguments

  • name (str) –

  • resource_type (str) – Type of the object (full name of the endpoint). Valid values are the unique part of the resource’s REST endpoint. For example, a reference to a file system would have a resource_type of file-systems.

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • is_local (bool) – If set to true, the location reference is to the local array. If set to false, the location reference is to a remote location, such as a remote array or offload target.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

FixedReferenceWithRemote

class pypureclient.flashblade.FixedReferenceWithRemote(name=None, resource_type=None, id=None, remote=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, resource_type=None, id=None, remote=None)
Keyword Arguments

  • name (str) –

  • resource_type (str) – Type of the object (full name of the endpoint). Valid values are the unique part of the resource’s REST endpoint. For example, a reference to a file system would have a resource_type of file-systems.

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • remote (FixedReferenceNoResourceType) – The remote field of the corresponding array connection.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

FixedReferenceWithType

class pypureclient.flashblade.FixedReferenceWithType(name=None, resource_type=None, id=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, resource_type=None, id=None)
Keyword Arguments

  • name (str) –

  • resource_type (str) – Type of the object (full name of the endpoint). Valid values are the unique part of the resource’s REST endpoint. For example, a reference to a fleet would have a resource_type of fleets.

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Fleet

class pypureclient.flashblade.Fleet(name=None, id=None, is_local=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, is_local=None)
Keyword Arguments

  • name (str) – A name chosen by the user. Can be changed. Must be locally unique.

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • is_local (bool) – If set to true, the current array is a member of the fleet.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

FleetKey

class pypureclient.flashblade.FleetKey(expires=None, created=None, fleet_key=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(expires=None, created=None, fleet_key=None)
Keyword Arguments

  • expires (int) – Expiration time in milliseconds since UNIX epoch.

  • created (int) – Creation time in milliseconds since UNIX epoch.

  • fleet_key (str) – Fleet key, used for fleet connections. After creation, listing will only show ****.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

FleetMember

class pypureclient.flashblade.FleetMember(fleet=None, member=None, status_details=None, status=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(fleet=None, member=None, status_details=None, status=None)
Keyword Arguments

  • fleet (FixedReferenceWithIsLocal) –

  • member (FixedReferenceWithIsLocal) –

  • status_details (str) – Describes the error, if any.

  • status (str) – Current fleet membership status. Valid values include: joining, joined, or removing. A status of joining indicates that the member is attempting to join the fleet. A status of joined indicates that the member has joined the fleet. A status of removing indicates that the member is being removed from the fleet.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

FleetMemberPost

class pypureclient.flashblade.FleetMemberPost(members=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(members=None)
Keyword Arguments

members (list[FleetMemberPostMembers]) – Info about the members being added to fleet.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

FleetMemberPostMembers

class pypureclient.flashblade.FleetMemberPostMembers(member=None, key=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(member=None, key=None)
Keyword Arguments
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

FleetMemberPostMembersMember

class pypureclient.flashblade.FleetMemberPostMembersMember(name=None, resource_type=None, id=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, resource_type=None, id=None)
Keyword Arguments

  • name (str) – The resource name.

  • resource_type (str) – Type of the object (e.g. remote-arrays)

  • id (str) – A globally unique, system-generated ID. The ID cannot be modified.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

FleetPatch

class pypureclient.flashblade.FleetPatch(name=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None)
Keyword Arguments

name (str) – The new name for the resource.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Group

class pypureclient.flashblade.Group(name=None, id=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None)
Keyword Arguments

  • name (str) – The group name that represents the group’s identity, and which resolves to the group’s id in a configured directory service.

  • id (int) – The numeric group id that represents the group’s identity in a POSIX system.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

GroupQuota

class pypureclient.flashblade.GroupQuota(name=None, context=None, file_system=None, quota=None, usage=None, file_system_default_quota=None, group=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, context=None, file_system=None, quota=None, usage=None, file_system_default_quota=None, group=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • context (Reference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • file_system (FixedReference) –

  • quota (int) – The space limit of the quota (in bytes) for the specified group, cannot be 0. If specified, this value will override the file system’s default group quota.

  • usage (int) – The usage of the file system (in bytes) by the specified group.

  • file_system_default_quota (int) – File system’s default group quota (in bytes). If it is 0, it means there is no default quota. This will be the effective group quota if the group doesn’t have an individual quota. This default quota is set through the file-systems endpoint.

  • group (Group) – The group on which this quota is enforced.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

GroupQuotaPatch

class pypureclient.flashblade.GroupQuotaPatch(quota, name=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(quota, name=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • quota (int, required) – The space limit of the quota (in bytes) for the specified group, cannot be 0. If specified, this value will override the file system’s default group quota.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

GroupQuotaPost

class pypureclient.flashblade.GroupQuotaPost(quota, name=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(quota, name=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • quota (int, required) – The space limit of the quota (in bytes) for the specified group, cannot be 0. If specified, this value will override the file system’s default group quota.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Hardware

class pypureclient.flashblade.Hardware(name=None, id=None, management_mac=None, index=None, slot=None, type=None, speed=None, identify_enabled=None, serial=None, temperature=None, part_number=None, details=None, model=None, data_mac=None, status=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, management_mac=None, index=None, slot=None, type=None, speed=None, identify_enabled=None, serial=None, temperature=None, part_number=None, details=None, model=None, data_mac=None, status=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • management_mac (str) – Hardware component (burned-in) MAC address

  • index (int) – Number that identifies the relative position of a hardware component within the array.

  • slot (int) – Slot number occupied by the PCI Express card that hosts the component.

  • type (str) – Type of hardware component. Valid values are bay, ch, eth, fan, fb, fm, pwr, and xfm.

  • speed (int) – The maximum speed (in b/s) at which the component is capable of operating.

  • identify_enabled (bool) – State of an LED used to visually identify the component.

  • serial (str) – Serial number of the hardware component.

  • temperature (int) – Temperature (in degrees celsius) reported by the component.

  • part_number (str) – Part number of the hardware component.

  • details (str) – Details about the status of the component if not healthy.

  • model (str) – Model number of the hardware component.

  • data_mac (str) – Ethernet (data) MAC address

  • status (str) – Component status. Valid values are critical, healthy, identifying, unhealthy, unknown, and unused.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

HardwareConnector

class pypureclient.flashblade.HardwareConnector(name=None, id=None, lane_speed=None, port_speed=None, transceiver_type=None, connector_type=None, port_count=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, lane_speed=None, port_speed=None, transceiver_type=None, connector_type=None, port_count=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • lane_speed (int) – Configured speed of each lane in the connector in bits-per-second.

  • port_speed (int) – Configured speed of each port in the connector in bits-per-second.

  • transceiver_type (str) – Details about the transceiver which is plugged into the connector port. Transceiver type will be read-only for pureuser. If nothing is plugged into QSFP port, value will be Unused and type cannot be auto-detected, and internal user has not specified a type - value will be Unknown. If transceiver is plugged in, and type is auto-detected, and/or type has been explicitly set by internal user - that value will be shown. Transceiver type is not applicable for RJ-45 connectors.

  • connector_type (str) – Form-factor of the interface. Valid values include QSFP and RJ-45.

  • port_count (int) – Configured number of ports in the connector (1/2/4 for QSFP).

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

HardwareConnectorPerformance

class pypureclient.flashblade.HardwareConnectorPerformance(name=None, id=None, link_aggregation_group=None, received_crc_errors_per_sec=None, transmitted_dropped_errors_per_sec=None, transmitted_packets_per_sec=None, transmitted_carrier_errors_per_sec=None, transmitted_bytes_per_sec=None, received_bytes_per_sec=None, received_frame_errors_per_sec=None, other_errors_per_sec=None, time=None, total_errors_per_sec=None, received_packets_per_sec=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, link_aggregation_group=None, received_crc_errors_per_sec=None, transmitted_dropped_errors_per_sec=None, transmitted_packets_per_sec=None, transmitted_carrier_errors_per_sec=None, transmitted_bytes_per_sec=None, received_bytes_per_sec=None, received_frame_errors_per_sec=None, other_errors_per_sec=None, time=None, total_errors_per_sec=None, received_packets_per_sec=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • link_aggregation_group (FixedReference) – The link aggregation group which this entity belongs to.

  • received_crc_errors_per_sec (int) – Reception CRC errors per second.

  • transmitted_dropped_errors_per_sec (int) – Transmitted packets dropped per second.

  • transmitted_packets_per_sec (int) – Packets transmitted per second.

  • transmitted_carrier_errors_per_sec (int) – Transmission carrier errors per second.

  • transmitted_bytes_per_sec (int) – Bytes transmitted per second.

  • received_bytes_per_sec (int) – Bytes received per second.

  • received_frame_errors_per_sec (int) – Received packet frame errors per second.

  • other_errors_per_sec (int) – The sum of unspecified reception and transmission errors per second.

  • time (int) – Sample time in milliseconds since UNIX epoch.

  • total_errors_per_sec (int) – The sum of all reception and transmission errors per second.

  • received_packets_per_sec (int) – Packets received per second.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Http

class pypureclient.flashblade.Http(enabled=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(enabled=None)
Keyword Arguments

enabled (bool) – Is the protocol enabled? If not specified, defaults to false.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Index

class pypureclient.flashblade.Index(index=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(index=None)
Keyword Arguments

index (int) – Index of the object in the containing array.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Keytab

class pypureclient.flashblade.Keytab(name=None, id=None, encryption_type=None, principal=None, server=None, fqdn=None, prefix=None, realm=None, source=None, suffix=None, kvno=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, encryption_type=None, principal=None, server=None, fqdn=None, prefix=None, realm=None, source=None, suffix=None, kvno=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • encryption_type (str) – The encryption type used by the Kerberos key distribution center to generate the keytab.

  • principal (str) – The service name for which the keytab was issued.

  • server (FixedReference) – The server where the keytab is used.

  • fqdn (str) – The fully qualified domain name to which the keytab was issued.

  • prefix (str) – The prefix in the name of the keytab object. This is the same for all keytab objects created from a single keytab file. The name of a keytab entry is created in the format <prefix>.<suffix> for all entries.

  • realm (str) – The Kerberos realm that issued the keytab.

  • source (FixedReference) – A reference to the Active Directory configuration for the computer account that was used to create this keytab. If this keytab was uploaded from a file, all fields in the reference possess null values.

  • suffix (int) – The suffix in the name of the keytab object, determined at creation time using the slot number of the keytab entry in a file and the number of existing entries with the same prefix. The name of a keytab entry is created in the format <prefix>.<suffix> for all entries.

  • kvno (int) – The key version number of the key used to generate the keytab.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

KeytabFileBase64

class pypureclient.flashblade.KeytabFileBase64
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__()

Keyword args:

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

KeytabFileBinary

class pypureclient.flashblade.KeytabFileBinary
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__()

Keyword args:

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

KeytabPost

class pypureclient.flashblade.KeytabPost(source=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(source=None)
Keyword Arguments

source (Reference) – A reference to the Active Directory configuration for the computer account whose keys will be rotated in order to create new keytabs for all of its registered service principal names.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

KmipServer

class pypureclient.flashblade.KmipServer(name=None, id=None, ca_certificate=None, uris=None, ca_certificate_group=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, ca_certificate=None, uris=None, ca_certificate_group=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • ca_certificate (Reference) – CA certificate used to validate the authenticity of the configured servers.

  • uris (list[str]) – List of URIs for the configured KMIP servers in the format [protocol://]hostname:port.

  • ca_certificate_group (Reference) – A certificate group containing CA certificates that can be used to validate the authenticity of the configured servers.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

LegalHold

class pypureclient.flashblade.LegalHold(name=None, id=None, description=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, description=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • description (str) – The description of the legal hold instance.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

LegalHoldHeldEntity

class pypureclient.flashblade.LegalHoldHeldEntity(path=None, file_system=None, legal_hold=None, status=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(path=None, file_system=None, legal_hold=None, status=None)
Keyword Arguments

  • path (str) – The path of the file or directory being held.

  • file_system (FixedReference) – Reference to the file system that the legal hold is applied to.

  • legal_hold (FixedReference) – Reference to the legal hold.

  • status (str) – The status of the legal hold with respect to the held entity. Valid values include: applied for holds that are actively applied, applying for holds that are being recursively applied but have not yet completed, releasing for holds that are being released recursively but have not yet completed. Entities that are releasing will no longer be held once this operation completes.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

LifecycleRule

class pypureclient.flashblade.LifecycleRule(name=None, id=None, context=None, keep_current_version_until=None, abort_incomplete_multipart_uploads_after=None, keep_current_version_for=None, bucket=None, rule_id=None, prefix=None, keep_previous_version_for=None, enabled=None, cleanup_expired_object_delete_marker=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, context=None, keep_current_version_until=None, abort_incomplete_multipart_uploads_after=None, keep_current_version_for=None, bucket=None, rule_id=None, prefix=None, keep_previous_version_for=None, enabled=None, cleanup_expired_object_delete_marker=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • context (Reference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • keep_current_version_until (int) – Time after which current versions will be marked expired. Measured in milliseconds, time since epoch. Must be a valid date, accurate to day.

  • abort_incomplete_multipart_uploads_after (int) – Duration of time after which incomplete multipart uploads will be aborted. Measured in milliseconds. Must be a multiple of 86400000 to represent a whole number of days.

  • keep_current_version_for (int) – Time after which current versions will be marked expired. Measured in milliseconds. Must be a multiple of 86400000 to represent a whole number of days.

  • bucket (FixedReference) – The bucket which this lifecycle rule is targeting.

  • rule_id (str) – Unique identifier for the rule. Can have a maximum length of 255 characters.

  • prefix (str) – Object key prefix identifying one or more objects in the bucket. Can have a maximum length of 1024 characters.

  • keep_previous_version_for (int) – Time after which previous versions will be marked expired. Measured in milliseconds. Must be a multiple of 86400000 to represent a whole number of days.

  • enabled (bool) – If set to true, this rule will be enabled.

  • cleanup_expired_object_delete_marker (bool) – Returns a value of true if the expired object delete markers will be removed.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

LifecycleRuleConfigExtension

class pypureclient.flashblade.LifecycleRuleConfigExtension(keep_current_version_until=None, abort_incomplete_multipart_uploads_after=None, keep_current_version_for=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(keep_current_version_until=None, abort_incomplete_multipart_uploads_after=None, keep_current_version_for=None)
Keyword Arguments

  • keep_current_version_until (int) – Time after which current versions will be marked expired. Measured in milliseconds, time since epoch. Must be a valid date, accurate to day.

  • abort_incomplete_multipart_uploads_after (int) – Duration of time after which incomplete multipart uploads will be aborted. Measured in milliseconds. Must be a multiple of 86400000 to represent a whole number of days.

  • keep_current_version_for (int) – Time after which current versions will be marked expired. Measured in milliseconds. Must be a multiple of 86400000 to represent a whole number of days.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

LifecycleRulePatch

class pypureclient.flashblade.LifecycleRulePatch(keep_current_version_until=None, abort_incomplete_multipart_uploads_after=None, keep_current_version_for=None, prefix=None, keep_previous_version_for=None, enabled=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(keep_current_version_until=None, abort_incomplete_multipart_uploads_after=None, keep_current_version_for=None, prefix=None, keep_previous_version_for=None, enabled=None)
Keyword Arguments

  • keep_current_version_until (int) – Time after which current versions will be marked expired. Measured in milliseconds, time since epoch. Must be a valid date, accurate to day.

  • abort_incomplete_multipart_uploads_after (int) – Duration of time after which incomplete multipart uploads will be aborted. Measured in milliseconds. Must be a multiple of 86400000 to represent a whole number of days.

  • keep_current_version_for (int) – Time after which current versions will be marked expired. Measured in milliseconds. Must be a multiple of 86400000 to represent a whole number of days.

  • prefix (str) – Object key prefix identifying one or more objects in the bucket. Can have a maximum length of 1024 characters.

  • keep_previous_version_for (int) – Time after which previous versions will be marked expired. Measured in milliseconds. Must be a multiple of 86400000 to represent a whole number of days.

  • enabled (bool) – If set to true, this rule will be enabled.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

LifecycleRulePost

class pypureclient.flashblade.LifecycleRulePost(keep_current_version_until=None, abort_incomplete_multipart_uploads_after=None, keep_current_version_for=None, bucket=None, rule_id=None, prefix=None, keep_previous_version_for=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(keep_current_version_until=None, abort_incomplete_multipart_uploads_after=None, keep_current_version_for=None, bucket=None, rule_id=None, prefix=None, keep_previous_version_for=None)
Keyword Arguments

  • keep_current_version_until (int) – Time after which current versions will be marked expired. Measured in milliseconds, time since epoch. Must be a valid date, accurate to day.

  • abort_incomplete_multipart_uploads_after (int) – Duration of time after which incomplete multipart uploads will be aborted. Measured in milliseconds. Must be a multiple of 86400000 to represent a whole number of days.

  • keep_current_version_for (int) – Time after which current versions will be marked expired. Measured in milliseconds. Must be a multiple of 86400000 to represent a whole number of days.

  • bucket (ReferenceWritable) – The bucket name for lifecycle rule creation.

  • rule_id (str) – Identifier for the rule that is unique to the bucket that it applies to. Can have a maximum length of 255 characters. If not specified, an id unique to the bucket will be generated in the format fbRuleId<number> where number increments, starting at 1.

  • prefix (str) – Object key prefix identifying one or more objects in the bucket. Can have a maximum length of 1024 characters.

  • keep_previous_version_for (int) – Time after which previous versions will be marked expired. Measured in milliseconds. Must be a multiple of 86400000 to represent a whole number of days.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

LinkAggregationGroup

class pypureclient.flashblade.LinkAggregationGroup(name=None, id=None, lag_speed=None, port_speed=None, mac_address=None, ports=None, status=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, lag_speed=None, port_speed=None, mac_address=None, ports=None, status=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • lag_speed (int) – Combined speed of all ports in the LAG in bits-per-second.

  • port_speed (int) – Configured speed of each port in the LAG in bits-per-second.

  • mac_address (str) – Unique MAC address assigned to the LAG.

  • ports (list[FixedReference]) – Ports associated with the LAG.

  • status (str) – Health status of the LAG. Valid values are critical, healthy, identifying, unclaimed, unhealthy, unrecognized, and unused.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Linkaggregationgroup

class pypureclient.flashblade.Linkaggregationgroup(remove_ports=None, add_ports=None, ports=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(remove_ports=None, add_ports=None, ports=None)
Keyword Arguments
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

LocationReference

class pypureclient.flashblade.LocationReference(name=None, resource_type=None, id=None, location=None, display_name=None, is_local=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, resource_type=None, id=None, location=None, display_name=None, is_local=None)
Keyword Arguments

  • name (str) – A name chosen by the user. Can be changed. Must be locally unique.

  • resource_type (str) – Type of the object (full name of the endpoint). Valid values are the unique part of the resource’s REST endpoint. For example, a reference to a file system would have a resource_type of file-systems.

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • location (Reference) – A reference to the location where the object is defined.

  • display_name (str) – Full name of the source with remote array information. Response will be same as source name for local file systems and policies.

  • is_local (bool) – Is the location reference to the local array or somewhere remote?

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Login

class pypureclient.flashblade.Login(username=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(username=None)
Keyword Arguments

username (str) – The username of the user.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

LogsAsync

class pypureclient.flashblade.LogsAsync(name=None, id=None, available_files=None, start_time=None, end_time=None, processing=None, progress=None, hardware_components=None, last_request_time=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, available_files=None, start_time=None, end_time=None, processing=None, progress=None, hardware_components=None, last_request_time=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • available_files (list[FileInfo]) – All of the available files ready for download.

  • start_time (int) – When the time window starts (in milliseconds since epoch). start_time and end_time determine the number of hours for which the logs are prepared for. At most 6 hours of logs can be prepared in one request. start_time and end_time are truncated to hour boundaries.

  • end_time (int) – When the time window ends (in milliseconds since epoch). start_time and end_time determine the number of hours for which the logs are prepared for. At most 6 hours of logs can be prepared in one request. start_time and end_time are truncated to hour boundaries.

  • processing (bool) – Returns a value of true if the logs are being prepared.

  • progress (float) – A representation of log preparation progress. Ranges from 0 to 1.0.

  • hardware_components (list[FixedReference]) – All of the hardware components for which logs are being processed.

  • last_request_time (int) – The last time log preparation was requested (in milliseconds since epoch).

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

MaintenanceWindow

class pypureclient.flashblade.MaintenanceWindow(name=None, id=None, expires=None, created=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, expires=None, created=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • expires (int) – The maintenance window end time, measured in milliseconds since the UNIX epoch.

  • created (int) – The maintenance window start time, measured in milliseconds since the UNIX epoch.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

MaintenanceWindowPost

class pypureclient.flashblade.MaintenanceWindowPost(timeout=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(timeout=None)
Keyword Arguments

timeout (int) – Duration of a maintenance window measured in milliseconds. The names and timeout parameters must be set together, and the names parameter must be set to array.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Member

class pypureclient.flashblade.Member(member=None, group=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(member=None, group=None)
Keyword Arguments

  • member (Reference) – A reference to an object that is a member of the referenced group.

  • group (Reference) – A reference to a group object that has the referenced member object as a member.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

MultiProtocol

class pypureclient.flashblade.MultiProtocol(safeguard_acls=None, access_control_style=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(safeguard_acls=None, access_control_style=None)
Keyword Arguments

  • safeguard_acls (bool) – If set to true, prevents NFS clients from erasing a configured ACL when setting NFS mode bits. If this is true, then attempts to set mode bits on a file or directory will fail if they cannot be combined with the existing ACL set on a file or directory without erasing the ACL. Attempts to set mode bits that would not erase an existing ACL will still succeed and the mode bit changes will be merged with the existing ACL. This must be false when access_control_style is set to either independent or mode-bits.

  • access_control_style (str) – The access control style that is utilized for client actions such as setting file and directory ACLs. Possible values include nfs, smb, shared, independent, and mode-bits. If nfs is specified, then SMB clients will be unable to set permissions on files and directories. If smb is specified, then NFS clients will be unable to set permissions on files and directories. If shared is specified, then NFS and SMB clients will both be able to set permissions on files and directories. Any client will be able to overwrite the permissions set by another client, regardless of protocol. If independent is specified, then NFS and SMB clients will both be able to set permissions on files and directories, and can access files and directories created over any protocol. Permissions set by SMB clients will not affect NFS clients and vice versa. NFS clients will be restricted to only using mode bits to set permissions. If mode-bits is specified, then NFS and SMB clients will both be able to set permissions on files and directories, but only mode bits may be used to set permissions for NFS clients. When SMB clients set an ACL, it will be converted to have the same permission granularity as NFS mode bits.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

MultiProtocolPost

class pypureclient.flashblade.MultiProtocolPost(safeguard_acls=None, access_control_style=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(safeguard_acls=None, access_control_style=None)
Keyword Arguments

  • safeguard_acls (bool) – If set to true, prevents NFS clients from erasing a configured ACL when setting NFS mode bits. If this is true, then attempts to set mode bits on a file or directory will fail if they cannot be combined with the existing ACL set on a file or directory without erasing the ACL. Attempts to set mode bits that would not erase an existing ACL will still succeed and the mode bit changes will be merged with the existing ACL. This must be false when access_control_style is set to either independent or mode-bits. Defaults to true.

  • access_control_style (str) – The access control style that is utilized for client actions such as setting file and directory ACLs. Possible values include nfs, smb, shared, independent, and mode-bits. If nfs is specified, then SMB clients will be unable to set permissions on files and directories. If smb is specified, then NFS clients will be unable to set permissions on files and directories. If shared is specified, then NFS and SMB clients will both be able to set permissions on files and directories. Any client will be able to overwrite the permissions set by another client, regardless of protocol. If independent is specified, then NFS and SMB clients will both be able to set permissions on files and directories, and can access files and directories created over any protocol. Permissions set by SMB clients will not affect NFS clients and vice versa. NFS clients will be restricted to only using mode bits to set permissions. If mode-bits is specified, then NFS and SMB clients will both be able to set permissions on files and directories, but only mode bits may be used to set permissions for NFS clients. When SMB clients set an ACL, it will be converted to have the same permission granularity as NFS mode bits. Defaults to shared.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

NetworkAccessPolicy

class pypureclient.flashblade.NetworkAccessPolicy(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, version=None, rules=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, version=None, rules=None)
Keyword Arguments

  • name (str) – A name chosen by the user. Can be changed. Must be locally unique.

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • policy_type (str) – Type of the policy. Valid values include alert, audit, bucket-access, cross-origin-resource-sharing, network-access, nfs, object-access, smb-client, smb-share, snapshot, ssh-certificate-authority, and worm-data.

  • location (FixedReference) – Reference to the array where the policy is defined.

  • is_local (bool) – Whether the policy is defined on the local array.

  • enabled (bool) – If true, the policy is enabled. If not specified, defaults to true.

  • version (str) – A hash of the other properties of this resource. This can be used when updating the resource to ensure there aren’t any updates since the resource was read.

  • rules (list[NetworkAccessPolicyRuleInPolicy]) – All of the rules that are part of this policy. The order is the evaluation order. If a client does not match any rule in the policy for the interface that they are attempting to access, the default is to deny access.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

NetworkAccessPolicyRule

class pypureclient.flashblade.NetworkAccessPolicyRule(name=None, id=None, policy_version=None, interfaces=None, effect=None, client=None, policy=None, index=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, policy_version=None, interfaces=None, effect=None, client=None, policy=None, index=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • policy_version (str) – The policy’s version. This can be used when updating the resource to ensure there aren’t any updates to the policy since the resource was read.

  • interfaces (list[str]) – Specifies which product interfaces this rule applies to, whether it is permitting or denying access. Valid values include management-ssh, management-rest-api, management-web-ui, snmp, and local-network-superuser-password-access.

  • effect (str) – If set to allow, the specified client will be permitted to access the specified interfaces. If set to deny, the specified client will be denied access to them. Valid values include allow and deny.

  • client (str) – Specifies the clients that will be permitted or denied access to the interface. Accepted notations include a single IP address, subnet in CIDR notation, or all clients (specified as *). The default value is * if not specified.

  • policy (FixedReference) – The policy to which this rule belongs.

  • index (int) – The index within the policy. The index indicates the order the rules are evaluated. NOTE: It is recommended to use the query param before_rule_id to do reordering to avoid concurrency issues, but changing index is also supported. index can not be changed if before_rule_id or before_rule_name are specified.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

NetworkAccessPolicyRuleBase

class pypureclient.flashblade.NetworkAccessPolicyRuleBase(name=None, id=None, policy_version=None, interfaces=None, effect=None, client=None, policy=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, policy_version=None, interfaces=None, effect=None, client=None, policy=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • policy_version (str) – The policy’s version. This can be used when updating the resource to ensure there aren’t any updates to the policy since the resource was read.

  • interfaces (list[str]) – Specifies which product interfaces this rule applies to, whether it is permitting or denying access. Valid values include management-ssh, management-rest-api, management-web-ui, snmp, and local-network-superuser-password-access.

  • effect (str) – If set to allow, the specified client will be permitted to access the specified interfaces. If set to deny, the specified client will be denied access to them. Valid values include allow and deny.

  • client (str) – Specifies the clients that will be permitted or denied access to the interface. Accepted notations include a single IP address, subnet in CIDR notation, or all clients (specified as *). The default value is * if not specified.

  • policy (FixedReference) – The policy to which this rule belongs.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

NetworkAccessPolicyRuleInPolicy

class pypureclient.flashblade.NetworkAccessPolicyRuleInPolicy(name=None, id=None, policy_version=None, interfaces=None, effect=None, client=None, policy=None, index=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, policy_version=None, interfaces=None, effect=None, client=None, policy=None, index=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • policy_version (str) – The policy’s version. This can be used when updating the resource to ensure there aren’t any updates to the policy since the resource was read.

  • interfaces (list[str]) – Specifies which product interfaces this rule applies to, whether it is permitting or denying access. Valid values include management-ssh, management-rest-api, management-web-ui, snmp, and local-network-superuser-password-access.

  • effect (str) – If set to allow, the specified client will be permitted to access the specified interfaces. If set to deny, the specified client will be denied access to them. Valid values include allow and deny.

  • client (str) – Specifies the clients that will be permitted or denied access to the interface. Accepted notations include a single IP address, subnet in CIDR notation, or all clients (specified as *). The default value is * if not specified.

  • policy (FixedReference) – The policy to which this rule belongs.

  • index (int) – The index within the policy. The index indicates the order the rules are evaluated.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

NetworkAccessPolicyRulePost

class pypureclient.flashblade.NetworkAccessPolicyRulePost(name=None, id=None, interfaces=None, effect=None, client=None, index=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, interfaces=None, effect=None, client=None, index=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • interfaces (list[str]) – Specifies which product interfaces this rule applies to, whether it is permitting or denying access. Valid values include management-ssh, management-rest-api, management-web-ui, snmp, and local-network-superuser-password-access.

  • effect (str) – If set to allow, the specified client will be permitted to access the specified interfaces. If set to deny, the specified client will be denied access to them. Valid values include allow and deny. The default value is allow if not specified.

  • client (str) – Specifies the clients that will be permitted or denied access to the interface. Accepted notations include a single IP address, subnet in CIDR notation, or all clients (specified as *). The default value is * if not specified.

  • index (int) – The index within the policy. The index indicates the order the rules are evaluated. NOTE: It is recommended to use the query param before_rule_id to do reordering to avoid concurrency issues, but changing index is also supported. index can not be changed if before_rule_id or before_rule_name are specified.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

NetworkAccessPolicyRulePostBase

class pypureclient.flashblade.NetworkAccessPolicyRulePostBase(name=None, id=None, interfaces=None, effect=None, client=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, interfaces=None, effect=None, client=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • interfaces (list[str]) – Specifies which product interfaces this rule applies to, whether it is permitting or denying access. Valid values include management-ssh, management-rest-api, management-web-ui, snmp, and local-network-superuser-password-access.

  • effect (str) – If set to allow, the specified client will be permitted to access the specified interfaces. If set to deny, the specified client will be denied access to them. Valid values include allow and deny. The default value is allow if not specified.

  • client (str) – Specifies the clients that will be permitted or denied access to the interface. Accepted notations include a single IP address, subnet in CIDR notation, or all clients (specified as *). The default value is * if not specified.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

NetworkInterface

class pypureclient.flashblade.NetworkInterface(name=None, id=None, server=None, subnet=None, address=None, vlan=None, netmask=None, services=None, type=None, enabled=None, gateway=None, mtu=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, server=None, subnet=None, address=None, vlan=None, netmask=None, services=None, type=None, enabled=None, gateway=None, mtu=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • server (Reference) – The server that is using this interface for data ingress. Will be null if services does not include data. Defaults to _array_server when services does include data.

  • subnet (object) –

  • address (str) – The IPv4 or IPv6 address to be associated with the specified network interface.

  • vlan (int) – Derived from subnet.vlan.

  • netmask (str) – Derived from subnet.prefix.

  • services (list[str]) – Services and protocols that are enabled on the interface.

  • type (str) – The only valid value is vip.

  • enabled (bool) – Indicates if the specified network interface is enabled (true) or disabled (false). If not specified, defaults to true.

  • gateway (str) – Derived from subnet.gateway.

  • mtu (int) – Derived from subnet.mtu.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

NetworkInterfacePatch

class pypureclient.flashblade.NetworkInterfacePatch(server=None, address=None, services=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(server=None, address=None, services=None)
Keyword Arguments

  • server (Reference) – The server that is using this interface for data ingress. Will be null if services does not include data. Defaults to _array_server when services does include data.

  • address (str) – The IPv4 or IPv6 address to be associated with the specified network interface.

  • services (list[str]) – Services and protocols that are enabled on the interface.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

NetworkInterfacePing

class pypureclient.flashblade.NetworkInterfacePing(component_name=None, destination=None, details=None, source=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(component_name=None, destination=None, details=None, source=None)
Keyword Arguments

  • component_name (str) – Name of the component running the check.

  • destination (str) – The destination address or hostname provided in the request that the operation is run against.

  • details (str) – Giant text block that contains raw output of the operation and a client needs to parse.

  • source (str) – The address where the check starts. Can be a subnet or IP inside the subnet.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

NetworkInterfaceTrace

class pypureclient.flashblade.NetworkInterfaceTrace(component_name=None, destination=None, details=None, source=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(component_name=None, destination=None, details=None, source=None)
Keyword Arguments

  • component_name (str) – Name of the component running the check.

  • destination (str) – The destination address or hostname provided in the request that the operation is run against.

  • details (str) – Giant text block that contains raw output of the operation and a client needs to parse.

  • source (str) – The address where the check starts. Can be a subnet or IP inside the subnet.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

NetworkInterfacesConnectorsPerformance

class pypureclient.flashblade.NetworkInterfacesConnectorsPerformance(name=None, id=None, link_aggregation_group=None, received_crc_errors_per_sec=None, transmitted_dropped_errors_per_sec=None, transmitted_packets_per_sec=None, transmitted_carrier_errors_per_sec=None, transmitted_bytes_per_sec=None, received_bytes_per_sec=None, received_frame_errors_per_sec=None, other_errors_per_sec=None, time=None, total_errors_per_sec=None, received_packets_per_sec=None, flow_control_received_pause_frames_per_sec=None, rdma_received_req_cqe_errors_per_sec=None, flow_control_transmitted_lossless_bytes_per_sec=None, rdma_received_sequence_errors_per_sec=None, flow_control_transmitted_pause_frames_per_sec=None, flow_control_received_congestion_packets_per_sec=None, flow_control_transmitted_congestion_packets_per_sec=None, rdma_transmitted_local_ack_timeout_errors_per_sec=None, flow_control_received_discarded_packets_per_sec=None, flow_control_transmitted_discarded_packets_per_sec=None, flow_control_received_lossless_bytes_per_sec=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, link_aggregation_group=None, received_crc_errors_per_sec=None, transmitted_dropped_errors_per_sec=None, transmitted_packets_per_sec=None, transmitted_carrier_errors_per_sec=None, transmitted_bytes_per_sec=None, received_bytes_per_sec=None, received_frame_errors_per_sec=None, other_errors_per_sec=None, time=None, total_errors_per_sec=None, received_packets_per_sec=None, flow_control_received_pause_frames_per_sec=None, rdma_received_req_cqe_errors_per_sec=None, flow_control_transmitted_lossless_bytes_per_sec=None, rdma_received_sequence_errors_per_sec=None, flow_control_transmitted_pause_frames_per_sec=None, flow_control_received_congestion_packets_per_sec=None, flow_control_transmitted_congestion_packets_per_sec=None, rdma_transmitted_local_ack_timeout_errors_per_sec=None, flow_control_received_discarded_packets_per_sec=None, flow_control_transmitted_discarded_packets_per_sec=None, flow_control_received_lossless_bytes_per_sec=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • link_aggregation_group (FixedReference) – The link aggregation group which this entity belongs to.

  • received_crc_errors_per_sec (int) – Reception CRC errors per second.

  • transmitted_dropped_errors_per_sec (int) – Transmitted packets dropped per second.

  • transmitted_packets_per_sec (int) – Packets transmitted per second.

  • transmitted_carrier_errors_per_sec (int) – Transmission carrier errors per second.

  • transmitted_bytes_per_sec (int) – Bytes transmitted per second.

  • received_bytes_per_sec (int) – Bytes received per second.

  • received_frame_errors_per_sec (int) – Received packet frame errors per second.

  • other_errors_per_sec (int) – The sum of unspecified reception and transmission errors per second.

  • time (int) – Sample time in milliseconds since UNIX epoch.

  • total_errors_per_sec (int) – The sum of all reception and transmission errors per second.

  • received_packets_per_sec (int) – Packets received per second.

  • flow_control_received_pause_frames_per_sec (int) – Received pause frames per second.

  • rdma_received_req_cqe_errors_per_sec (int) – The number of times port detected RDMA CQEs with error per second.

  • flow_control_transmitted_lossless_bytes_per_sec (int) – Bytes transmitted per second with lossless flow control settings.

  • rdma_received_sequence_errors_per_sec (int) – The number of received RDMA packet sequence errors per second.

  • flow_control_transmitted_pause_frames_per_sec (int) – Transmitted pause frames per second.

  • flow_control_received_congestion_packets_per_sec (int) – Number of congestion control packets received per second.

  • flow_control_transmitted_congestion_packets_per_sec (int) – Number of congestion control packets transmitted per second.

  • rdma_transmitted_local_ack_timeout_errors_per_sec (int) – The number of times RDMA ack timer expired for QPs per second.

  • flow_control_received_discarded_packets_per_sec (int) – Number of received packets that were physically discarded per second due to errors or other reasons.

  • flow_control_transmitted_discarded_packets_per_sec (int) – Number of transmitted packets that were physically discarded by the NIC per second due to errors or other reasons.

  • flow_control_received_lossless_bytes_per_sec (int) – Bytes received per second with lossless flow control settings.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

NetworkInterfacesConnectorsSetting

class pypureclient.flashblade.NetworkInterfacesConnectorsSetting(name=None, id=None, roce=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, roce=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • roce (NetworkInterfacesConnectorsSettingRoce) – RoCE(RDMA over Converged Ethernet) configuration for network connectors.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

NetworkInterfacesConnectorsSettingRoce

class pypureclient.flashblade.NetworkInterfacesConnectorsSettingRoce(default_pfc=None, network_congestion_mode=None, default_ecn=None, trust_mode=None, enabled=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(default_pfc=None, network_congestion_mode=None, default_ecn=None, trust_mode=None, enabled=None)
Keyword Arguments

  • default_pfc (NetworkInterfacesConnectorsSettingRocePfc) – The default PFC(Priority Flow Control) setting for network connectors.

  • network_congestion_mode (str) – The RoCE network mode to be used. Valid values include lossy and lossless. For lossy mode, only Explicit Congestion Notification (ECN) is enabled. For lossless mode, both ECN and Priority Flow Control (PFC) are enabled.

  • default_ecn (NetworkInterfacesConnectorsSettingRoceEcn) – The default ECN(Explicit Congestion Notification) setting for network connectors.

  • trust_mode (str) – The trust mode of the RoCE network. Valid values include pcp and dscp.

  • enabled (bool) – If true, then RoCE networking is enabled. Otherwise, it is disabled.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

NetworkInterfacesConnectorsSettingRoceEcn

class pypureclient.flashblade.NetworkInterfacesConnectorsSettingRoceEcn(max_ecn_marked_threshold=None, min_ecn_marked_threshold=None, marking_probability=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(max_ecn_marked_threshold=None, min_ecn_marked_threshold=None, marking_probability=None)
Keyword Arguments

  • max_ecn_marked_threshold (int) – The maximum threshold value in bytes at which the packets start being marked with ECN at the highest probability or dropped.

  • min_ecn_marked_threshold (int) – The minimum threshold value in bytes at which the packets start being marked with ECN.

  • marking_probability (float) – The ECN marking probability when min ECN marked threshold is reached.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

NetworkInterfacesConnectorsSettingRocePfc

class pypureclient.flashblade.NetworkInterfacesConnectorsSettingRocePfc(xoff_threshold=None, xon_threshold=None, port_buffer=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(xoff_threshold=None, xon_threshold=None, port_buffer=None)
Keyword Arguments

  • xoff_threshold (int) – The PFC XOFF threshold value in bytes. When the buffer for a particular traffic class reaches this threshold, the pause frame(XOFF) will be transimitted to the sender, requesting it to stop sending packets for that class.

  • xon_threshold (int) – The PFC XON threshold value in bytes. When the buffer for a particular traffic class drops below this threshold, the un-pause frame(XON) will be transmitted to the sender, requesting it to resume sending packets for that class.

  • port_buffer (int) – The buffer size in bytes reserved to absorb in-flight packets after XOFF threshold is reached.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Nfs

class pypureclient.flashblade.Nfs(export_policy=None, v3_enabled=None, rules=None, v4_1_enabled=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(export_policy=None, v3_enabled=None, rules=None, v4_1_enabled=None)
Keyword Arguments

  • export_policy (ReferenceWritable) – Deprecated. See File System Exports for newer functionality. The value returned will be the policy of the File System Export for the default server, and NFS, with the export_name matching the file system name, if there is one and null otherwise. Modifying this field will still work. If the current value is null, then setting this field will attempt to create a File System Export with the policy and other default values. The export_name will be the same as the file system’s name. If the current value is not null, then setting this field will change the policy in the matching File System Export. Either the export_policy or rules will control the NFS export functionality for the file system. If this is set, then the rules field will be cleared. Both export_policy and rules can not be set in the same request.

  • v3_enabled (bool) – If set to true, the NFSv3 protocol will be enabled.

  • rules (str) – Deprecated. See File System Exports and NFS Export Policies for newer functionality. Modifying this field will still work, causing the matching File System Export to be deleted, if there is one. See export_policy. Both export_policy and rules can not be set in the same request. Rules can be applied to an individual client or a range of clients specified by IP address (ip_address(options)), netmask (ip_address/length(options)), netgroup (@groupname(options)), hostname (hostname(options)) (see RFC-1123 part 2.1), fully qualified domain name (host.exampledomain.com(options)) (see RFC-1123 part 2.1, RFC 2181 part 11), or wildcards with fully qualified domain name or hostname (*.exampledomain?.com(options)). Possible export options include rw, ro, fileid_32bit, no_fileid_32bit, anonuid, anongid, root_squash, no_root_squash, all_squash, no_all_squash, secure, insecure, atime, noatime, and sec. If not specified, defaults to *(rw,no_root_squash).

  • v4_1_enabled (bool) – If set to true, the NFSv4.1 protocol will be enabled.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

NfsExportPolicy

class pypureclient.flashblade.NfsExportPolicy(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, version=None, context=None, rules=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, version=None, context=None, rules=None)
Keyword Arguments

  • name (str) – A name chosen by the user. Can be changed. Must be locally unique.

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • policy_type (str) – Type of the policy. Valid values include alert, audit, bucket-access, cross-origin-resource-sharing, network-access, nfs, object-access, smb-client, smb-share, snapshot, ssh-certificate-authority, and worm-data.

  • location (FixedReference) – Reference to the array where the policy is defined.

  • is_local (bool) – Whether the policy is defined on the local array.

  • enabled (bool) – If true, the policy is enabled. If not specified, defaults to true.

  • version (str) – A hash of the other properties of this resource. This can be used when updating the resource to ensure there aren’t any updates since the resource was read.

  • context (Reference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • rules (list[NfsExportPolicyRuleInPolicy]) – All of the rules that are part of this policy. The order is the evaluation order.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

NfsExportPolicyPost

class pypureclient.flashblade.NfsExportPolicyPost(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, rules=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, rules=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • policy_type (str) – Type of the policy. Valid values include alert, audit, bucket-access, cross-origin-resource-sharing, network-access, nfs, object-access, smb-client, smb-share, snapshot, ssh-certificate-authority, and worm-data.

  • location (FixedReference) – Reference to the array where the policy is defined.

  • is_local (bool) – Whether the policy is defined on the local array.

  • enabled (bool) – If true, the policy is enabled. If not specified, defaults to true.

  • rules (list[NfsExportPolicyRuleInPolicy]) – All of the rules that are part of this policy. The order is the evaluation order.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

NfsExportPolicyRule

class pypureclient.flashblade.NfsExportPolicyRule(name=None, id=None, policy_version=None, security=None, access=None, atime=None, anonuid=None, anongid=None, fileid_32bit=None, client=None, permission=None, secure=None, policy=None, index=None, context=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, policy_version=None, security=None, access=None, atime=None, anonuid=None, anongid=None, fileid_32bit=None, client=None, permission=None, secure=None, policy=None, index=None, context=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • policy_version (str) – The policy’s version. This can be used when updating the resource to ensure there aren’t any updates to the policy since the resource was read.

  • security (list[str]) – The security flavors to use for accessing files on this mount point. If the server does not support the requested flavor, the mount operation fails. If sys, trusts the client to specify user’s identity. If krb5, provides cryptographic proof of a user’s identity in each RPC request. This provides strong verification of the identity of users accessing data on the server. Note that additional configuration besides adding this mount option is required in order to enable Kerberos security. If krb5i, adds integrity checking to krb5, to ensure the data has not been tampered with. If krb5p, adds integrity checking and encryption to krb5. This is the most secure setting, but it also involves the most performance overhead. The default is sys if not specified.

  • access (str) – Specifies access control for the export. Valid values are root-squash, all-squash, and no-squash. root-squash prevents client users and groups with root privilege from mapping their root privilege to a file system. All users with UID 0 will have their UID mapped to anonuid. All users with GID 0 will have their GID mapped to anongid. all-squash maps all UIDs (including root) to anonuid and all GIDs (including root) to anongid. no-squash allows users and groups to access the file system with their UIDs and GIDs. The default is root-squash if not specified.

  • atime (bool) – If true, after a read operation has occurred, the inode access time is updated only if any of the following conditions is true: the previous access time is less than the inode modify time, the previous access time is less than the inode change time, or the previous access time is more than 24 hours ago. If false, disables the update of inode access times after read operations. Defaults to true.

  • anonuid (str) – Any user whose UID is affected by an access of root_squash or all_squash will have their UID mapped to anonuid. The default anonuid is null, which means 65534. Use “” to clear.

  • anongid (str) – Any user whose GID is affected by an access of root_squash or all_squash will have their GID mapped to anongid. The default anongid is null, which means 65534. Use “” to clear.

  • fileid_32bit (bool) – Whether the file id is 32 bits or not. Defaults to false.

  • client (str) – Specifies the clients that will be permitted to access the export. Accepted notation is a single IP address, subnet in CIDR notation, netgroup, hostname (see RFC-1123 part 2.1), fully qualified domain name (see RFC-1123 part 2.1, RFC 2181 part 11), wildcards with fully qualified domain name or hostname, or anonymous (*). The default is * if not specified.

  • permission (str) – Specifies which read-write client access permissions are allowed for the export. Valid values are rw and ro. The default is ro if not specified.

  • secure (bool) – If true, prevents NFS access to client connections coming from non-reserved ports. Applies to NFSv3, NFSv4.1, and auxiliary protocols MOUNT and NLM. If false, allows NFS access to client connections coming from non-reserved ports. Applies to NFSv3, NFSv4.1, and auxiliary protocols MOUNT and NLM. The default is false if not specified.

  • policy (FixedReference) – The policy to which this rule belongs.

  • index (int) – The index within the policy. The index indicates the order the rules are evaluated. NOTE: It is recommended to use the query param before_rule_id to do reordering to avoid concurrency issues, but changing index is also supported. index can not be changed if before_rule_id or before_rule_name are specified.

  • context (Reference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

NfsExportPolicyRuleBase

class pypureclient.flashblade.NfsExportPolicyRuleBase(name=None, id=None, policy_version=None, security=None, access=None, atime=None, anonuid=None, anongid=None, fileid_32bit=None, client=None, permission=None, secure=None, policy=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, policy_version=None, security=None, access=None, atime=None, anonuid=None, anongid=None, fileid_32bit=None, client=None, permission=None, secure=None, policy=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • policy_version (str) – The policy’s version. This can be used when updating the resource to ensure there aren’t any updates to the policy since the resource was read.

  • security (list[str]) – The security flavors to use for accessing files on this mount point. If the server does not support the requested flavor, the mount operation fails. If sys, trusts the client to specify user’s identity. If krb5, provides cryptographic proof of a user’s identity in each RPC request. This provides strong verification of the identity of users accessing data on the server. Note that additional configuration besides adding this mount option is required in order to enable Kerberos security. If krb5i, adds integrity checking to krb5, to ensure the data has not been tampered with. If krb5p, adds integrity checking and encryption to krb5. This is the most secure setting, but it also involves the most performance overhead. The default is sys if not specified.

  • access (str) – Specifies access control for the export. Valid values are root-squash, all-squash, and no-squash. root-squash prevents client users and groups with root privilege from mapping their root privilege to a file system. All users with UID 0 will have their UID mapped to anonuid. All users with GID 0 will have their GID mapped to anongid. all-squash maps all UIDs (including root) to anonuid and all GIDs (including root) to anongid. no-squash allows users and groups to access the file system with their UIDs and GIDs. The default is root-squash if not specified.

  • atime (bool) – If true, after a read operation has occurred, the inode access time is updated only if any of the following conditions is true: the previous access time is less than the inode modify time, the previous access time is less than the inode change time, or the previous access time is more than 24 hours ago. If false, disables the update of inode access times after read operations. Defaults to true.

  • anonuid (str) – Any user whose UID is affected by an access of root_squash or all_squash will have their UID mapped to anonuid. The default anonuid is null, which means 65534. Use “” to clear.

  • anongid (str) – Any user whose GID is affected by an access of root_squash or all_squash will have their GID mapped to anongid. The default anongid is null, which means 65534. Use “” to clear.

  • fileid_32bit (bool) – Whether the file id is 32 bits or not. Defaults to false.

  • client (str) – Specifies the clients that will be permitted to access the export. Accepted notation is a single IP address, subnet in CIDR notation, netgroup, hostname (see RFC-1123 part 2.1), fully qualified domain name (see RFC-1123 part 2.1, RFC 2181 part 11), wildcards with fully qualified domain name or hostname, or anonymous (*). The default is * if not specified.

  • permission (str) – Specifies which read-write client access permissions are allowed for the export. Valid values are rw and ro. The default is ro if not specified.

  • secure (bool) – If true, prevents NFS access to client connections coming from non-reserved ports. Applies to NFSv3, NFSv4.1, and auxiliary protocols MOUNT and NLM. If false, allows NFS access to client connections coming from non-reserved ports. Applies to NFSv3, NFSv4.1, and auxiliary protocols MOUNT and NLM. The default is false if not specified.

  • policy (FixedReference) – The policy to which this rule belongs.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

NfsExportPolicyRuleInPolicy

class pypureclient.flashblade.NfsExportPolicyRuleInPolicy(name=None, id=None, policy_version=None, security=None, access=None, atime=None, anonuid=None, anongid=None, fileid_32bit=None, client=None, permission=None, secure=None, policy=None, index=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, policy_version=None, security=None, access=None, atime=None, anonuid=None, anongid=None, fileid_32bit=None, client=None, permission=None, secure=None, policy=None, index=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • policy_version (str) – The policy’s version. This can be used when updating the resource to ensure there aren’t any updates to the policy since the resource was read.

  • security (list[str]) – The security flavors to use for accessing files on this mount point. If the server does not support the requested flavor, the mount operation fails. If sys, trusts the client to specify user’s identity. If krb5, provides cryptographic proof of a user’s identity in each RPC request. This provides strong verification of the identity of users accessing data on the server. Note that additional configuration besides adding this mount option is required in order to enable Kerberos security. If krb5i, adds integrity checking to krb5, to ensure the data has not been tampered with. If krb5p, adds integrity checking and encryption to krb5. This is the most secure setting, but it also involves the most performance overhead. The default is sys if not specified.

  • access (str) – Specifies access control for the export. Valid values are root-squash, all-squash, and no-squash. root-squash prevents client users and groups with root privilege from mapping their root privilege to a file system. All users with UID 0 will have their UID mapped to anonuid. All users with GID 0 will have their GID mapped to anongid. all-squash maps all UIDs (including root) to anonuid and all GIDs (including root) to anongid. no-squash allows users and groups to access the file system with their UIDs and GIDs. The default is root-squash if not specified.

  • atime (bool) – If true, after a read operation has occurred, the inode access time is updated only if any of the following conditions is true: the previous access time is less than the inode modify time, the previous access time is less than the inode change time, or the previous access time is more than 24 hours ago. If false, disables the update of inode access times after read operations. Defaults to true.

  • anonuid (str) – Any user whose UID is affected by an access of root_squash or all_squash will have their UID mapped to anonuid. The default anonuid is null, which means 65534. Use “” to clear.

  • anongid (str) – Any user whose GID is affected by an access of root_squash or all_squash will have their GID mapped to anongid. The default anongid is null, which means 65534. Use “” to clear.

  • fileid_32bit (bool) – Whether the file id is 32 bits or not. Defaults to false.

  • client (str) – Specifies the clients that will be permitted to access the export. Accepted notation is a single IP address, subnet in CIDR notation, netgroup, hostname (see RFC-1123 part 2.1), fully qualified domain name (see RFC-1123 part 2.1, RFC 2181 part 11), wildcards with fully qualified domain name or hostname, or anonymous (*). The default is * if not specified.

  • permission (str) – Specifies which read-write client access permissions are allowed for the export. Valid values are rw and ro. The default is ro if not specified.

  • secure (bool) – If true, prevents NFS access to client connections coming from non-reserved ports. Applies to NFSv3, NFSv4.1, and auxiliary protocols MOUNT and NLM. If false, allows NFS access to client connections coming from non-reserved ports. Applies to NFSv3, NFSv4.1, and auxiliary protocols MOUNT and NLM. The default is false if not specified.

  • policy (FixedReference) – The policy to which this rule belongs.

  • index (int) – The index within the policy. The index indicates the order the rules are evaluated.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

NfsPatch

class pypureclient.flashblade.NfsPatch(export_policy=None, v3_enabled=None, rules=None, v4_1_enabled=None, add_rules=None, after=None, remove_rules=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(export_policy=None, v3_enabled=None, rules=None, v4_1_enabled=None, add_rules=None, after=None, remove_rules=None)
Keyword Arguments

  • export_policy (ReferenceWritable) – Deprecated. See File System Exports for newer functionality. The value returned will be the policy of the File System Export for the default server, and NFS, with the export_name matching the file system name, if there is one and null otherwise. Modifying this field will still work. If the current value is null, then setting this field will attempt to create a File System Export with the policy and other default values. The export_name will be the same as the file system’s name. If the current value is not null, then setting this field will change the policy in the matching File System Export. Either the export_policy or rules will control the NFS export functionality for the file system. If this is set, then the rules field will be cleared. Both export_policy and rules can not be set in the same request.

  • v3_enabled (bool) – If set to true, the NFSv3 protocol will be enabled.

  • rules (str) – Deprecated. See File System Exports and NFS Export Policies for newer functionality. Modifying this field will still work, causing the matching File System Export to be deleted, if there is one. See export_policy. Both export_policy and rules can not be set in the same request. Rules can be applied to an individual client or a range of clients specified by IP address (ip_address(options)), netmask (ip_address/length(options)), netgroup (@groupname(options)), hostname (hostname(options)) (see RFC-1123 part 2.1), fully qualified domain name (host.exampledomain.com(options)) (see RFC-1123 part 2.1, RFC 2181 part 11), or wildcards with fully qualified domain name or hostname (*.exampledomain?.com(options)). Possible export options include rw, ro, fileid_32bit, no_fileid_32bit, anonuid, anongid, root_squash, no_root_squash, all_squash, no_all_squash, secure, insecure, atime, noatime, and sec. If not specified, defaults to *(rw,no_root_squash).

  • v4_1_enabled (bool) – If set to true, the NFSv4.1 protocol will be enabled.

  • add_rules (str) – The rules which will be added to the existing NFS export rules for the file system. If export_policy is in use and and this field is set, the operation will fail.

  • after (str) – The after field can be used with add_rules or remove_rules or both. If used with add_rules, then the add_rules string will be inserted after the first occurrence of the after string. If used with remove_rules, then remove the first occurrence of remove_rules after the first occurrence of the after string. The remove_rules will be processed before the add_rules.

  • remove_rules (str) – The rules which will be removed from the existing NFS export rules for the file system. Only the first occurrence of the remove_rules will be removed. If export_policy is in use and and this field is set, the operation will fail.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ObjectBacklog

class pypureclient.flashblade.ObjectBacklog(delete_ops_count=None, bytes_count=None, put_ops_count=None, other_ops_count=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(delete_ops_count=None, bytes_count=None, put_ops_count=None, other_ops_count=None)
Keyword Arguments

  • delete_ops_count (int) – The number of DELETE operations that need to be replicated.

  • bytes_count (int) – The size of the objects in bytes that need to be replicated. This does not include the size of custom metadata.

  • put_ops_count (int) – The number of PUT operations that need to be replicated.

  • other_ops_count (int) – The number of other operations that need to be replicated.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ObjectLockConfigBase

class pypureclient.flashblade.ObjectLockConfigBase(enabled=None, freeze_locked_objects=None, default_retention_mode=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(enabled=None, freeze_locked_objects=None, default_retention_mode=None)
Keyword Arguments

  • enabled (bool) – If set to true, then S3 APIs relating to object lock may be used.

  • freeze_locked_objects (bool) – If set to true, a locked object will be read-only and no new versions of the object may be created due to modifications. If not specified, defaults to false.

  • default_retention_mode (str) – The retention mode used to apply locks on new objects if none is specified by the S3 client. Valid values include compliance and governance. If there is no default, this value is null. Use “” to clear.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ObjectLockConfigRequestBody

class pypureclient.flashblade.ObjectLockConfigRequestBody(enabled=None, freeze_locked_objects=None, default_retention_mode=None, default_retention=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(enabled=None, freeze_locked_objects=None, default_retention_mode=None, default_retention=None)
Keyword Arguments

  • enabled (bool) – If set to true, then S3 APIs relating to object lock may be used.

  • freeze_locked_objects (bool) – If set to true, a locked object will be read-only and no new versions of the object may be created due to modifications. If not specified, defaults to false.

  • default_retention_mode (str) – The retention mode used to apply locks on new objects if none is specified by the S3 client. Valid values include compliance and governance. If there is no default, this value is null. Use “” to clear.

  • default_retention (str) – The retention period, in milliseconds, used to apply locks on new objects if none is specified by the S3 client. Valid values are any multiple of 86400000 (1 day), up to 3153600000000 (36500 days). If there is no default, this value is null. Use “” to clear.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ObjectStoreAccessKey

class pypureclient.flashblade.ObjectStoreAccessKey(name=None, context=None, created=None, secret_access_key=None, user=None, enabled=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, context=None, created=None, secret_access_key=None, user=None, enabled=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • context (Reference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • created (int) – Creation timestamp of the object.

  • secret_access_key (str) – The secret access key, only populated on creation if it is not imported from another FlashBlade.

  • user (FixedReference) – Reference of the associated user.

  • enabled (bool) – Is the access key enabled? If not specified, defaults to false.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ObjectStoreAccessKeyPost

class pypureclient.flashblade.ObjectStoreAccessKeyPost(secret_access_key=None, user=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(secret_access_key=None, user=None)
Keyword Arguments

  • secret_access_key (str) – The secret access key to import from another FlashBlade. To import a set of credentials, this field must be specified with the names query parameter. If both of these not specified, the system will generate a new set of credentials.

  • user (object) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ObjectStoreAccessPolicy

class pypureclient.flashblade.ObjectStoreAccessPolicy(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, context=None, created=None, description=None, rules=None, arn=None, updated=None, account=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, context=None, created=None, description=None, rules=None, arn=None, updated=None, account=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • policy_type (str) – Type of the policy. Valid values include alert, audit, bucket-access, cross-origin-resource-sharing, network-access, nfs, object-access, smb-client, smb-share, snapshot, ssh-certificate-authority, and worm-data.

  • location (FixedReference) – Reference to the array where the policy is defined.

  • is_local (bool) – Whether the policy is defined on the local array.

  • enabled (bool) – If true, the policy is enabled. If not specified, defaults to true.

  • context (Reference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • created (int) – Creation timestamp of the object.

  • description (str) – A description of the policy, optionally specified when the policy is created. Cannot be modified for an existing policy.

  • rules (list[PolicyRuleObjectAccess]) –

  • arn (str) – Amazon Resource Name of the policy. Used when referencing the policy via S3 APIs.

  • updated (int) – The last updated timestamp of the object.

  • account (FixedReference) – Reference of the associated account. If the policy is not associated with an account, all fields in the reference possess null values.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ObjectStoreAccessPolicyAction

class pypureclient.flashblade.ObjectStoreAccessPolicyAction(name=None, context=None, description=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, context=None, description=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • context (Reference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • description (str) – A description of the action.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ObjectStoreAccessPolicyPatch

class pypureclient.flashblade.ObjectStoreAccessPolicyPatch(rules=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(rules=None)
Keyword Arguments

rules (list[PolicyRuleObjectAccessBulkManage]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ObjectStoreAccessPolicyPost

class pypureclient.flashblade.ObjectStoreAccessPolicyPost(rules=None, description=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(rules=None, description=None)
Keyword Arguments

  • rules (list[PolicyRuleObjectAccessBulkManage]) –

  • description (str) – A description of the policy, optionally specified when the policy is created. Cannot be modified for an existing policy.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ObjectStoreAccount

class pypureclient.flashblade.ObjectStoreAccount(name=None, id=None, context=None, quota_limit=None, bucket_defaults=None, hard_limit_enabled=None, public_access_config=None, created=None, object_count=None, space=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, context=None, quota_limit=None, bucket_defaults=None, hard_limit_enabled=None, public_access_config=None, created=None, object_count=None, space=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • context (Reference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • quota_limit (int) – The effective quota limit applied against the size of the account, displayed in bytes. If unset, the account is unlimited in size.

  • bucket_defaults (BucketDefaultsReadonly) – Default settings to be applied to newly created buckets associated with this account. Values here will be used in bucket creation requests which do not specify their own values for corresponding fields.

  • hard_limit_enabled (bool) – If set to true, the account’s size, as defined by quota_limit, is used as a hard limit quota. If set to false, a hard limit quota will not be applied to the account, but soft quota alerts will still be sent if the account has a value set for quota_limit.

  • public_access_config (PublicAccessConfig) –

  • created (int) – Creation timestamp of the object.

  • object_count (int) – The count of objects within the account.

  • space (Space) – The space specification of the object store account.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ObjectStoreAccountPatch

class pypureclient.flashblade.ObjectStoreAccountPatch(quota_limit=None, bucket_defaults=None, hard_limit_enabled=None, public_access_config=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(quota_limit=None, bucket_defaults=None, hard_limit_enabled=None, public_access_config=None)
Keyword Arguments

  • quota_limit (str) – The effective quota limit to be applied against the size of the account, displayed in bytes. If set to an empty string (“”), the account is unlimited in size.

  • bucket_defaults (BucketDefaults) – Default settings to be applied to newly created buckets associated with this account. Values here will be used in bucket creation requests which do not specify their own values for corresponding fields.

  • hard_limit_enabled (bool) – If set to true, the account’s size, as defined by quota_limit, is used as a hard limit quota. If set to false, a hard limit quota will not be applied to the account, but soft quota alerts will still be sent if the account has a value set for quota_limit.

  • public_access_config (PublicAccessConfig) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ObjectStoreAccountPost

class pypureclient.flashblade.ObjectStoreAccountPost(quota_limit=None, bucket_defaults=None, hard_limit_enabled=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(quota_limit=None, bucket_defaults=None, hard_limit_enabled=None)
Keyword Arguments

  • quota_limit (str) – The effective quota limit to be applied against the size of the account, displayed in bytes. If set to an empty string (“”), the account is unlimited in size. If not specified, defaults to unlimited.

  • bucket_defaults (BucketDefaults) – Default settings to be applied to newly created buckets associated with this account. Values here will be used in bucket creation requests which do not specify their own values for corresponding fields.

  • hard_limit_enabled (bool) – If set to true, the account’s size, as defined by quota_limit, is used as a hard limit quota. If set to false, a hard limit quota will not be applied to the account, but soft quota alerts will still be sent if the account has a value set for quota_limit. If not specified, defaults to false.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ObjectStoreRemoteCredentialGetResp

class pypureclient.flashblade.ObjectStoreRemoteCredentialGetResp(continuation_token=None, total_item_count=None, errors=None, items=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(continuation_token=None, total_item_count=None, errors=None, items=None)
Keyword Arguments

  • continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation_token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation_token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

  • total_item_count (int) – Total number of items after applying filter params.

  • errors (list[ErrorContextResponseErrors]) – The list of errors encountered when attempting to perform an operation.

  • items (list[ObjectStoreRemoteCredentials]) – A list of object store remote credentials.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ObjectStoreRemoteCredentials

class pypureclient.flashblade.ObjectStoreRemoteCredentials(name=None, id=None, context=None, access_key_id=None, secret_access_key=None, remote=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, context=None, access_key_id=None, secret_access_key=None, remote=None)
Keyword Arguments

  • name (str) – A name chosen by the user. Can be changed. Must be locally unique.

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • context (Reference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • access_key_id (str) – Access Key ID to be used when connecting to a remote object store.

  • secret_access_key (str) – Secret Access Key to be used when connecting to a remote object store.

  • remote (FixedReference) – Reference to the associated remote, which can either be a target or remote array. If it is an array, then the resource-type field will not be populated.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ObjectStoreRemoteCredentialsPost

class pypureclient.flashblade.ObjectStoreRemoteCredentialsPost(access_key_id=None, secret_access_key=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(access_key_id=None, secret_access_key=None)
Keyword Arguments

  • access_key_id (str) – Access Key ID to be used when connecting to a remote object store.

  • secret_access_key (str) – Secret Access Key to be used when connecting to a remote object store.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ObjectStoreRemoteCredentialsResp

class pypureclient.flashblade.ObjectStoreRemoteCredentialsResp(items=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(items=None)
Keyword Arguments

items (list[ObjectStoreRemoteCredentials]) – A list of object store remote credentials.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ObjectStoreRole

class pypureclient.flashblade.ObjectStoreRole(name=None, id=None, context=None, trusted_entities=None, created=None, prn=None, account=None, max_session_duration=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, context=None, trusted_entities=None, created=None, prn=None, account=None, max_session_duration=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • context (Reference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • trusted_entities (list[FixedReference]) – List of trusted entities

  • created (int) – Creation timestamp of the object.

  • prn (str) – Pure Resource Name of the role

  • account (FixedReference) – Reference of the associated account.

  • max_session_duration (int) – The maximum session duration for the role in milliseconds

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ObjectStoreRolePost

class pypureclient.flashblade.ObjectStoreRolePost(max_session_duration=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(max_session_duration=None)
Keyword Arguments

max_session_duration (int) – Maximum session duration in milliseconds. If not provided when creating the role, defaults to 1h, minimum is 1h, maximum is 12h.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ObjectStoreTrustPolicy

class pypureclient.flashblade.ObjectStoreTrustPolicy(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, context=None, role=None, rules=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, context=None, role=None, rules=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • policy_type (str) – Type of the policy. Valid values include alert, audit, bucket-access, cross-origin-resource-sharing, network-access, nfs, object-access, smb-client, smb-share, snapshot, ssh-certificate-authority, and worm-data.

  • location (FixedReference) – Reference to the array where the policy is defined.

  • is_local (bool) – Whether the policy is defined on the local array.

  • enabled (bool) – If true, the policy is enabled. If not specified, defaults to true.

  • context (Reference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • role (FixedReference) – Object Store Role to which the Trust Policy applies.

  • rules (list[TrustPolicyRule]) – List of rules establishing the trust policy

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ObjectStoreTrustPolicyIam

class pypureclient.flashblade.ObjectStoreTrustPolicyIam
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__()

Keyword args:

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ObjectStoreUser

class pypureclient.flashblade.ObjectStoreUser(name=None, id=None, context=None, created=None, access_keys=None, account=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, context=None, created=None, access_keys=None, account=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • context (Reference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • created (int) – Creation timestamp of the object.

  • access_keys (list[FixedReference]) – References of the user’s access keys.

  • account (FixedReference) – Reference of the associated account.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ObjectStoreVirtualHost

class pypureclient.flashblade.ObjectStoreVirtualHost(name=None, id=None, context=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, context=None)
Keyword Arguments

  • name (str) – A hostname by which the array can be addressed for virtual hosted-style S3 requests.

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • context (Reference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

OidcSso

class pypureclient.flashblade.OidcSso(name=None, id=None, idp=None, services=None, prn=None, enabled=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, idp=None, services=None, prn=None, enabled=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • idp (OidcSsoPostIdp) –

  • services (list[str]) – Services that the OIDC SSO authentication is used for. Valid values: object.

  • prn (str) – Pure Resource Name of the identity provider

  • enabled (bool) – If set to true, the OIDC SSO configuration is enabled.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

OidcSsoPatch

class pypureclient.flashblade.OidcSsoPatch(idp=None, services=None, prn=None, enabled=None, name=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(idp=None, services=None, prn=None, enabled=None, name=None)
Keyword Arguments

  • idp (OidcSsoPostIdp) –

  • services (list[str]) – Services that the OIDC SSO authentication is used for. Valid values: object.

  • prn (str) – Pure Resource Name of the identity provider

  • enabled (bool) – If set to true, the OIDC SSO configuration is enabled.

  • name (str) – A new name for the provider

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

OidcSsoPost

class pypureclient.flashblade.OidcSsoPost(idp=None, services=None, prn=None, enabled=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(idp=None, services=None, prn=None, enabled=None)
Keyword Arguments

  • idp (OidcSsoPostIdp) –

  • services (list[str]) – Services that the OIDC SSO authentication is used for. Valid values: object.

  • prn (str) – Pure Resource Name of the identity provider

  • enabled (bool) – If set to true, the OIDC SSO configuration is enabled.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

OidcSsoPostIdp

class pypureclient.flashblade.OidcSsoPostIdp(provider_url_ca_certificate_group=None, provider_url_ca_certificate=None, provider_url=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(provider_url_ca_certificate_group=None, provider_url_ca_certificate=None, provider_url=None)
Keyword Arguments

  • provider_url_ca_certificate_group (Reference) – A certificate group containing CA certificates that can be used to validate the authenticity of the configured Identity Provider server.

  • provider_url_ca_certificate (Reference) – CA certificate used to validate the authenticity of the configured Identity Provider server.

  • provider_url (str) – URL of the Identity Provider server

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

PageInfo

class pypureclient.flashblade.PageInfo(continuation_token=None, total_item_count=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(continuation_token=None, total_item_count=None)
Keyword Arguments

  • continuation_token (str) – Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation_token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation_token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

  • total_item_count (int) – Total number of items after applying filter params.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

PasswordPolicy

class pypureclient.flashblade.PasswordPolicy(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, enforce_dictionary_check=None, lockout_duration=None, min_password_length=None, min_character_groups=None, max_login_attempts=None, enforce_username_check=None, min_characters_per_group=None, password_history=None, min_password_age=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, enforce_dictionary_check=None, lockout_duration=None, min_password_length=None, min_character_groups=None, max_login_attempts=None, enforce_username_check=None, min_characters_per_group=None, password_history=None, min_password_age=None)
Keyword Arguments

  • name (str) – A name chosen by the user. Can be changed. Must be locally unique.

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • policy_type (str) – Type of the policy. Valid values include alert, audit, bucket-access, cross-origin-resource-sharing, network-access, nfs, object-access, smb-client, smb-share, snapshot, ssh-certificate-authority, and worm-data.

  • location (FixedReference) – Reference to the array where the policy is defined.

  • is_local (bool) – Whether the policy is defined on the local array.

  • enabled (bool) – If true, the policy is enabled. If not specified, defaults to true.

  • enforce_dictionary_check (bool) – If true, test password against dictionary of known leaked passwords. Requires passwords longer than 6 characters.

  • lockout_duration (int) – The lockout duration, in milliseconds, if a user is locked out after reaching the maximum number of login attempts. Ranges from 1 second to 90 days.

  • min_password_length (int) – Minimum password length. If not specified, defaults to 1.

  • min_character_groups (int) – The minimum number of character groups ([a-z], [A-Z], [0-9], other) required to be present in a password.

  • max_login_attempts (int) – Maximum number of failed login attempts allowed before the user is locked out.

  • enforce_username_check (bool) – If true, the username cannot be a substring of the password. Only applies to usernames of 4 characters and longer.

  • min_characters_per_group (int) – The minimum number of characters per group to count the group as present.

  • password_history (int) – The number of passwords tracked to prevent reuse of passwords.

  • min_password_age (int) – The minimum age, in milliseconds, of password before password change is allowed. Ranges from 0 ms to 7 days with precision to 1 hour.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Permission

class pypureclient.flashblade.Permission(resource_type=None, action=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(resource_type=None, action=None)
Keyword Arguments

  • resource_type (str) – The resource_type that this permission affects.

  • action (str) – The action that the user can perform on the resource_type. Typical values include get, patch, post, and delete. Values can also be finer grained.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Policy

class pypureclient.flashblade.Policy(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, context=None, rules=None, retention_lock=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, context=None, rules=None, retention_lock=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • policy_type (str) – Type of the policy. Valid values include alert, audit, bucket-access, cross-origin-resource-sharing, network-access, nfs, object-access, smb-client, smb-share, snapshot, ssh-certificate-authority, and worm-data.

  • location (FixedReference) – Reference to the array where the policy is defined.

  • is_local (bool) – Whether the policy is defined on the local array.

  • enabled (bool) – If true, the policy is enabled. If not specified, defaults to true.

  • context (Reference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • rules (list[PolicyRule]) –

  • retention_lock (str) – If retention lock is locked, then the the policy can not be removed from the associated file systems and the rules may not be changed. Valid values are locked and unlocked. Contact Pure Technical Services to change locked to unlocked.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

PolicyBase

class pypureclient.flashblade.PolicyBase(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • policy_type (str) – Type of the policy. Valid values include alert, audit, bucket-access, cross-origin-resource-sharing, network-access, nfs, object-access, smb-client, smb-share, snapshot, ssh-certificate-authority, and worm-data.

  • location (FixedReference) – Reference to the array where the policy is defined.

  • is_local (bool) – Whether the policy is defined on the local array.

  • enabled (bool) – If true, the policy is enabled. If not specified, defaults to true.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

PolicyBaseContext

class pypureclient.flashblade.PolicyBaseContext(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, context=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, context=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • policy_type (str) – Type of the policy. Valid values include alert, audit, bucket-access, cross-origin-resource-sharing, network-access, nfs, object-access, smb-client, smb-share, snapshot, ssh-certificate-authority, and worm-data.

  • location (FixedReference) – Reference to the array where the policy is defined.

  • is_local (bool) – Whether the policy is defined on the local array.

  • enabled (bool) – If true, the policy is enabled. If not specified, defaults to true.

  • context (Reference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

PolicyBaseRenameable

class pypureclient.flashblade.PolicyBaseRenameable(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None)
Keyword Arguments

  • name (str) – A name chosen by the user. Can be changed. Must be locally unique.

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • policy_type (str) – Type of the policy. Valid values include alert, audit, bucket-access, cross-origin-resource-sharing, network-access, nfs, object-access, smb-client, smb-share, snapshot, ssh-certificate-authority, and worm-data.

  • location (FixedReference) – Reference to the array where the policy is defined.

  • is_local (bool) – Whether the policy is defined on the local array.

  • enabled (bool) – If true, the policy is enabled. If not specified, defaults to true.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

PolicyFileSystemSnapshot

class pypureclient.flashblade.PolicyFileSystemSnapshot(member=None, policy=None, context=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(member=None, policy=None, context=None)
Keyword Arguments

  • member (FixedReference) – Reference to the resource the policy is applied to.

  • policy (LocationReference) – Reference to the policy.

  • context (Reference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

PolicyMember

class pypureclient.flashblade.PolicyMember(member=None, policy=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(member=None, policy=None)
Keyword Arguments
__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

PolicyMemberContext

class pypureclient.flashblade.PolicyMemberContext(member=None, policy=None, context=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(member=None, policy=None, context=None)
Keyword Arguments

  • member (FixedReference) – Reference to the resource the policy is applied to.

  • policy (FixedReference) – Reference to the policy.

  • context (Reference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

PolicyMemberWithRemote

class pypureclient.flashblade.PolicyMemberWithRemote(member=None, policy=None, context=None, link=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(member=None, policy=None, context=None, link=None)
Keyword Arguments

  • member (FixedReference) – Reference to the resource the policy is applied to.

  • policy (LocationReference) – Reference to the policy.

  • context (Reference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • link (MemberLink) – Only populated if the member is a file system replica link. Contains additional information about the link.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

PolicyPatch

class pypureclient.flashblade.PolicyPatch(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, context=None, rules=None, retention_lock=None, add_rules=None, remove_rules=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, context=None, rules=None, retention_lock=None, add_rules=None, remove_rules=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • policy_type (str) – Type of the policy. Valid values include alert, audit, bucket-access, cross-origin-resource-sharing, network-access, nfs, object-access, smb-client, smb-share, snapshot, ssh-certificate-authority, and worm-data.

  • location (FixedReference) – Reference to the array where the policy is defined.

  • is_local (bool) – Whether the policy is defined on the local array.

  • enabled (bool) – If true, the policy is enabled. If not specified, defaults to true.

  • context (Reference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • rules (list[PolicyRule]) –

  • retention_lock (str) – If retention lock is locked, then the the policy can not be removed from the associated file systems and the rules may not be changed. Valid values are locked and unlocked. Contact Pure Technical Services to change locked to unlocked.

  • add_rules (list[PolicyRule]) –

  • remove_rules (list[PolicyRule]) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

PolicyRule

class pypureclient.flashblade.PolicyRule(at=None, keep_for=None, time_zone=None, every=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(at=None, keep_for=None, time_zone=None, every=None)
Keyword Arguments

  • at (int) – Time during the day to take the snapshot (using array time zone), only valid if ‘every’ is in days.

  • keep_for (int) – The time to keep the snapshots for.

  • time_zone (str) – The time zone to use with the at time.

  • every (int) – How often to take snapshots.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

PolicyRuleIndex

class pypureclient.flashblade.PolicyRuleIndex(index=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(index=None)
Keyword Arguments

index (int) – The index within the policy. The index indicates the order the rules are evaluated. NOTE: It is recommended to use the query param before_rule_id to do reordering to avoid concurrency issues, but changing index is also supported. index can not be changed if before_rule_id or before_rule_name are specified.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

PolicyRuleIndexInPolicy

class pypureclient.flashblade.PolicyRuleIndexInPolicy(index=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(index=None)
Keyword Arguments

index (int) – The index within the policy. The index indicates the order the rules are evaluated.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

PolicyRuleObjectAccess

class pypureclient.flashblade.PolicyRuleObjectAccess(name=None, context=None, effect=None, resources=None, conditions=None, actions=None, policy=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, context=None, effect=None, resources=None, conditions=None, actions=None, policy=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • context (Reference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • effect (str) – Effect of this rule. When allow, the rule allows the given actions to be performed on the given resources, subject to the given conditions. When deny, the rule disallows performing the given actions on the given resources, subject to the given condition. This takes precedence over any matching allow rules. Valid values include allow and deny.

  • resources (list[str]) – The list of resources which this rule applies to. Each resource can include a bucket component, optionally followed by an object component. The choice of which components a resource can include is dictated by which actions are included in the rule. For further details, see the Object Store Access Policy Actions section of the User Guide.

  • conditions (PolicyRuleObjectAccessCondition) – Conditions used to limit the scope which this rule applies to.

  • actions (list[str]) – The list of actions granted by this rule. Each included action may restrict other properties of the rule. Supported actions are returned by the /object-store-access-policy-actions endpoint.

  • policy (FixedReference) – The policy to which this rule belongs.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

PolicyRuleObjectAccessBulkManage

class pypureclient.flashblade.PolicyRuleObjectAccessBulkManage(effect=None, resources=None, conditions=None, actions=None, name=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(effect=None, resources=None, conditions=None, actions=None, name=None)
Keyword Arguments

  • effect (str) – Effect of this rule. When allow, the rule allows the given actions to be performed on the given resources, subject to the given conditions. When deny, the rule disallows performing the given actions on the given resources, subject to the given condition. This takes precedence over any matching allow rules. Valid values include allow and deny.

  • resources (list[str]) – The list of resources which this rule applies to. Each resource can include a bucket component, optionally followed by an object component. The choice of which components a resource can include is dictated by which actions are included in the rule. For further details, see the Object Store Access Policy Actions section of the User Guide.

  • conditions (PolicyRuleObjectAccessCondition) – Conditions used to limit the scope which this rule applies to.

  • actions (list[str]) – The list of actions granted by this rule. Each included action may restrict other properties of the rule. Supported actions are returned by the /object-store-access-policy-actions endpoint.

  • name (str) – Name of the object (e.g., a file system or snapshot).

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

PolicyRuleObjectAccessCondition

class pypureclient.flashblade.PolicyRuleObjectAccessCondition(s3_delimiters=None, s3_prefixes=None, source_ips=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(s3_delimiters=None, s3_prefixes=None, source_ips=None)
Keyword Arguments

  • s3_delimiters (list[str]) – If specified, groups result objects by the specified delimiter. Only top-level groupings will be returned. Can be used with the s3:ListBucket and s3:ListBucketVersions actions.

  • s3_prefixes (list[str]) – If specified, restricts access and results based on the prefix of the relevant objects. Can be used with the s3:ListBucket and s3:ListBucketVersions actions.

  • source_ips (list[str]) – If specified, the rule will apply only to requests matching at least one provided IP address or subnet. Each entry must be in standard CIDR format (including an IP address without an associated routing prefix). Can be used with any action.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

PolicyRuleObjectAccessPost

class pypureclient.flashblade.PolicyRuleObjectAccessPost(effect=None, resources=None, conditions=None, actions=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(effect=None, resources=None, conditions=None, actions=None)
Keyword Arguments

  • effect (str) – Effect of this rule. When allow, the rule allows the given actions to be performed on the given resources, subject to the given conditions. When deny, the rule disallows performing the given actions on the given resources, subject to the given condition. This takes precedence over any matching allow rules. Valid values include allow and deny.

  • resources (list[str]) – The list of resources which this rule applies to. Each resource can include a bucket component, optionally followed by an object component. The choice of which components a resource can include is dictated by which actions are included in the rule. For further details, see the Object Store Access Policy Actions section of the User Guide.

  • conditions (PolicyRuleObjectAccessCondition) – Conditions used to limit the scope which this rule applies to.

  • actions (list[str]) – The list of actions granted by this rule. Each included action may restrict other properties of the rule. Supported actions are returned by the /object-store-access-policy-actions endpoint.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

PublicAccessConfig

class pypureclient.flashblade.PublicAccessConfig(block_public_access=None, block_new_public_policies=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(block_public_access=None, block_new_public_policies=None)
Keyword Arguments

  • block_public_access (bool) – If set to true, access to a bucket with a public policy is restricted to only authenticated users within the account that bucket belongs to.

  • block_new_public_policies (bool) – If set to true, adding bucket policies that grant public access to a bucket is not allowed.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

PublicKey

class pypureclient.flashblade.PublicKey(name=None, id=None, public_key=None, algorithm=None, key_size=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, public_key=None, algorithm=None, key_size=None)
Keyword Arguments

  • name (str) – A name chosen by the user. Can be changed. Must be locally unique.

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • public_key (str) – The text of the public key. May be PEM-formatted or OpenSSH-formatted at the time of input.

  • algorithm (str) – The cryptographic algorithm used by the key. Valid values include rsa, rsassa-pss, dsa, ec, and ed25519.

  • key_size (int) – The size of the public key in bits.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

PublicKeyPost

class pypureclient.flashblade.PublicKeyPost(public_key=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(public_key=None)
Keyword Arguments

public_key (str) – The text of the public key. May be PEM-formatted or OpenSSH-formatted at the time of input.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

PublicKeyUse

class pypureclient.flashblade.PublicKeyUse(name=None, id=None, use=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, use=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • use (FixedReference) – A reference to an object using this public key.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

QosPolicy

class pypureclient.flashblade.QosPolicy(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, max_total_bytes_per_sec=None, max_total_ops_per_sec=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, max_total_bytes_per_sec=None, max_total_ops_per_sec=None)
Keyword Arguments

  • name (str) – A name chosen by the user. Can be changed. Must be locally unique.

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • policy_type (str) – Type of the policy. Valid values include alert, audit, bucket-access, cross-origin-resource-sharing, network-access, nfs, object-access, smb-client, smb-share, snapshot, ssh-certificate-authority, and worm-data.

  • location (FixedReference) – Reference to the array where the policy is defined.

  • is_local (bool) – Whether the policy is defined on the local array.

  • enabled (bool) – If true, the policy is enabled. If not specified, defaults to true.

  • max_total_bytes_per_sec (int) – The maximum allowed bytes/s totaled across all the clients. Throttling occurs when the total bandwidth exceeds this limit. Minimum limit is 1MB/s and maximum limit is 512GB/s. If not specified at creation time, defaults to null to indicate no limit.

  • max_total_ops_per_sec (int) – The maximum allowed operations/s totaled across all the clients. Throttling occurs when the total IOPs exceeds this limit. Minimum limit is 100 IOPs/s and maximum limit is 100M IOPs/s. If not specified at creation time, defaults to null to indicate no limit.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

QuotaSetting

class pypureclient.flashblade.QuotaSetting(name=None, id=None, direct_notifications_enabled=None, contact=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, direct_notifications_enabled=None, contact=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • direct_notifications_enabled (bool) – Are notifications regarding space usage and quotas being sent directly to user and group emails?

  • contact (str) – The contact information that will be provided in any notifications sent directly to users and groups. This can be an email, a phone number, a name, or some other form of contact information.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

RapidDataLocking

class pypureclient.flashblade.RapidDataLocking(kmip_server=None, enabled=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(kmip_server=None, enabled=None)
Keyword Arguments

  • kmip_server (Reference) – The KMIP server configuration associated with RDL.

  • enabled (bool) – True if the Rapid Data Locking feature is enabled.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Reference

class pypureclient.flashblade.Reference(name=None, resource_type=None, id=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, resource_type=None, id=None)
Keyword Arguments

  • name (str) – A name chosen by the user. Can be changed. Must be locally unique.

  • resource_type (str) – Type of the object (full name of the endpoint). Valid values are the unique part of the resource’s REST endpoint. For example, a reference to a file system would have a resource_type of file-systems.

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ReferenceNameOnly

class pypureclient.flashblade.ReferenceNameOnly(name=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None)
Keyword Arguments

name (str) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ReferenceWritable

class pypureclient.flashblade.ReferenceWritable(name=None, resource_type=None, id=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, resource_type=None, id=None)
Keyword Arguments

  • name (str) – A name chosen by the user. Can be changed. Must be locally unique.

  • resource_type (str) – Type of the object (full name of the endpoint). Valid values are the unique part of the resource’s REST endpoint. For example, a reference to a file system would have a resource_type of file-systems.

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

RelationshipPerformanceReplication

class pypureclient.flashblade.RelationshipPerformanceReplication(id=None, context=None, periodic=None, continuous=None, time=None, aggregate=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(id=None, context=None, periodic=None, continuous=None, time=None, aggregate=None)
Keyword Arguments

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • context (Reference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • periodic (ReplicationPerformance) – Total bytes transmitted or received per second for periodic replication. Periodic replication includes file system replication, which is snapshot based.

  • continuous (ContinuousReplicationPerformance) – Object backlog information and total bytes transmitted or received per second for continuous replication. Continuous replication includes object replication.

  • time (int) – Sample time in milliseconds since UNIX epoch.

  • aggregate (ReplicationPerformance) – Total bytes transmitted or received per second for all types of replication.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

RemoteArray

class pypureclient.flashblade.RemoteArray(name=None, id=None, fleet=None, os=None, model=None, is_local=None, version=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, fleet=None, os=None, model=None, is_local=None, version=None)
Keyword Arguments

  • name (str) – A name chosen by the user. Can be changed. Must be locally unique.

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • fleet (FixedReferenceWithIsLocal) –

  • os (str) – Specifies the operating system. Valid values are Purity, Purity//FA, and Purity//FB.

  • model (str) – Specifies the array model.

  • is_local (bool) – If set to true, this array is the current array.

  • version (str) – Specifies the operating system version.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ReplicaLinkBuiltIn

class pypureclient.flashblade.ReplicaLinkBuiltIn(id=None, lag=None, status_details=None, direction=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(id=None, lag=None, status_details=None, direction=None)
Keyword Arguments

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • lag (int) – Duration in milliseconds that represents how far behind the replication target is from the source. This is the time difference between current time and recovery_point.

  • status_details (str) – Detailed information about the status of the replica link when it is unhealthy.

  • direction (Direction) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ReplicationPerformance

class pypureclient.flashblade.ReplicationPerformance(transmitted_bytes_per_sec=None, received_bytes_per_sec=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(transmitted_bytes_per_sec=None, received_bytes_per_sec=None)
Keyword Arguments

  • transmitted_bytes_per_sec (float) – Total bytes transmitted per second.

  • received_bytes_per_sec (float) – Total bytes received per second.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Resource

class pypureclient.flashblade.Resource(name=None, id=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None)
Keyword Arguments

  • name (str) – A name chosen by the user. Can be changed. Must be locally unique.

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ResourceFixedNonUniqueName

class pypureclient.flashblade.ResourceFixedNonUniqueName(name=None, id=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None)
Keyword Arguments

  • name (str) – Name of the resource. The name cannot be modified.

  • id (str) – A globally unique, system-generated ID. The ID cannot be modified.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ResourcePerformanceReplication

class pypureclient.flashblade.ResourcePerformanceReplication(name=None, id=None, periodic=None, continuous=None, time=None, aggregate=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, periodic=None, continuous=None, time=None, aggregate=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • periodic (ReplicationPerformance) – Total bytes transmitted or received per second for periodic replication. Periodic replication includes file system replication, which is snapshot based.

  • continuous (ContinuousReplicationPerformance) – Object backlog information and total bytes transmitted or received per second for continuous replication. Continuous replication includes object replication.

  • time (int) – Sample time in milliseconds since UNIX epoch.

  • aggregate (ReplicationPerformance) – Total bytes transmitted or received per second for all types of replication.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Role

class pypureclient.flashblade.Role(name=None, id=None, permissions=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, permissions=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • permissions (list[Permission]) – A list of permissions that the role can perform.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Saml2Sso

class pypureclient.flashblade.Saml2Sso(name=None, id=None, idp=None, binding=None, services=None, prn=None, sp=None, enabled=None, array_url=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, idp=None, binding=None, services=None, prn=None, sp=None, enabled=None, array_url=None)
Keyword Arguments

  • name (str) – A name chosen by the user. Can be changed. Must be locally unique.

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • idp (Saml2SsoIdp) –

  • binding (str) – SAML2 binding to use for the request from Flashblade to the Identity Provider. Valid values: http-redirect, none. Defaults to http-redirect.

  • services (list[str]) – Services that the SAML2 SSO authentication is used for. Valid values: management, object. Defaults to management.

  • prn (str) – Pure Resource Name of the identity provider

  • sp (Saml2SsoSp) –

  • enabled (bool) – If set to true, the SAML2 SSO configuration is enabled.

  • array_url (str) – The URL of the array.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Saml2SsoIdp

class pypureclient.flashblade.Saml2SsoIdp(verification_certificate=None, sign_request_enabled=None, metadata_url=None, encrypt_assertion_enabled=None, metadata_url_ca_certificate=None, metadata_url_ca_certificate_group=None, entity_id=None, url=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(verification_certificate=None, sign_request_enabled=None, metadata_url=None, encrypt_assertion_enabled=None, metadata_url_ca_certificate=None, metadata_url_ca_certificate_group=None, entity_id=None, url=None)
Keyword Arguments

  • verification_certificate (ReferenceWritable) – The certificate used by the service provider to verify the SAML response signature from the identity provider. The credential is managed by the certificates endpoint and purecert CLI commands.

  • sign_request_enabled (bool) – If set to true, SAML requests will be signed by the service provider.

  • metadata_url (str) – The URL of the identity provider metadata.

  • encrypt_assertion_enabled (bool) – If set to true, SAML assertions will be encrypted by the identity provider.

  • metadata_url_ca_certificate (ReferenceWritable) – CA certificate used to validate the authenticity of the configured Identity Provider server.

  • metadata_url_ca_certificate_group (ReferenceWritable) – A certificate group containing CA certificates that can be used to validate the authenticity of the configured Identity Provider server.

  • entity_id (str) – A globally unique name for the identity provider.

  • url (str) – The URL of the identity provider.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Saml2SsoPost

class pypureclient.flashblade.Saml2SsoPost(idp=None, binding=None, services=None, prn=None, sp=None, enabled=None, array_url=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(idp=None, binding=None, services=None, prn=None, sp=None, enabled=None, array_url=None)
Keyword Arguments

  • idp (Saml2SsoIdp) –

  • binding (str) – SAML2 binding to use for the request from Flashblade to the Identity Provider. Valid values: http-redirect, none. Defaults to http-redirect.

  • services (list[str]) – Services that the SAML2 SSO authentication is used for. Valid values: management, object. Defaults to management.

  • prn (str) – Pure Resource Name of the identity provider

  • sp (Saml2SsoSp) –

  • enabled (bool) – If set to true, the SAML2 SSO configuration is enabled.

  • array_url (str) – The URL of the array.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Saml2SsoSp

class pypureclient.flashblade.Saml2SsoSp(decryption_credential=None, signing_credential=None, metadata_url=None, assertion_consumer_url=None, entity_id=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(decryption_credential=None, signing_credential=None, metadata_url=None, assertion_consumer_url=None, entity_id=None)
Keyword Arguments

  • decryption_credential (ReferenceWritable) – The credential used by the service provider to decrypt encrypted SAML assertions from the identity provider. The credential is managed by the certificates endpoint and purecert CLI commands.

  • signing_credential (ReferenceWritable) – The credential used by the service provider to sign SAML requests. The credential is managed by the certificates endpoint and purecert CLI commands.

  • metadata_url (str) – The URL of the service provider metadata.

  • assertion_consumer_url (str) – The URL where the identity provider will send its SAML response after authenticating a user.

  • entity_id (str) – A globally unique name for the service provider.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Saml2SsoSpCredential

class pypureclient.flashblade.Saml2SsoSpCredential(decryption_credential=None, signing_credential=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(decryption_credential=None, signing_credential=None)
Keyword Arguments

  • decryption_credential (ReferenceWritable) – The credential used by the service provider to decrypt encrypted SAML assertions from the identity provider. The credential is managed by the certificates endpoint and purecert CLI commands.

  • signing_credential (ReferenceWritable) – The credential used by the service provider to sign SAML requests. The credential is managed by the certificates endpoint and purecert CLI commands.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Server

class pypureclient.flashblade.Server(name=None, id=None, directory_services=None, dns=None, created=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, directory_services=None, dns=None, created=None)
Keyword Arguments

  • name (str) – A name chosen by the user. Can be changed. Must be locally unique.

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • directory_services (list[Reference]) – The directory service config to be used by this server.

  • dns (list[Reference]) – The DNS config to be used by this server.

  • created (int) – Creation timestamp of the server.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ServerContext

class pypureclient.flashblade.ServerContext(name=None, id=None, directory_services=None, dns=None, created=None, context=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, directory_services=None, dns=None, created=None, context=None)
Keyword Arguments

  • name (str) – A name chosen by the user. Can be changed. Must be locally unique.

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • directory_services (list[Reference]) – The directory service config to be used by this server.

  • dns (list[Reference]) – The DNS config to be used by this server.

  • created (int) – Creation timestamp of the server.

  • context (Reference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ServerPost

class pypureclient.flashblade.ServerPost(directory_services=None, dns=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(directory_services=None, dns=None)
Keyword Arguments

  • directory_services (list[Reference]) – The directory service config to be used by this server.

  • dns (list[Reference]) – The DNS config to be used by this server.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Session

class pypureclient.flashblade.Session(name=None, id=None, start_time=None, identifying_details=None, method=None, event_count=None, end_time=None, user_interface=None, location=None, event=None, user=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, start_time=None, identifying_details=None, method=None, event_count=None, end_time=None, user_interface=None, location=None, event=None, user=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • start_time (int) – Date and time the user logged in to the Purity//FB interface in milliseconds since UNIX epoch.

  • identifying_details (str) – Additional details, depending on the authentication method used, which are necessary to uniquely identify who authenticated as a user. null if no additional details are needed.

  • method (str) – Method by which the user attempted to log in. Valid values include API token, password, ssh certificate, and public key.

  • event_count (int) – Number of session events.

  • end_time (int) – Date and time the user logged out of the Purity//FB interface in milliseconds since UNIX epoch. Set to 0 if the session is still active.

  • user_interface (str) – The user interface through which the user session event was performed. Valid values include CLI, GUI, and REST.

  • location (str) – IP address of the user client connecting to the array or console if connected through local console.

  • event (str) – Description of session events. Valid values include failed authentication, user session, login, logout, API token obtained, and request without session.

  • user (str) – Username of the Purity//FB user who triggered the user session event.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Smb

class pypureclient.flashblade.Smb(continuous_availability_enabled=None, share_policy=None, client_policy=None, enabled=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(continuous_availability_enabled=None, share_policy=None, client_policy=None, enabled=None)
Keyword Arguments

  • continuous_availability_enabled (bool) – If set to true, the file system will be continuously available during disruptive scenarios such as network disruption, blades failover, etc. If not specified, defaults to true.

  • share_policy (ReferenceWritable) – Deprecated. See File System Exports for newer functionality. The value returned will be the policy of the File System Export for the default server, and SMB, with the export_name matching the file system name, if there is one and null otherwise. Modifying this field will still work. If the current value is null, then setting this field will attempt to create a File System Export with the policy and other default values. The export_name will be the same as the file system’s name. If the current value is not null, then setting this field will change the policy in the matching File System Export. The SMB Share policy for the file system. Setting a policy here grants access permissions (e.g. allow or deny Full Control, Change, and/or Read) to the file system via SMB on a per-user / per-group basis. If no policy is set here, no user or group will have access. Use “” to clear.

  • client_policy (ReferenceWritable) – Deprecated. See File System Exports for newer functionality. The value returned will be the client_policy of the File System Export for the default server, and SMB, with the export_name matching the file system name, if there is one and null otherwise. Modifying this field will still work. If the current value is null, then setting this field will attempt to create a File System Export with the client_policy and other default values. The export_name will be the same as the file system’s name. If the current value is not null, then setting this field will change the client_policy in the matching File System Export. The SMB Client policy for the file system. Setting a policy here grants access permissions (e.g. read-only or read-write) to the file system via SMB on a per-client basis. If no policy is set here, no client will have access. Use “” to clear.

  • enabled (bool) – If set to true, enables access to the file system over the SMB protocol. If not specified, defaults to false.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SmbClientPolicy

class pypureclient.flashblade.SmbClientPolicy(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, version=None, context=None, access_based_enumeration_enabled=None, rules=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, version=None, context=None, access_based_enumeration_enabled=None, rules=None)
Keyword Arguments

  • name (str) – A name chosen by the user. Can be changed. Must be locally unique.

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • policy_type (str) – Type of the policy. Valid values include alert, audit, bucket-access, cross-origin-resource-sharing, network-access, nfs, object-access, smb-client, smb-share, snapshot, ssh-certificate-authority, and worm-data.

  • location (FixedReference) – Reference to the array where the policy is defined.

  • is_local (bool) – Whether the policy is defined on the local array.

  • enabled (bool) – If true, the policy is enabled. If not specified, defaults to true.

  • version (str) – A hash of the other properties of this resource. This can be used when updating the resource to ensure there aren’t any updates since the resource was read.

  • context (Reference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • access_based_enumeration_enabled (bool) – If set to true, enables access based enumeration on the policy. When access based enumeration is enabled on a policy, files and folders within exports that are attached to the policy will be hidden from users who do not have permission to view them. If not specified, defaults to false.

  • rules (list[SmbClientPolicyRuleInPolicy]) – All of the rules that are part of this policy. The order is the evaluation order.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SmbClientPolicyPost

class pypureclient.flashblade.SmbClientPolicyPost(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, access_based_enumeration_enabled=None, rules=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, access_based_enumeration_enabled=None, rules=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • policy_type (str) – Type of the policy. Valid values include alert, audit, bucket-access, cross-origin-resource-sharing, network-access, nfs, object-access, smb-client, smb-share, snapshot, ssh-certificate-authority, and worm-data.

  • location (FixedReference) – Reference to the array where the policy is defined.

  • is_local (bool) – Whether the policy is defined on the local array.

  • enabled (bool) – If true, the policy is enabled. If not specified, defaults to true.

  • access_based_enumeration_enabled (bool) – If set to true, enables access based enumeration on the policy. When access based enumeration is enabled on a policy, files and folders within exports that are attached to the policy will be hidden from users who do not have permission to view them. If not specified, defaults to false.

  • rules (list[SmbClientPolicyRulePostInPolicy]) – All of the rules that are part of this policy. The order is the evaluation order.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SmbClientPolicyRule

class pypureclient.flashblade.SmbClientPolicyRule(name=None, id=None, policy_version=None, encryption=None, client=None, permission=None, policy=None, index=None, context=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, policy_version=None, encryption=None, client=None, permission=None, policy=None, index=None, context=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • policy_version (str) – The policy’s version. This can be used when updating the resource to ensure there aren’t any updates to the policy since the resource was read.

  • encryption (str) – Specifies whether the remote client is required to use SMB encryption. Valid values are required, disabled, and optional.

  • client (str) – Specifies the clients that will be permitted to access the export. Accepted notation is a single IP address, subnet in CIDR notation, or anonymous (*).

  • permission (str) – Specifies which read-write client access permissions are allowed for the export. Valid values are rw and ro.

  • policy (FixedReference) – The policy to which this rule belongs.

  • index (int) – The index within the policy. The index indicates the order the rules are evaluated. NOTE: It is recommended to use the query param before_rule_id to do reordering to avoid concurrency issues, but changing index is also supported. index can not be changed if before_rule_id or before_rule_name are specified.

  • context (Reference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SmbClientPolicyRuleBase

class pypureclient.flashblade.SmbClientPolicyRuleBase(name=None, id=None, policy_version=None, encryption=None, client=None, permission=None, policy=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, policy_version=None, encryption=None, client=None, permission=None, policy=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • policy_version (str) – The policy’s version. This can be used when updating the resource to ensure there aren’t any updates to the policy since the resource was read.

  • encryption (str) – Specifies whether the remote client is required to use SMB encryption. Valid values are required, disabled, and optional.

  • client (str) – Specifies the clients that will be permitted to access the export. Accepted notation is a single IP address, subnet in CIDR notation, or anonymous (*).

  • permission (str) – Specifies which read-write client access permissions are allowed for the export. Valid values are rw and ro.

  • policy (FixedReference) – The policy to which this rule belongs.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SmbClientPolicyRuleInPolicy

class pypureclient.flashblade.SmbClientPolicyRuleInPolicy(name=None, id=None, policy_version=None, encryption=None, client=None, permission=None, policy=None, index=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, policy_version=None, encryption=None, client=None, permission=None, policy=None, index=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • policy_version (str) – The policy’s version. This can be used when updating the resource to ensure there aren’t any updates to the policy since the resource was read.

  • encryption (str) – Specifies whether the remote client is required to use SMB encryption. Valid values are required, disabled, and optional.

  • client (str) – Specifies the clients that will be permitted to access the export. Accepted notation is a single IP address, subnet in CIDR notation, or anonymous (*).

  • permission (str) – Specifies which read-write client access permissions are allowed for the export. Valid values are rw and ro.

  • policy (FixedReference) – The policy to which this rule belongs.

  • index (int) – The index within the policy. The index indicates the order the rules are evaluated.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SmbClientPolicyRulePost

class pypureclient.flashblade.SmbClientPolicyRulePost(name=None, id=None, encryption=None, client=None, permission=None, index=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, encryption=None, client=None, permission=None, index=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • encryption (str) – Specifies whether the remote client is required to use SMB encryption. Valid values are required, disabled, and optional. If not specified, defaults to optional.

  • client (str) – Specifies the clients that will be permitted to access the export. Accepted notation is a single IP address, subnet in CIDR notation, or anonymous (*). The default is * if not specified.

  • permission (str) – Specifies which read-write client access permissions are allowed for the export. Valid values are rw and ro. The default is ro if not specified.

  • index (int) – The index within the policy. The index indicates the order the rules are evaluated. NOTE: It is recommended to use the query param before_rule_id to do reordering to avoid concurrency issues, but changing index is also supported. index can not be changed if before_rule_id or before_rule_name are specified.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SmbClientPolicyRulePostBase

class pypureclient.flashblade.SmbClientPolicyRulePostBase(name=None, id=None, encryption=None, client=None, permission=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, encryption=None, client=None, permission=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • encryption (str) – Specifies whether the remote client is required to use SMB encryption. Valid values are required, disabled, and optional. If not specified, defaults to optional.

  • client (str) – Specifies the clients that will be permitted to access the export. Accepted notation is a single IP address, subnet in CIDR notation, or anonymous (*). The default is * if not specified.

  • permission (str) – Specifies which read-write client access permissions are allowed for the export. Valid values are rw and ro. The default is ro if not specified.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SmbClientPolicyRulePostInPolicy

class pypureclient.flashblade.SmbClientPolicyRulePostInPolicy(name=None, id=None, encryption=None, client=None, permission=None, index=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, encryption=None, client=None, permission=None, index=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • encryption (str) – Specifies whether the remote client is required to use SMB encryption. Valid values are required, disabled, and optional. If not specified, defaults to optional.

  • client (str) – Specifies the clients that will be permitted to access the export. Accepted notation is a single IP address, subnet in CIDR notation, or anonymous (*). The default is * if not specified.

  • permission (str) – Specifies which read-write client access permissions are allowed for the export. Valid values are rw and ro. The default is ro if not specified.

  • index (int) – The index within the policy. The index indicates the order the rules are evaluated.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SmbPost

class pypureclient.flashblade.SmbPost(continuous_availability_enabled=None, share_policy=None, client_policy=None, enabled=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(continuous_availability_enabled=None, share_policy=None, client_policy=None, enabled=None)
Keyword Arguments

  • continuous_availability_enabled (bool) – If set to true, the file system will be continuously available during disruptive scenarios such as network disruption, blades failover, etc. If not specified, defaults to true.

  • share_policy (ReferenceWritable) – The SMB Share policy for the file system. Setting a policy here grants access permissions (e.g. allow or deny Full Control, Change, and/or Read) to the file system via SMB on a per-user / per-group basis. Defaults to a pre-defined full access policy if none is specified.

  • client_policy (ReferenceWritable) – The SMB Client policy for the file system. Setting a policy here grants access permissions (e.g. read-only or read-write) to the file system via SMB on a per-client basis. Defaults to a pre-defined full access policy if none is specified.

  • enabled (bool) – If set to true, enables access to the file system over the SMB protocol. If not specified, defaults to false.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SmbSharePolicy

class pypureclient.flashblade.SmbSharePolicy(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, context=None, rules=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, context=None, rules=None)
Keyword Arguments

  • name (str) – A name chosen by the user. Can be changed. Must be locally unique.

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • policy_type (str) – Type of the policy. Valid values include alert, audit, bucket-access, cross-origin-resource-sharing, network-access, nfs, object-access, smb-client, smb-share, snapshot, ssh-certificate-authority, and worm-data.

  • location (FixedReference) – Reference to the array where the policy is defined.

  • is_local (bool) – Whether the policy is defined on the local array.

  • enabled (bool) – If true, the policy is enabled. If not specified, defaults to true.

  • context (Reference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • rules (list[SmbSharePolicyRule]) – All of the rules that are part of this policy.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SmbSharePolicyPost

class pypureclient.flashblade.SmbSharePolicyPost(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, rules=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, rules=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • policy_type (str) – Type of the policy. Valid values include alert, audit, bucket-access, cross-origin-resource-sharing, network-access, nfs, object-access, smb-client, smb-share, snapshot, ssh-certificate-authority, and worm-data.

  • location (FixedReference) – Reference to the array where the policy is defined.

  • is_local (bool) – Whether the policy is defined on the local array.

  • enabled (bool) – If true, the policy is enabled. If not specified, defaults to true.

  • rules (list[SmbSharePolicyRulePost]) – All of the rules that are part of this policy.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SmbSharePolicyRule

class pypureclient.flashblade.SmbSharePolicyRule(name=None, id=None, principal=None, full_control=None, read=None, change=None, policy=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, principal=None, full_control=None, read=None, change=None, policy=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • principal (str) – The user or group who is the subject of this rule, and their domain. If modifying this value, providing the domain is optional. If no domain is provided, it will be derived if possible. For example, PURESTORAGEAdministrator, samplegroup@PureStorage, or sampleuser.

  • full_control (str) – The state of the principal’s Full Control access permission. Valid values are allow and deny. When not set, value is null. When allowed, includes all access granted by the Change permission. Users can also change the permissions for files and folders. When denied, these operations are explicitly blocked. If not set for any applicable rule on any applicable policy, acts as an implicit deny. If set to allow, implicitly sets the Change and Read permissions to allow. This is incompatible with explicitly setting any permission to deny. If set to deny, implicitly sets the Change and Read permissions to deny. This is incompatible with explicitly setting any permission to allow. If set to an empty string (“”), the value will be cleared.

  • read (str) – The state of the principal’s Read access permission. Valid values are allow and deny. When allowed, users can view file names, read the data in those files, and run some programs. When denied, these operations are explicitly blocked. If set to allow, implicitly clears the Full Control and Change permissions if they are currently deny. This is incompatible with explicitly setting any permission to deny. If set to deny, implicitly clears the Full Control and Change permissions if they are currently allow. This is incompatible with explicitly setting any permission to allow.

  • change (str) – The state of the principal’s Change access permission. Valid values are allow and deny. When not set, value is null. When allowed, includes all access granted by the Read permission. Users can also change data within files and add or delete files and folders. When denied, these operations are explicitly blocked. If not set for any applicable rule on any applicable policy, acts as an implicit deny. If set to allow, implicitly sets the Read permission to allow. This is incompatible with explicitly setting any permission to deny. If set to deny, implicitly sets the Read permission to deny, and clears the Full Control permission if it is currently allow. This is incompatible with explicitly setting any permission to allow. If set to an empty string (“”), the value (and implicitly the Full Control permission) will be cleared. This is incompatible with explicitly setting the Full Control permission to allow or deny.

  • policy (FixedReference) – The policy to which this rule belongs.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SmbSharePolicyRulePost

class pypureclient.flashblade.SmbSharePolicyRulePost(name=None, id=None, principal=None, full_control=None, read=None, change=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, principal=None, full_control=None, read=None, change=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • principal (str) – The user or group who is the subject of this rule, and optionally their domain. If no domain is provided, it will be derived if possible. For example, PURESTORAGEAdministrator, samplegroup@PureStorage, or sampleuser.

  • full_control (str) – The state of the principal’s Full Control access permission. Valid values are allow and deny. When not set, value is null. When allowed, includes all access granted by the Change permission. Users can also change the permissions for files and folders. When denied, these operations are explicitly blocked. If not set for any applicable rule on any applicable policy, acts as an implicit deny. If set to allow, implicitly sets the Change and Read permissions to allow. This is incompatible with explicitly setting any permission to deny. If set to deny, implicitly sets the Change and Read permissions to deny. This is incompatible with explicitly setting any permission to allow. Defaults to null.

  • read (str) – The state of the principal’s Read access permission. Valid values are allow and deny. When allowed, users can view file names, read the data in those files, and run some programs. When denied, these operations are explicitly blocked. When setting to allow, cannot explicitly set any permission to deny. When setting to deny, cannot explicitly set any permission to allow.

  • change (str) – The state of the principal’s Change access permission. Valid values are allow and deny. When not set, value is null. When allowed, includes all access granted by the Read permission. Users can also change data within files and add or delete files and folders. When denied, these operations are explicitly blocked. If not set for any applicable rule on any applicable policy, acts as an implicit deny. If set to allow, implicitly sets the Read permission to allow. This is incompatible with explicitly setting any permission to deny. If set to deny, implicitly sets the Read permission to deny. This is incompatible with explicitly setting any permission to allow. Defaults to null.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SmbSharePolicyRuleWithContext

class pypureclient.flashblade.SmbSharePolicyRuleWithContext(name=None, id=None, principal=None, full_control=None, read=None, change=None, policy=None, context=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, principal=None, full_control=None, read=None, change=None, policy=None, context=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • principal (str) – The user or group who is the subject of this rule, and their domain. If modifying this value, providing the domain is optional. If no domain is provided, it will be derived if possible. For example, PURESTORAGEAdministrator, samplegroup@PureStorage, or sampleuser.

  • full_control (str) – The state of the principal’s Full Control access permission. Valid values are allow and deny. When not set, value is null. When allowed, includes all access granted by the Change permission. Users can also change the permissions for files and folders. When denied, these operations are explicitly blocked. If not set for any applicable rule on any applicable policy, acts as an implicit deny. If set to allow, implicitly sets the Change and Read permissions to allow. This is incompatible with explicitly setting any permission to deny. If set to deny, implicitly sets the Change and Read permissions to deny. This is incompatible with explicitly setting any permission to allow. If set to an empty string (“”), the value will be cleared.

  • read (str) – The state of the principal’s Read access permission. Valid values are allow and deny. When allowed, users can view file names, read the data in those files, and run some programs. When denied, these operations are explicitly blocked. If set to allow, implicitly clears the Full Control and Change permissions if they are currently deny. This is incompatible with explicitly setting any permission to deny. If set to deny, implicitly clears the Full Control and Change permissions if they are currently allow. This is incompatible with explicitly setting any permission to allow.

  • change (str) – The state of the principal’s Change access permission. Valid values are allow and deny. When not set, value is null. When allowed, includes all access granted by the Read permission. Users can also change data within files and add or delete files and folders. When denied, these operations are explicitly blocked. If not set for any applicable rule on any applicable policy, acts as an implicit deny. If set to allow, implicitly sets the Read permission to allow. This is incompatible with explicitly setting any permission to deny. If set to deny, implicitly sets the Read permission to deny, and clears the Full Control permission if it is currently allow. This is incompatible with explicitly setting any permission to allow. If set to an empty string (“”), the value (and implicitly the Full Control permission) will be cleared. This is incompatible with explicitly setting the Full Control permission to allow or deny.

  • policy (FixedReference) – The policy to which this rule belongs.

  • context (Reference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SmtpServer

class pypureclient.flashblade.SmtpServer(name=None, id=None, relay_host=None, encryption_mode=None, sender_domain=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, relay_host=None, encryption_mode=None, sender_domain=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • relay_host (str) – Relay server used as a forwarding point for email sent from the array. Can be set as a hostname, IPv4 address, or IPv6 address, with optional port numbers. The expected format for IPv4 is ddd.ddd.ddd.ddd:PORT. The expected format for IPv6 is xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx, or if a port number is specified, [xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx]:PORT.

  • encryption_mode (str) – Enforces an encryption mode when sending alert email messages. Valid values include starttls. Use “” to clear.

  • sender_domain (str) – Domain name appended to alert email messages.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SnmpAgent

class pypureclient.flashblade.SnmpAgent(name=None, id=None, engine_id=None, v2c=None, v3=None, version=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, engine_id=None, v2c=None, v3=None, version=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • engine_id (str) – An SNMP agent’s adminstration domain unique name.

  • v2c (SnmpV2c) –

  • v3 (SnmpV3) –

  • version (str) – Version of the SNMP protocol to be used by an SNMP manager in communications with Purity’s SNMP agent. Valid values are v2c and v3.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SnmpAgentMib

class pypureclient.flashblade.SnmpAgentMib(mib=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(mib=None)
Keyword Arguments

mib (str) – MIB text.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SnmpManager

class pypureclient.flashblade.SnmpManager(name=None, id=None, notification=None, v2c=None, host=None, v3=None, version=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, notification=None, v2c=None, host=None, v3=None, version=None)
Keyword Arguments

  • name (str) – A name chosen by the user. Can be changed. Must be locally unique.

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • notification (str) – The type of notification the agent will send. Valid values are inform and trap.

  • v2c (SnmpV2c) –

  • host (str) – DNS hostname or IP address of a computer that hosts an SNMP manager to which Purity is to send trap messages when it generates alerts.

  • v3 (SnmpV3) –

  • version (str) – Version of the SNMP protocol to be used by Purity in communications with the specified manager. Valid values are v2c and v3.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SnmpManagerPost

class pypureclient.flashblade.SnmpManagerPost(notification=None, v2c=None, host=None, v3=None, version=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(notification=None, v2c=None, host=None, v3=None, version=None)
Keyword Arguments

  • notification (str) – The type of notification the agent will send. Valid values are inform and trap.

  • v2c (SnmpV2c) –

  • host (str) – DNS hostname or IP address of a computer that hosts an SNMP manager to which Purity is to send trap messages when it generates alerts.

  • v3 (SnmpV3Post) –

  • version (str) – Version of the SNMP protocol to be used by Purity in communications with the specified manager. Valid values are v2c and v3.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SnmpManagerTest

class pypureclient.flashblade.SnmpManagerTest(name=None, id=None, error=None, sent=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, error=None, sent=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • error (str) – Error message (if failed).

  • sent (bool) – Is the test trap or inform sent?

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SnmpV2c

class pypureclient.flashblade.SnmpV2c(community=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(community=None)
Keyword Arguments

community (str) – Manager community ID under which Purity is to communicate with the specified managers.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SnmpV3

class pypureclient.flashblade.SnmpV3(auth_protocol=None, privacy_protocol=None, auth_passphrase=None, privacy_passphrase=None, user=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(auth_protocol=None, privacy_protocol=None, auth_passphrase=None, privacy_passphrase=None, user=None)
Keyword Arguments

  • auth_protocol (str) – Hash algorithm used to validate the authentication passphrase. Valid values are MD5 and SHA.

  • privacy_protocol (str) – Encryption protocol for SNMP messages. Valid values are AES and DES.

  • auth_passphrase (str) – Passphrase used by Purity to authenticate the array with the specified managers.

  • privacy_passphrase (str) – Passphrase used to encrypt SNMP messages.

  • user (str) – User ID recognized by the specified SNMP managers which Purity is to use in communications with them.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SnmpV3Post

class pypureclient.flashblade.SnmpV3Post(auth_protocol=None, privacy_protocol=None, auth_passphrase=None, privacy_passphrase=None, user=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(auth_protocol=None, privacy_protocol=None, auth_passphrase=None, privacy_passphrase=None, user=None)
Keyword Arguments

  • auth_protocol (str) – Hash algorithm used to validate the authentication passphrase. Valid values are MD5 and SHA.

  • privacy_protocol (str) – Encryption protocol for SNMP messages. Valid values are AES and DES.

  • auth_passphrase (str) – Passphrase used by Purity to authenticate the array with the specified managers.

  • privacy_passphrase (str) – Passphrase used to encrypt SNMP messages.

  • user (str) – User ID recognized by the specified SNMP managers which Purity is to use in communications with them.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SoftwareCheck

class pypureclient.flashblade.SoftwareCheck(name=None, id=None, start_time=None, end_time=None, checks=None, details=None, software_name=None, software_version=None, software_upgrade_hops=None, status=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, start_time=None, end_time=None, checks=None, details=None, software_name=None, software_version=None, software_upgrade_hops=None, status=None)
Keyword Arguments

  • name (str) – Name of the resource. The name cannot be modified.

  • id (str) – A globally unique, system-generated ID. The ID cannot be modified.

  • start_time (int) – Start time in milliseconds since the UNIX epoch.

  • end_time (int) – End time in milliseconds since the UNIX epoch.

  • checks (list[SoftwareChecksChecks]) – A list of checks in this check task.

  • details (str) – The detailed reason for the status.

  • software_name (str) – The name of the software the upgrade checks will test.

  • software_version (str) – The version of the software that the upgrade checks will test.

  • software_upgrade_hops (list[str]) – The list of software versions the upgrade goes through. The upgrade checks also test this particular path.

  • status (str) – The status of the check task. Valid values are queued, running, passed, and failed. A status of queued indicates that the task is queued to run and is waiting for other check tasks to complete. A status of running indicates that the task is currently running. A status of passed indicates that all upgrade checks in the task are complete. A status of failed indicates that at least one upgrade check in the task has failed.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SoftwareChecksChecks

class pypureclient.flashblade.SoftwareChecksChecks(name=None, details=None, status=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, details=None, status=None)
Keyword Arguments

  • name (str) – Name of the upgrade check.

  • details (str) – Detailed result of the check used to diagnose check failures.

  • status (str) – Status of the check. Valid values are running, failed, and passed. A status of running indicates that the check has not finished. A status of failed indicates that the check has failed. A status of passed indicates that the check has passed.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Space

class pypureclient.flashblade.Space(snapshots=None, total_physical=None, available_provisioned=None, data_reduction=None, shared=None, available_ratio=None, destroyed=None, virtual=None, unique=None, destroyed_virtual=None, total_provisioned=None, total_used=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(snapshots=None, total_physical=None, available_provisioned=None, data_reduction=None, shared=None, available_ratio=None, destroyed=None, virtual=None, unique=None, destroyed_virtual=None, total_provisioned=None, total_used=None)
Keyword Arguments

  • snapshots (int) – Physical usage by snapshots, other than unique in bytes.

  • total_physical (int) – Deprecated. See total_used for the newer functionality. The total physical space consumed by the file system, measured in bytes.

  • available_provisioned (int) – The amount of space left that the current object can grow before writes are stopped due to a hard limit quota being hit. This is total_provisioned minus the virtual space used for file-systems and buckets. For array and object store accounts it is total_provisioned minus the virtual space used by non-destroyed file-systems and buckets.

  • data_reduction (float) – Reduction of data.

  • shared (int) – The space contributed by data that is not unique to a managed directory, or snapshot, measured in bytes.

  • available_ratio (float) – The ratio of the available space versus the total provisioned space.

  • destroyed (int) – Unique physical space (excluding snapshots) occupied by destroyed data within the child containers, in bytes. For buckets and filesystems, the destroyed space will be 0 as they cannot have child containers. For the whole array, the space will be the sum of all destroyed buckets and filesystems.

  • virtual (int) – The amount of logically written data, in bytes. Excludes destroyed data.

  • unique (int) – Unique physical space occupied by customer data, in bytes. Excludes snapshots, destroyed.

  • destroyed_virtual (int) – The amount of destroyed logically written data within the child containers, in bytes. For buckets and filesystems, the destroyed virtual space will be 0 as they cannot have child containers. For the whole array, the space will be the sum of all destroyed buckets and filesystems.

  • total_provisioned (int) – The effective provisioned size of the container, at which a hard limit will be applied. For a bucket with a quota_limit value and hard_limit_enabled set to true, this is its quota_limit value, unless the available space of the associated object store account, as defined by its quota_limit value, would prevent the bucket from reaching its own quota_limit value. In such a case, total_provisioned will reflect the smaller value. For a file system with a provisioned value and hard_limit_enabled set to true, this is the provisioned value of the file system. For an object store account with a quota_limit value and hard_limit_enabled set to true, this is the quota_limit value of the object store account. For the array, this is the sum of the file systems and accounts. Measured in bytes.

  • total_used (int) – The total space consumed by customer data, measured in bytes.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SshCertificateAuthorityPolicy

class pypureclient.flashblade.SshCertificateAuthorityPolicy(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, signing_authority=None, static_authorized_principals=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, signing_authority=None, static_authorized_principals=None)
Keyword Arguments

  • name (str) – A name chosen by the user. Can be changed. Must be locally unique.

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • policy_type (str) – Type of the policy. Valid values include alert, audit, bucket-access, cross-origin-resource-sharing, network-access, nfs, object-access, smb-client, smb-share, snapshot, ssh-certificate-authority, and worm-data.

  • location (FixedReference) – Reference to the array where the policy is defined.

  • is_local (bool) – Whether the policy is defined on the local array.

  • enabled (bool) – If true, the policy is enabled. If not specified, defaults to true.

  • signing_authority (ReferenceWritable) – A reference to the authority that will digitally sign user SSH certificates that will be used to access the system. This may be either a certificate or a public key. If a certificate is used as the signer, then its expiry period will be honored and user SSH certificates signed by the certificate will no longer be accepted after the certificate has expired.

  • static_authorized_principals (list[str]) – If not specified - users affected by this policy can only log into the system when they present an SSH certificate containing their own username as a principle. If specified - users affected by this policy can only log into the system when they present an SSH certificate containing at least one username from this list as a principle.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SshCertificateAuthorityPolicyPost

class pypureclient.flashblade.SshCertificateAuthorityPolicyPost(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, signing_authority=None, static_authorized_principals=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, signing_authority=None, static_authorized_principals=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • policy_type (str) – Type of the policy. Valid values include alert, audit, bucket-access, cross-origin-resource-sharing, network-access, nfs, object-access, smb-client, smb-share, snapshot, ssh-certificate-authority, and worm-data.

  • location (FixedReference) – Reference to the array where the policy is defined.

  • is_local (bool) – Whether the policy is defined on the local array.

  • enabled (bool) – If true, the policy is enabled. If not specified, defaults to true.

  • signing_authority (ReferenceWritable) – A reference to the authority that will digitally sign user SSH certificates that will be used to access the system. This may be either a certificate or a public key. If a certificate is used as the signer, then its expiry period will be honored and user SSH certificates signed by the certificate will no longer be accepted after the certificate has expired.

  • static_authorized_principals (list[str]) – If not specified - users affected by this policy can only log into the system when they present an SSH certificate containing their own username as a principle. If specified - users affected by this policy can only log into the system when they present an SSH certificate containing at least one username from this list as a principle.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

StartEndTime

class pypureclient.flashblade.StartEndTime(start_time=None, end_time=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(start_time=None, end_time=None)
Keyword Arguments

  • start_time (int) – Start time in milliseconds since the UNIX epoch.

  • end_time (int) – End time in milliseconds since the UNIX epoch.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

StorageClassInfo

class pypureclient.flashblade.StorageClassInfo(name=None, status_details=None, status=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, status_details=None, status=None)
Keyword Arguments

  • name (str) –

  • status_details (str) – Additional details about the status of the transition. If there is no transition ongoing, this field will be null.

  • status (str) – The status of the transition from the policy to the requested policy. If there is an ongoing transition, the status will be one of In-Progress or Queued. If there is no transition ongoing, this field will be null.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

StorageClassSpace

class pypureclient.flashblade.StorageClassSpace(name=None, time=None, space=None, capacity=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, time=None, space=None, capacity=None)
Keyword Arguments

  • name (str) –

  • time (int) – Sample time in milliseconds since UNIX epoch.

  • space (Space) –

  • capacity (int) – Usable capacity in bytes.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Subnet

class pypureclient.flashblade.Subnet(name=None, id=None, link_aggregation_group=None, interfaces=None, vlan=None, prefix=None, services=None, enabled=None, gateway=None, mtu=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, link_aggregation_group=None, interfaces=None, vlan=None, prefix=None, services=None, enabled=None, gateway=None, mtu=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • link_aggregation_group (Reference) – Reference to the associated LAG.

  • interfaces (list[FixedReference]) – List of network interfaces associated with this subnet.

  • vlan (int) – VLAN ID.

  • prefix (str) – The IPv4 or IPv6 address to be associated with the specified subnet.

  • services (list[str]) – The services provided by this subnet, as inherited from all of its interfaces.

  • enabled (bool) – Indicates if subnet is enabled (true) or disabled (false). If not specified, defaults to true.

  • gateway (str) – The IPv4 or IPv6 address of the gateway through which the specified subnet is to communicate with the network.

  • mtu (int) – Maximum message transfer unit (packet) size for the subnet in bytes. MTU setting cannot exceed the MTU of the corresponding physical interface. If not specified, defaults to 1500.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Support

class pypureclient.flashblade.Support(name=None, id=None, proxy=None, phonehome_enabled=None, remote_assist_paths=None, remote_assist_status=None, remote_assist_duration=None, remote_assist_opened=None, remote_assist_active=None, remote_assist_expires=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, proxy=None, phonehome_enabled=None, remote_assist_paths=None, remote_assist_status=None, remote_assist_duration=None, remote_assist_opened=None, remote_assist_active=None, remote_assist_expires=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • proxy (str) –

  • phonehome_enabled (bool) –

  • remote_assist_paths (list[SupportRemoteAssistPaths]) –

  • remote_assist_status (str) – The status of the remote-assist sessions. Valid values are connected, partially_connected, reconnecting, and disconnected.

  • remote_assist_duration (int) – Specifies the duration of the remote-assist session in milliseconds. This parameter should only be provided when establishing a new session. It determines the length of time the session will remain active after it’s initiated.

  • remote_assist_opened (str) – The time when the session opened.

  • remote_assist_active (bool) – The switch to open all remote-assist sessions.

  • remote_assist_expires (str) – The time when the session expires.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SupportDiagnostics

class pypureclient.flashblade.SupportDiagnostics(name=None, id=None, start_time=None, index=None, task_id=None, analysis_period=None, version=None, severity_count=None, status=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, start_time=None, index=None, task_id=None, analysis_period=None, version=None, severity_count=None, status=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • start_time (int) – Start time in milliseconds since the UNIX epoch.

  • index (int) – The unique index of the task.

  • task_id (str) – A globally unique, system-generated ID. The ID cannot be modified.

  • analysis_period (StartEndTime) –

  • version (str) – Version of diagnostics tool.

  • severity_count (list[SupportDiagnosticsSeverityCount]) – List of severity counts.

  • status (str) – Status of the diagnostics. A status of running indicates that the diagnostics is still running. A status of completed indicates that the diagnostics has completed. A status of failed indicates that the diagnostics has failed.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SupportDiagnosticsDetails

class pypureclient.flashblade.SupportDiagnosticsDetails(name=None, id=None, severity=None, index=None, task_id=None, test_name=None, result_details=None, test_type=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, severity=None, index=None, task_id=None, test_name=None, result_details=None, test_type=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • severity (str) – Severity level of the test. Valid values include info, warning, critical.

  • index (float) – The unique index of the test. It will be of the format A.B where A is the task index and B is the test index.

  • task_id (str) – The task ID of the diagnostics for which this refers to.

  • test_name (str) – Name of the test that was performed.

  • result_details (str) – More details related to the test. This field can provide remediation information as well.

  • test_type (str) – Category to which the test belongs to.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SupportDiagnosticsSeverityCount

class pypureclient.flashblade.SupportDiagnosticsSeverityCount(severity=None, count=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(severity=None, count=None)
Keyword Arguments

  • severity (str) – Severity level of the test. Valid values include info, warning, critical.

  • count (int) – Count of the corresponding severity.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SupportRemoteAssistPaths

class pypureclient.flashblade.SupportRemoteAssistPaths(component_name=None, status=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(component_name=None, status=None)
Keyword Arguments

  • component_name (str) – The name of the FM.

  • status (str) – The status of the remote-assist session on the local FM. Valid values are reconnecting, connected, disconnected, and unknown.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SyslogServer

class pypureclient.flashblade.SyslogServer(uri=None, services=None, name=None, id=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(uri=None, services=None, name=None, id=None)
Keyword Arguments

  • uri (str) – The URI of the syslog server in the format PROTOCOL://HOSTNAME:PORT.

  • services (list[str]) – Valid values are data-audit and management. If not specified, defaults to management.

  • name (str) – A name chosen by the user. Can be changed. Must be locally unique.

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SyslogServerContext

class pypureclient.flashblade.SyslogServerContext(uri=None, services=None, name=None, id=None, context=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(uri=None, services=None, name=None, id=None, context=None)
Keyword Arguments

  • uri (str) – The URI of the syslog server in the format PROTOCOL://HOSTNAME:PORT.

  • services (list[str]) – Valid values are data-audit and management. If not specified, defaults to management.

  • name (str) – A name chosen by the user. Can be changed. Must be locally unique.

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • context (Reference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SyslogServerPatch

class pypureclient.flashblade.SyslogServerPatch(uri=None, services=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(uri=None, services=None)
Keyword Arguments

  • uri (str) – The URI of the syslog server in the format PROTOCOL://HOSTNAME:PORT.

  • services (list[str]) – Valid values are data-audit and management.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SyslogServerPost

class pypureclient.flashblade.SyslogServerPost(uri=None, services=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(uri=None, services=None)
Keyword Arguments

  • uri (str) – The URI of the syslog server in the format PROTOCOL://HOSTNAME:PORT.

  • services (list[str]) – Valid values are data-audit and management. If not specified, defaults to management.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SyslogServerPostOrPatch

class pypureclient.flashblade.SyslogServerPostOrPatch(uri=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(uri=None)
Keyword Arguments

uri (str) – The URI of the syslog server in the format PROTOCOL://HOSTNAME:PORT.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

SyslogServerSettings

class pypureclient.flashblade.SyslogServerSettings(name=None, id=None, ca_certificate=None, ca_certificate_group=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, ca_certificate=None, ca_certificate_group=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • ca_certificate (object) –

  • ca_certificate_group (object) –

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Target

class pypureclient.flashblade.Target(name=None, id=None, address=None, ca_certificate_group=None, status_details=None, status=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, address=None, ca_certificate_group=None, status_details=None, status=None)
Keyword Arguments

  • name (str) – A name chosen by the user. Can be changed. Must be locally unique.

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • address (str) – IP address or FQDN of the target system.

  • ca_certificate_group (FixedReference) – The group of CA certificates that can be used, in addition to well-known Certificate Authority certificates, in order to establish a secure connection to the target system. Defaults to a reference to the _default_replication_certs group.

  • status_details (str) – Additional information describing any issues encountered when connecting, or null if the status is connected.

  • status (str) – Status of the connection. Valid values are connected and connecting. connected - The connection is OK. connecting - No connection exists and the array is trying to reconnect to the target.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

TargetPost

class pypureclient.flashblade.TargetPost(address=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(address=None)
Keyword Arguments

address (str) – IP address or FQDN of the target system.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

TargetWithContext

class pypureclient.flashblade.TargetWithContext(name=None, id=None, address=None, ca_certificate_group=None, status_details=None, status=None, context=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, address=None, ca_certificate_group=None, status_details=None, status=None, context=None)
Keyword Arguments

  • name (str) – A name chosen by the user. Can be changed. Must be locally unique.

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • address (str) – IP address or FQDN of the target system.

  • ca_certificate_group (FixedReference) – The group of CA certificates that can be used, in addition to well-known Certificate Authority certificates, in order to establish a secure connection to the target system. Defaults to a reference to the _default_replication_certs group.

  • status_details (str) – Additional information describing any issues encountered when connecting, or null if the status is connected.

  • status (str) – Status of the connection. Valid values are connected and connecting. connected - The connection is OK. connecting - No connection exists and the array is trying to reconnect to the target.

  • context (Reference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

TestResult

class pypureclient.flashblade.TestResult(resource=None, success=None, component_name=None, destination=None, description=None, component_address=None, enabled=None, result_details=None, test_type=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(resource=None, success=None, component_name=None, destination=None, description=None, component_address=None, enabled=None, result_details=None, test_type=None)
Keyword Arguments

  • resource (FixedReference) – A reference to the object being tested.

  • success (bool) – Returns a value of true if the specified test succeeded. Returns a value of false if the specified test failed.

  • component_name (str) – Name of the component running the test.

  • destination (str) – The URI of the target server being tested.

  • description (str) – What the test is doing.

  • component_address (str) – Address of the component running the test.

  • enabled (bool) – Is the service enabled or not?

  • result_details (str) – Additional information about the test result.

  • test_type (str) – Displays the type of test being performed. The returned values are determined by the resource being tested and its configuration.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Throttle

class pypureclient.flashblade.Throttle(window=None, default_limit=None, window_limit=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(window=None, default_limit=None, window_limit=None)
Keyword Arguments

  • window (TimeWindow) – The time during which the window_limit threshold is in effect.

  • default_limit (int) – Default maximum bandwidth threshold for outbound traffic in bytes. Once exceeded, bandwidth throttling occurs.

  • window_limit (int) – Maximum bandwidth threshold for outbound traffic during the specified window_limit time range in bytes. Once exceeded, bandwidth throttling occurs.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

TimeWindow

class pypureclient.flashblade.TimeWindow(start=None, end=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(start=None, end=None)
Keyword Arguments

  • start (int) – The window start time. Measured in milliseconds since midnight. The time must be set on the hour. (e.g., 18000000, which is equal to 5:00 AM).

  • end (int) – The window end time. Measured in milliseconds since midnight. The time must be set on the hour. (e.g., 28800000, which is equal to 8:00 AM).

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

TimeZone

class pypureclient.flashblade.TimeZone(name=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None)
Keyword Arguments

name (str) – Name of the object (e.g., a file system or snapshot).

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

TlsPolicy

class pypureclient.flashblade.TlsPolicy(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, enabled_tls_ciphers=None, appliance_certificate=None, min_tls_version=None, disabled_tls_ciphers=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, enabled_tls_ciphers=None, appliance_certificate=None, min_tls_version=None, disabled_tls_ciphers=None)
Keyword Arguments

  • name (str) – A name chosen by the user. Can be changed. Must be locally unique.

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • policy_type (str) – Type of the policy. Valid values include alert, audit, bucket-access, cross-origin-resource-sharing, network-access, nfs, object-access, smb-client, smb-share, snapshot, ssh-certificate-authority, and worm-data.

  • location (FixedReference) – Reference to the array where the policy is defined.

  • is_local (bool) – Whether the policy is defined on the local array.

  • enabled (bool) – If true, the policy is enabled. If not specified, defaults to true.

  • enabled_tls_ciphers (list[str]) – If specified, enables only the specified TLS ciphers. If all TLS ciphers that are available for a specific TLS version on the system are disabled, then client access over that TLS version is not possible. As such, the enabled ciphers must always contain at least one cipher for each enabled TLS version. Changes to this setting can disrupt traffic for any clients relying on ciphers that are removed. If set to default, then the enabled ciphers may be automatically adjusted upon upgrade to newer software in order to align with the best known practices at the time of software release.

  • appliance_certificate (ReferenceWritable) – A reference to a certificate that will be presented as the server certificate in TLS negotiations with any clients that connect to appliance network addresses to which this policy applies.

  • min_tls_version (str) – The minimum TLS version that will be allowed for inbound connections on IPs to which this policy applies. Changing this setting can disrupt connections for any clients relying on older TLS versions that are disabled. If set to default, then the lowest TLS version permitted may be automatically raised upon upgrade to newer software in order to align with the best known practices at the time of software release. Configuring an explicit, low value can prevent upgrades to newer software versions that no longer support older TLS versions. Valid values include default, TLSv1.1, TLSv1.0, TLSv1.2, and TLSv1.3.

  • disabled_tls_ciphers (list[str]) – If specified, disables the specific TLS ciphers. If all TLS ciphers that are available for a specific TLS version on the system are disabled, then client access over that TLS version is not possible. As such, disabled ciphers must still result in at least one cipher being available for each enabled TLS version. Changes to this setting can disrupt traffic for any clients relying on disabled ciphers.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

TlsPolicyPost

class pypureclient.flashblade.TlsPolicyPost(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, enabled_tls_ciphers=None, appliance_certificate=None, min_tls_version=None, disabled_tls_ciphers=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, enabled_tls_ciphers=None, appliance_certificate=None, min_tls_version=None, disabled_tls_ciphers=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • policy_type (str) – Type of the policy. Valid values include alert, audit, bucket-access, cross-origin-resource-sharing, network-access, nfs, object-access, smb-client, smb-share, snapshot, ssh-certificate-authority, and worm-data.

  • location (FixedReference) – Reference to the array where the policy is defined.

  • is_local (bool) – Whether the policy is defined on the local array.

  • enabled (bool) – If true, the policy is enabled. If not specified, defaults to true.

  • enabled_tls_ciphers (list[str]) – If specified, enables only the specified TLS ciphers. If all TLS ciphers that are available for a specific TLS version on the system are disabled, then client access over that TLS version is not possible. As such, the enabled ciphers must always contain at least one cipher for each enabled TLS version. Changes to this setting can disrupt traffic for any clients relying on ciphers that are removed. If set to default, then the enabled ciphers may be automatically adjusted upon upgrade to newer software in order to align with the best known practices at the time of software release.

  • appliance_certificate (ReferenceWritable) – A reference to a certificate that will be presented as the server certificate in TLS negotiations with any clients that connect to appliance network addresses to which this policy applies.

  • min_tls_version (str) – The minimum TLS version that will be allowed for inbound connections on IPs to which this policy applies. Changing this setting can disrupt connections for any clients relying on older TLS versions that are disabled. If set to default, then the lowest TLS version permitted may be automatically raised upon upgrade to newer software in order to align with the best known practices at the time of software release. Configuring an explicit, low value can prevent upgrades to newer software versions that no longer support older TLS versions. Valid values include default, TLSv1.1, TLSv1.0, TLSv1.2, and TLSv1.3.

  • disabled_tls_ciphers (list[str]) – If specified, disables the specific TLS ciphers. If all TLS ciphers that are available for a specific TLS version on the system are disabled, then client access over that TLS version is not possible. As such, disabled ciphers must still result in at least one cipher being available for each enabled TLS version. Changes to this setting can disrupt traffic for any clients relying on disabled ciphers.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

TrustPolicyRule

class pypureclient.flashblade.TrustPolicyRule(name=None, index=None, effect=None, principals=None, conditions=None, actions=None, policy=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, index=None, effect=None, principals=None, conditions=None, actions=None, policy=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • index (int) – Index of the object in the containing array.

  • effect (str) – Effect of this rule. When allow, the rule allows the given actions to be performed on the given resources, subject to the given conditions. Valid values include allow.

  • principals (list[ReferenceWritable]) – List of Identity Providers

  • conditions (list[TrustPolicyRuleCondition]) – Conditions used to limit the scope which this rule applies to.

  • actions (list[str]) – The list of role-assumption actions granted by this rule to the respective role. Currently we support sts:AssumeRoleWithSAML and sts:AssumeRoleWithWebIdentity actions.

  • policy (FixedReference) – The policy to which this rule belongs.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

TrustPolicyRuleCondition

class pypureclient.flashblade.TrustPolicyRuleCondition(values=None, key=None, operator=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(values=None, key=None, operator=None)
Keyword Arguments

  • values (list[str]) – Values to be compared with the values in the role assuming request context identified by the key. If multiple values are specified, it’s sufficient if just one matches.

  • key (str) – Key from the context of the role assuming request that will have its value compared based on the operator specified in this condition to the values provided in this condition.

  • operator (str) – Operator specifying the comparison to be done between the values from the request context and the values provided in this condition. Valid values: StringEquals.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

TrustPolicyRulePost

class pypureclient.flashblade.TrustPolicyRulePost(effect=None, principals=None, conditions=None, actions=None, policy=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(effect=None, principals=None, conditions=None, actions=None, policy=None)
Keyword Arguments

  • effect (str) – Effect of this rule. When allow, the rule allows the given actions to be performed on the given resources, subject to the given conditions. Valid values include allow.

  • principals (list[ReferenceWritable]) – List of Identity Providers

  • conditions (list[TrustPolicyRuleCondition]) – Conditions used to limit the scope which this rule applies to.

  • actions (list[str]) – The list of role-assumption actions granted by this rule to the respective role. Currently we support sts:AssumeRoleWithSAML and sts:AssumeRoleWithWebIdentity actions.

  • policy (FixedReference) – The policy to which this rule belongs.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

TrustPolicyRuleWithContext

class pypureclient.flashblade.TrustPolicyRuleWithContext(name=None, index=None, effect=None, principals=None, conditions=None, actions=None, policy=None, context=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, index=None, effect=None, principals=None, conditions=None, actions=None, policy=None, context=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • index (int) – Index of the object in the containing array.

  • effect (str) – Effect of this rule. When allow, the rule allows the given actions to be performed on the given resources, subject to the given conditions. Valid values include allow.

  • principals (list[ReferenceWritable]) – List of Identity Providers

  • conditions (list[TrustPolicyRuleCondition]) – Conditions used to limit the scope which this rule applies to.

  • actions (list[str]) – The list of role-assumption actions granted by this rule to the respective role. Currently we support sts:AssumeRoleWithSAML and sts:AssumeRoleWithWebIdentity actions.

  • policy (FixedReference) – The policy to which this rule belongs.

  • context (Reference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

User

class pypureclient.flashblade.User(name=None, id=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None)
Keyword Arguments

  • name (str) – The user name that represents the user’s identity, and which resolves to the user’s id in a configured directory service.

  • id (int) – The numeric user id that represents the user’s identity in a POSIX system.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

UserNoId

class pypureclient.flashblade.UserNoId(name=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None)
Keyword Arguments

name (str) – The user name that represents the user’s identity, and which resolves to the user’s id in a configured directory service.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

UserQuota

class pypureclient.flashblade.UserQuota(name=None, context=None, file_system=None, quota=None, usage=None, user=None, file_system_default_quota=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, context=None, file_system=None, quota=None, usage=None, user=None, file_system_default_quota=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • context (Reference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

  • file_system (FixedReference) –

  • quota (int) – The limit of the quota (in bytes) for the specified user, cannot be 0. If specified, this value will override the file system’s default user quota.

  • usage (int) – The usage of the file system (in bytes) by the specified user.

  • user (User) – The user on which this quota is enforced.

  • file_system_default_quota (int) – File system’s default user quota (in bytes). If it is 0, it means there is no default quota. This will be the effective user quota if the user doesn’t have an individual quota. This default quota is set through the file-systems endpoint.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

UserQuotaPatch

class pypureclient.flashblade.UserQuotaPatch(quota, name=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(quota, name=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • quota (int, required) – The limit of the quota (in bytes) for the specified user, cannot be 0. If specified, this value will override the file system’s default user quota.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

UserQuotaPost

class pypureclient.flashblade.UserQuotaPost(quota, name=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(quota, name=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • quota (int, required) – The limit of the quota (in bytes) for the specified user, cannot be 0. If specified, this value will override the file system’s default user quota.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

VerificationKey

class pypureclient.flashblade.VerificationKey(key_id=None, name=None, verification_key=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(key_id=None, name=None, verification_key=None)
Keyword Arguments

  • key_id (int) – The key id of the verification key.

  • name (str) – Name of the verification key. Possible values include access.

  • verification_key (str) – The text of the verification key.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

VerificationKeyPatch

class pypureclient.flashblade.VerificationKeyPatch(signed_verification_key=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(signed_verification_key=None)
Keyword Arguments

signed_verification_key (str) – The text of the signed verification key.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Version

class pypureclient.flashblade.Version(version=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(version=None)
Keyword Arguments

version (str) – A hash of the other properties of this resource. This can be used when updating the resource to ensure there aren’t any updates since the resource was read.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

WormDataPolicy

class pypureclient.flashblade.WormDataPolicy(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, mode=None, default_retention=None, max_retention=None, min_retention=None, retention_lock=None, context=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(name=None, id=None, policy_type=None, location=None, is_local=None, enabled=None, mode=None, default_retention=None, max_retention=None, min_retention=None, retention_lock=None, context=None)
Keyword Arguments

  • name (str) – Name of the object (e.g., a file system or snapshot).

  • id (str) – A non-modifiable, globally unique ID chosen by the system.

  • policy_type (str) – Type of the policy. Valid values include alert, audit, bucket-access, cross-origin-resource-sharing, network-access, nfs, object-access, smb-client, smb-share, snapshot, ssh-certificate-authority, and worm-data.

  • location (FixedReference) – Reference to the array where the policy is defined.

  • is_local (bool) – Whether the policy is defined on the local array.

  • enabled (bool) – If true, the policy is enabled. If not specified, defaults to true.

  • mode (str) – The type of the retention lock. Valid values is compliance.

  • default_retention (int) – Default retention period, in milliseconds. If the access time is not specified when committing a file, then the default retention period is applied.

  • max_retention (int) – Maximum retention period, in milliseconds.

  • min_retention (int) – Minimum retention period, in milliseconds.

  • retention_lock (str) – If set to locked, then the value of retention attributes or policy attributes are not allowed to change. If set to unlocked, then the value of the retention attributes and policy attributes are allowed to change. Valid values are unlocked and locked. It is always allowed to change from unlocked to locked. Contact Pure Technical Services to change from locked to unlocked.

  • context (Reference) – The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

WormDataPolicyRetentionConfig

class pypureclient.flashblade.WormDataPolicyRetentionConfig(mode=None, default_retention=None, max_retention=None, min_retention=None, retention_lock=None)
swagger_types

The key is attribute name and the value is attribute type.

Type

dict

attribute_map

The key is attribute name and the value is json key in definition.

Type

dict

__eq__(other)

Returns true if both objects are equal

__init__(mode=None, default_retention=None, max_retention=None, min_retention=None, retention_lock=None)
Keyword Arguments

  • mode (str) – The type of the retention lock. Valid values is compliance.

  • default_retention (int) – Default retention period, in milliseconds. If the access time is not specified when committing a file, then the default retention period is applied.

  • max_retention (int) – Maximum retention period, in milliseconds.

  • min_retention (int) – Minimum retention period, in milliseconds.

  • retention_lock (str) – If set to locked, then the value of retention attributes or policy attributes are not allowed to change. If set to unlocked, then the value of the retention attributes and policy attributes are allowed to change. Valid values are unlocked and locked. It is always allowed to change from unlocked to locked. Contact Pure Technical Services to change from locked to unlocked.

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Examples

Instantiating a Client

All of the examples on this page assume that you have instantiated a client object in this way and also have these imports. Different methods of authentication are discussed in Quick Start.

import pypureclient
from pypureclient import flashblade

try:
    # login to the array with your API_TOKEN
    client = flashblade.Client(target='10.255.9.28', api_token=API_TOKEN)
except pypureclient.exceptions.PureError as e:
    print("Exception when logging in to the array: %s\n" % e)

Common Fields

ids, names

Instead of getting all things, you can just get values for specific items.

# list a subset of admin accounts by name with api token exposed
res = client.get_admins(names=['pureuser'], expose_api_token=True)

If you know the id of the object (pureuser in this case) you can use ids instead of names

# list a subset of admin accounts by id
res = client.get_admins(ids=['10314f42-020d-7080-8013-000ddt400090'])

There are a number of other fields that follow the same logic such as bucket_names and bucket_ids. The usage will be the same and in these cases the object is clearly referenced by the field name.

filter

Check Quick Start for more information

sort

You can sort on a given field. By default it is in increasing order.

# list filesystems and sort by provisioned
res = client.get_file_systems(sort="provisioned")
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

If you would like descending order, insert a - after the field.

# list filesystems and sort by provisioned
res = client.get_file_systems(sort="provisioned-")
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

For nested fields, use a .

# list and sort by name in descendant order
res = client.get_file_systems_policies(sort="policy.name-")
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

offset, limit, continuation_token

Use offset to ignore the first couple items from the collection.

res = client.get_file_systems(offset=3)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

Use limit to limit the number of results.

# list first five filesystems and sort by provisioned in descendant order
res = client.get_file_systems(limit=5, sort="provisioned-")
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

You can see that res will contain a continuation_token field. You can use this to print out the rest of the results.

# list all remaining file systems using continuation token from above
res = client.get_file_systems(continuation_token=res.continuation_token)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

total_only

If you don’t want the individual results, you can use total_only.

# total instantaneous performance across 2 targets
res = client.get_targets_performance_replication(names=['s3target1', 's3target2'],
                                                 total_only=True)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

context_names

Use context_names if you want to perform an operation on a different execution context. The execution context must reference an array or arrays in the same fleet. If not specified, it defaults to the name of the array that received this request. If the request is anything other than a GET request, the context_names must be an array of size one, for example:

If the request is a GET request, context_names may contain multiple elements. This will execute the request on all specified contexts and return the merged response. For example:

Other parameters provided with the request, such as names of filesystems or snapshots, are resolved relative to the provided execution context.

allow_errors

Use allow_errors if you want to allow errors in the response, along the results. This can only occur when the execution context consists of multiple arrays and executing the operation on one of the arrays fails.

If set to true, the API will allow the operation to continue even if there are errors. Any errors will be returned in the errors field of the response. If set to false, the operation will fail if there are any errors.

Active Directory

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

delete_active_directory

# Delete active directory account
client.delete_active_directory(names=["test-config"])

# Do a local-only delete of an active directory account
client.delete_active_directory(names=["test-config"], local_only=True)

# Other valid fields: ids
# See section "Common Fields" for examples

get_active_directory

# List active directory accounts
res = client.get_active_directory()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: continuation_token, filter, ids, limit, names, offset, sort
# See section "Common Fields" for examples

patch_active_directory

from pypureclient.flashblade import ActiveDirectoryPatch

# Change existing Active Directory account LDAP, global catalog and kerberos servers, encryption types, and
# service principal names.
# Can alternatively supply fqdns instead of service_principal_names
ad_config = ActiveDirectoryPatch(
    directory_servers=["ldap.my-corporation.com", "ldap.subdomain.my-corporation.com@subdomain.my-corporation.com"],
    kerberos_servers=["kdc.my-corporation.com"],
    global_catalog_servers=["gc.my-corporation.com", "gc.subdomain.my-corporation.com@subdomain.my-corporation.com"],
    encryption_types=["aes256-cts-hmac-sha1-96"],
    service_principal_names=["nfs/vip2.my-array.my-corporation.com"],
)
res = client.patch_active_directory(names=["test-config"], active_directory=ad_config)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Move existing Active Directory account to a different Join OU
ad_config = ActiveDirectoryPatch(join_ou="OU=FakeOU")
res = client.patch_active_directory(names=["test-config"], active_directory=ad_config)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: ids
# See section "Common Fields" for examples

post_active_directory

from pypureclient.flashblade import ActiveDirectoryPost

# Create new Active Directory account with specified LDAP, global catalog and kerberos servers, computer name
# and specified encryption types, fqdns, and join_ou.
# Can alternatively supply service_principal_names instead of fqdns.
ad_config = ActiveDirectoryPost(
    computer_name="FLASHBLADE01",
    directory_servers=["ldap.my-corporation.com", "ldap.subdomain.my-corporation.com@subdomain.my-corporation.com"],
    kerberos_servers=["kdc.my-corporation.com"],
    global_catalog_servers=["gc.my-corporation.com", "gc.subdomain.my-corporation.com@subdomain.my-corporation.com"],
    domain="my-corporation.com",
    encryption_types=["aes128-cts-hmac-sha1-96"],
    fqdns=["vip1.my-array.my-corporation.com"],
    join_ou="CN=FakeOU",
    user="Administrator",
    password="Password",
)

res = client.post_active_directory(names=["test-config"], active_directory=ad_config)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Join AD domain using an existing computer account
existing_ad_config = ActiveDirectoryPost(
    computer_name="FLASHBLADE01", domain="my-corporation.com", user="Administrator", password="Password"
)
res = client.post_active_directory(
    names=["test-config"], active_directory=existing_ad_config, join_existing_account=True
)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

get_active_directory_test

# Test active directory accounts
res = client.get_active_directory_test()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: filter, ids, limit, names, sort
# See section "Common Fields" for examples

Administrators

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

delete_admins_api_tokens

# Delete api token for admin1
client.delete_admins_api_tokens(admin_names=["admin1"])

# Other valid fields: admin_ids
# See section "Common Fields" for examples

get_admins_api_tokens

# Get api tokens with current user's exposed
res = client.get_admins_api_tokens(expose_api_token=True)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: admin_ids, admin_names, continuation_token, filter, limit, offset, sort
# See section "Common Fields" for examples

post_admins_api_tokens

# Create api token for admin1 for 1 hour (timeout in ms)
res = client.post_admins_api_tokens(admin_names=["admin1"], timeout=1*60*60*1000)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: admin_ids
# See section "Common Fields" for examples

delete_admins_cache

# delete an admin cache entry
client.delete_admins_cache(names=['adminuser'])

# delete all admin cache entries
client.delete_admins_cache()

# Other valid fields: ids
# See section "Common Fields" for examples

get_admins_cache

# list admin cache entry
res = client.get_admins_cache(names=['adminuser'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# refresh admin cache entry for user with id '10314f42-020d-7080-8013-000ddt400090'
res = client.get_admins_cache(ids=['10314f42-020d-7080-8013-000ddt400090'],
                              refresh=True)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: continuation_token, filter, limit, offset, sort
# See section "Common Fields" for examples

delete_admins

# Delete the admins by names.
res = client.delete_admins(names=['test-admin'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# delete the admins with id '10314f42-020d-7080-8013-000ddt400090'
res = client.delete_admins(ids=['10314f42-020d-7080-8013-000ddt400090'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

get_admins

# list all admin accounts (given sufficient permissions)
res = client.get_admins()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list a subset of admin accounts by name with api token exposed
res = client.get_admins(names=['pureuser'], expose_api_token=True)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list a subset of admin accounts by id
res = client.get_admins(ids=['10314f42-020d-7080-8013-000ddt400090'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: continuation_token, filter, limit, offset, sort
# See section "Common Fields" for examples

patch_admins

from pypureclient.flashblade import AdminPatch

# change password
myAdmin = AdminPatch(old_password='thisWASanOLDpasSwOrD', password='FAKEnewpaSsword')
res = client.patch_admins(names=['pureuser'], admin=myAdmin)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Set a public key for login via SSH
myAdmin = AdminPatch(public_key='ssh-rsa EXAMPLEzaC1yc2EAAAADAQABAAABAQDN1fshdvABLD/f2mkAUqkcUMKPsS+Os3omYFwe3G2Adxc'
                           'enBY+kLmbPXjiC9t4UDob3RiYu6HkDC2xvu8yLhlQTtsjCac2BkePJa/OTxttwY5G6OyYqWjmSmX9D6GZ13'
                           'CRr/rSxjXYo/2GE/0xyv27/Z+ikxjs6rzXXOhdxJ6hY1jD1D8+fHVxhr8+n6Zbod8and0rlgmarfRoRYlLh'
                           'GoRSCxNyOi6bG5ugrlIEXi8JZr8CpztGp/8WTa82XCSClFJPteC/5vLvwPGxwOraZ/BJngBPbmeeloN5lBl'
                           'W0KAndRqwNZcDBt8JnGioPd0Kv+SNufwR4nHCv8NgEXAMPLE')
res = client.patch_admins(names=['pureuser'], admin=myAdmin)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: ids
# See section "Common Fields" for examples

post_admins

from pypureclient.flashblade.FB_2_15 import AdminPost, ReferenceWritable

password = 'FAKEnewpaSsword'
public_key = ('ssh-rsa EXAMPLEzaC1yc2EAAAADAQABAAABAQDN1fshdvABLD/f2mkAUqkcUMKPsS+Os3omYFwe3G2Adxc'
              'enBY+kLmbPXjiC9t4UDob3RiYu6HkDC2xvu8yLhlQTtsjCac2BkePJa/OTxttwY5G6OyYqWjmSmX9D6GZ13'
              'CRr/rSxjXYo/2GE/0xyv27/Z+ikxjs6rzXXOhdxJ6hY1jD1D8+fHVxhr8+n6Zbod8and0rlgmarfRoRYlLh'
              'GoRSCxNyOi6bG5ugrlIEXi8JZr8CpztGp/8WTa82XCSClFJPteC/5vLvwPGxwOraZ/BJngBPbmeeloN5lBl'
              'W0KAndRqwNZcDBt8JnGioPd0Kv+SNufwR4nHCv8NgEXAMPLE')
NEW_ROLE_NAME = 'array_admin'
role_reference = ReferenceWritable(name=NEW_ROLE_NAME)
myAdmin = AdminPost(password=password, role=role_reference)
res = client.post_admins(names=['new-admin-1'], admin=myAdmin)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

myAdmin = AdminPost(password=password, public_key=public_key, role=role_reference)
res = client.post_admins(names=['new-admin-2'], admin=myAdmin)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields:
# See section "Common Fields" for examples

get_admins_settings

# list global admin settings
res = client.get_admins_settings()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: continuation_token, filter, limit, offset, sort
# See section "Common Fields" for examples

patch_admins_settings

from pypureclient.flashblade import AdminSetting

# Configure admin settings
settings = AdminSetting(lockout_duration=60, max_login_attempts=5, min_password_length=8)
res = client.patch_admins_settings(admin_setting=settings)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

Alert Watchers

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

delete_alert_watchers

# delete an alert watcher with a given email address. this address will no longer receive
# any emails about any alerts, new or updated, from the system
client.delete_alert_watchers(names=['moved_teams@mydomain.com'])

# Other valid fields: ids
# See section "Common Fields" for examples

get_alert_watchers

# list alert watchers with email address matching the below wildcard patterns. the first
# pattern includes all emails with "on_call" in them, and second pattern includes all
# emails ending with "@example.com"
res = client.get_alert_watchers(
    names=['*on_call*', '*@example.com'], sort='name-')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: continuation_token, filter, ids, limit, offset
# See section "Common Fields" for examples

patch_alert_watchers

from pypureclient.flashblade import AlertWatcher

# An example of how to disable an alert watcher, so they stop receiving all emails about
# alerts
watcher_settings = AlertWatcher(enabled=False)
res = client.patch_alert_watchers(
    names=['person_on_vacation@mydomain.com'], alert_watcher=watcher_settings)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# An example of how to set an alert watcher to only receive emails about alerts of severity
# 'critical'. This can be useful if there's an email alias tied directly into an on-call
# paging system or if there's an email alias of people who should be contacted about issues
# that need to be escalated quickly
watcher_settings = AlertWatcher(minimum_notification_severity='critical')
res = client.patch_alert_watchers(
    names=['storage_admins_on_call@mydomain.com'], alert_watcher=watcher_settings)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: ids
# See section "Common Fields" for examples

post_alert_watchers

from pypureclient.flashblade import AlertWatcherPost

# create an alert watcher with a given email address such that they'll receive emails
# about all system alerts
res = client.post_alert_watchers(names=['i_get_everything@example.com'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# create an alert watcher with a given email address such that they'll only receive emails
# about alerts of severity 'warning' and above
watcher_create_settings = AlertWatcherPost(minimum_notification_severity='warning')
res = client.post_alert_watchers(names=['rack_monitor@example.com'],
                                 alert_watcher=watcher_create_settings)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

get_alert_watchers_test

# test alert watchers with given email addresses
res = client.get_alert_watchers_test(
    names=['test1@example.com', 'test2@example.com'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: filter, ids, sort
# See section "Common Fields" for examples

Alerts

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

get_alerts

res = client.get_alerts()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list alerts and sort by severity
res = client.get_alerts(sort='severity')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: continuation_token, filter, limit, ids, names, offset
# See section "Common Fields" for examples

patch_alerts

from pypureclient.flashblade import Alert

# unflag an alert with the given id
alert_settings = Alert(flagged=False)
res = client.patch_alerts(
    names=['1'], alerts_settings=alert_settings)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: ids
# See section "Common Fields" for examples

API Clients

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

delete_api_clients

# delete the API client with name 'my_api_client'
client.delete_api_clients(names=['my_api_client'])

# Other valid fields: ids
# See section "Common Fields" for examples

get_api_clients

# List all configured api clients.
res = client.get_api_clients()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# List first two api clients beginning with 'my_oauth'. Use default sorting.
res = client.get_api_clients(limit=2, names=["my_oauth"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# List the first api client when sorting by name.
res = client.get_api_clients(limit=1, sort="name")
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# List an api client by id.
res = client.get_api_clients(ids=["10314f42-020d-7080-8013-000ddt400090"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# List all api_clients servers that are enabled.
res = client.get_api_clients(filter='enabled=\"True\"')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: continuation_token, offset
# See section "Common Fields" for examples

patch_api_clients

from pypureclient.flashblade import ApiClient

CLIENT_NAME = 'my_api_client'

# Enable the api client.
attr = ApiClient(enabled=True)
res = client.patch_api_clients(api_clients=attr, names=[CLIENT_NAME])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: ids
# See section "Common Fields" for examples

post_api_clients

from pypureclient.flashblade import ApiClientsPost

CLIENT_NAME = 'my_api_client'
CLIENT_TTL_IN_MS = 1000 * 60 * 60       # 1 hour in milliseconds
CLIENT_PUB_KEY = ("\n"
                  "-----BEGIN PUBLIC KEY-----\n"
                  "MIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEArSe6chh1JzME9svOKjU0\n"
                  "eKTm8S23Ok3Vr2bWuPri/YHfLrlnRwWoCt+st0/BebKSJ+fQUWOaLlqpZQKpI8oR\n"
                  "gJ9sWmwGibVG8cTuz7XMkskx9bsm/bjIenuB4W+s3g0BCsi9930mfdKgJgFzY69O\n"
                  "nLh7d7hAFcmhSJa945PryQZpvJ/U4Ue5F4d+WXgEJ0SoSRaZ6bbeMPhcbMHTzTum\n"
                  "2ZrPBkK5cqPYitaso6BXeAlqNQPw4Kbu4Ugm0CTogrtImkwoonWDDP34XMOq+u7q\n"
                  "sNTbJSvDKMTM1RPPrTWCaLiuZkdLVEVesZ9/8+XUMIgBTElwQJDCAQer03MJzqRr\n"
                  "1eCZGgLfDuYqwMG2MFaAX7kgqBwwyqRTd6MxaQxt2nkdfwiXSY71llzEQ23g3T+1\n"
                  "64zjwAL5f+dtu8PkGF7IdU2T8P2Qk9bG9pckwZHWYkBK77BAk5jbmSzsKGZgRb2R\n"
                  "1E+TWDKIaveFhQp251j/C5wkZwMXgjOzN+BOPo+OiLBGUl+jRybWA9f7Vq1MEdf6\n"
                  "SEdLiqYrXcZERkYBMieLXAfdtaztAIb96cUu+OKMSLDk+D0GHkUfm7lEbDK3ew1+\n"
                  "D6z+BnxDyH6oqZzz4lS2kPLBLsc+6pdTGuKLf0S9YuLiqJe659AdwU8+X/3KtwNd\n"
                  "FVJSaxdFbWx0nj3hJqFkIO8CAwEAAQ==\n"
                  "-----END PUBLIC KEY-----\n")

# Create a new api client with a max_role of storage_admin who has permissions to
# perform storage related operations such as administering volumes, hosts and host groups.
# Note that this created api client will have the lesser of the permissions granted by max_role
# in the api_client and the max role of the associated oauth login.
# The public_key will be the key provided by your oauth login provider.
attr = ApiClientsPost(max_role={'name': 'storage_admin'},
                      public_key=CLIENT_PUB_KEY,
                      issuer=CLIENT_NAME,
                      access_token_ttl_in_ms=CLIENT_TTL_IN_MS)
res = client.post_api_clients(names=[CLIENT_NAME], api_client=attr)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

Array Connections

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

get_array_connections_connection_key

# list all connection keys
res = client.get_array_connections_connection_key()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: continuation_token, filter, ids, limit, names, offset, sort
# See section "Common Fields" for examples

post_array_connections_connection_key

# post to the array-connections/connection-key endpoint to get a connection key
res = client.post_array_connections_connection_key()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

delete_array_connections

# delete the array connection with the name 'otherarray'
client.delete_array_connections(remote_names=['otherarray'])

# delete the array connection with id '10314f42-020d-7080-8013-000ddt400090'
client.delete_array_connections(remote_ids=['10314f42-020d-7080-8013-000ddt400090'])

# Other valid fields: ids, context_names
# See section "Common Fields" for examples

get_array_connections

# list all array connections
res = client.get_array_connections()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list all array connections with remote name "otherarray"
res = client.get_array_connections(remote_names=["otherarray"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list all array connections with remote id '10314f42-020d-7080-8013-000ddt400090'
res = client.get_array_connections(remote_ids=['10314f42-020d-7080-8013-000ddt400090'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list first five array connections and sort by source in descendant order
res = client.get_array_connections(limit=5, sort="version-")
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list all remaining array connections
res = client.get_array_connections(continuation_token=res.continuation_token)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list with filter to see only array connections on a specified version
res = client.get_array_connections(filter='version=\'3.*\'')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: allow_errors, context_names, ids, offset
# See section "Common Fields" for examples

patch_array_connections

from pypureclient.flashblade import ArrayConnection

# Update the management and replication addresses of an array connection
new_attr = ArrayConnection(management_address="10.202.101.70",
                           replication_addresses=["10.202.101.71", "10.202.101.72"])
# update the array connection named otherarray
res = client.patch_array_connections(remote_names=["otherarray"], array_connection=new_attr)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# update the array connection with id '10314f42-020d-7080-8013-000ddt400090'
res = client.patch_array_connections(ids=['10314f42-020d-7080-8013-000ddt400090'],
                                     array_connection=new_attr)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: context_names, remote_ids
# See section "Common Fields" for examples

get_array_connections_path

# list all array connection paths
res = client.get_array_connections_path()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list first five array connection paths using default sort
res = client.get_array_connections_path(limit=5)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list first five array connection paths and sort by source in descendant order
res = client.get_array_connections_path(limit=5, sort="source-")
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list all remaining array connection paths
res = client.get_array_connections_path(continuation_token=res.continuation_token)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list with filter to see only array connection paths from a specified source ip
res = client.get_array_connections_path(filter='source=\'10.202.101.70\'')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: allow_errors, context_names, ids, remote_ids, remote_names, offset
# See section "Common Fields" for examples

get_array_connections_performance_replication

# list instantaneous replication performance for all array connections
res = client.get_array_connections_performance_replication()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list instantaneous file-replication performance for all array connections
res = client.get_array_connections_performance_replication(type='file-system')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list instantaneous file-replication performance for array connection with id '10314f42-020d-7080-8013-000ddt400090'
res = client.get_array_connections_performance_replication(ids=['10314f42-020d-7080-8013-000ddt400090'],
                                                           type='file-system')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list historical object-replication performance for all array connections between some
# start time and end time
res = client.get_array_connections_performance_replication(
    start_time=START_TIME,
    end_time=END_TIME,
    type='object-store',
    resolution=30000)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list historical object-replication performance for array connection 'remote_array' between some
# start time and end time
res = client.get_array_connections_performance_replication(
    start_time=START_TIME,
    end_time=END_TIME,
    resolution=30000,
    type='object-store',
    remote_names=['remote_array'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: continuation_token, filter, limit, offset, remote_ids, remote_names,
#                     sort, total_only
# See section "Common Fields" for examples

post_array_connections

from pypureclient.flashblade import ArrayConnectionPost

# connect to an array with specified hostname, using a provided connection key
hostname = "https://my.array.com"
connection_key = "6207d123-d123-0b5c-5fa1-95fabc5c7123"
myAC = ArrayConnectionPost(management_address=hostname, connection_key=connection_key)

# post the array connection object on the array we're connection from
res = client.post_array_connections(array_connection=myAC)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# connect to an array by ip address and specifying replication addresses, using a provided connection key
mgmt_addr = "10.202.101.78"
repl_addr = ["10.202.101.70"]
connection_key = "6207d123-d123-0b5c-5fa1-95fabc5c7123"
myAC = ArrayConnectionPost(management_address=mgmt_addr, replication_addresses=repl_addr, connection_key=connection_key)

# post the array connection object on the array we're connection from
res = client.post_array_connections(array_connection=myAC)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: context_names
# See section "Common Fields" for examples

Arrays

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

get_arrays_eula

res = client.get_arrays_eula()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Valid fields: continuation_token, filter, limit, offset, sort
# See section "Common Fields" for examples

patch_arrays_eula

from pypureclient.flashblade import Eula, EulaSignature

# Update the EULA with eula body parameter
# The fields 'name', 'title', 'company' are no longer required, but are still accepted and will be ignored.

signature = EulaSignature(name="example name", title="example", company="one company")
eula_body = Eula(signature=signature)
res = client.patch_arrays_eula(eula=eula_body)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Update the EULA with eula empty body parameter
# eula body with empty signature are still accepted, but will be ignored.
signature = EulaSignature()
eula_body = Eula(signature=signature)
res = client.patch_arrays_eula(eula=eula_body)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Update the EULA with no parameter
res = client.patch_arrays_eula()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

delete_arrays_factory_reset_token

# Delete the array's factory reset token
client.delete_arrays_factory_reset_token()

get_arrays_factory_reset_token

# List the array's factory reset token
res = client.get_arrays_factory_reset_token()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: continuation_token, filter, limit, offset, sort
# See section "Common Fields" for examples

post_arrays_factory_reset_token

# Create a factory reset token for the array
res = client.post_arrays_factory_reset_token()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

get_arrays

res = client.get_arrays()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: continuation_token, filter, limit, offset, sort
# See section "Common Fields" for examples

get_arrays_http_specific_performance

res = client.get_arrays_http_specific_performance()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list historical http performance
res = client.get_arrays_http_specific_performance(
    start_time=START_TIME,
    end_time=END_TIME,
    resolution=30000)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: allow_errors, context_names
# See section "Common Fields" for examples

get_arrays_nfs_specific_performance

res = client.get_arrays_nfs_specific_performance()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list historical nfs performance
res = client.get_arrays_nfs_specific_performance(
    start_time=START_TIME,
    end_time=END_TIME,
    resolution=30000)

# Other valid fields: allow_errors, context_names
# See section "Common Fields" for examples

patch_arrays

from pypureclient.flashblade import Array, Reference

# Set the banner to "example-banner"
# Rename the array to "example-name"
# Set the NTP server to "0.example.ntp.server"
# Change the array time zone to "America/Los_Angeles"
# Change the default TLS policy that applies to inbound TLS on all vips without
# a more specific policy that applies to them
new_default_tls_policy = Reference(name='my-strong-tls-policy')
array_settings = Array(banner="example-banner",
                       name="example-name",
                       ntp_servers=["0.example.ntp.server"],
                       time_zone="America/Los_Angeles",
                       default_inbound_tls_policy=new_default_tls_policy)
res = client.patch_arrays(array=array_settings)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

get_arrays_performance

res = client.get_arrays_performance()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list array performance for http
res = client.get_arrays_performance(protocol='http')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list array performance for s3
res = client.get_arrays_performance(protocol='s3')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list array performance for nfs
res = client.get_arrays_performance(protocol='nfs')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list historical array performance
res = client.get_arrays_performance(
    start_time=START_TIME,
    end_time=END_TIME,
    resolution=30000)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))


# Other valid fields: allow_errors, context_names
# See section "Common Fields" for examples

get_arrays_performance_replication

# list instantaneous replication performance for array
res = client.get_arrays_performance_replication()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list instantaneous file-replication performance for array
res = client.get_arrays_performance_replication(type='file-system')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list historical object-replication performance for array between some
# start time and end time
res = client.get_arrays_performance_replication(
    start_time=START_TIME,
    end_time=END_TIME,
    type='object-store',
    resolution=30000)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: allow_errors, context_names
# See section "Common Fields" for examples

get_arrays_s3_specific_performance

res = client.get_arrays_s3_specific_performance()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list historical s3 performance
res = client.get_arrays_s3_specific_performance(
    start_time=START_TIME,
    end_time=END_TIME,
    resolution=30000)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: allow_errors, context_names
# See section "Common Fields" for examples

get_arrays_space

res = client.get_arrays_space()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list array space of file systems
res = client.get_arrays_space(type='file-system')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list historical array space
res = client.get_arrays_space(start_time=START_TIME,
                              end_time=END_TIME,
                              resolution=30000)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: allow_errors, context_names
# See section "Common Fields" for examples

get_arrays_space_storage_classes

res = client.get_arrays_space_storage_classes()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list storage class space of S500X-S storage class
res = client.get_arrays_space_storage_classes(storage_class_names='S500X-S')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list historical storage class space
res = client.get_arrays_space_storage_classes(start_time=START_TIME,
                              end_time=END_TIME,
                              resolution=30000)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: continuation_token, filter, limit, offset, sort, total_only
# See section "Common Fields" for examples

get_arrays_supported_time_zones

res = client.get_arrays_supported_time_zones()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: continuation_token, filter, limit, names, offset, sort
# See section "Common Fields" for examples

Audits

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

get_audits

# list all audits
res = client.get_audits()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: continuation_token, filter, ids, limit, names, offset, sort
# See section "Common Fields" for examples

Authorization

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

Blades

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

get_blades

# list all blades
res = client.get_blades()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list a subset of blades by name
res = client.get_blades(names=['CH1.FB1', 'CH1.FB2'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list a subset of blades by id
res = client.get_blades(ids=['100abf42-0000-4000-8023-000det400090',
                             '10314f42-020d-7080-8013-000ddt400090'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list all healthy blades
res = client.get_blades(filter='status=\'healthy\'')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: continuation_token, limit, offset, sort, total_only
# See section "Common Fields" for examples

Buckets

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

delete_buckets_bucket_access_policies

# delete a bucket access policy by bucket name
client.delete_buckets_bucket_access_policies(bucket_names=["bkt1"])
# delete a bucket access policy by bucket id
client.delete_buckets_bucket_access_policies(bucket_ids=["28674514-e27d-48b3-ae81-d3d2e868f647"])
# delete a bucket access policy by name
client.delete_buckets_bucket_access_policies(names=["bkt1/access-policy"])

# Other valid fields: context_names
# See section "Common Fields" for examples

get_buckets_bucket_access_policies

# list bucket access policy by bucket id
res = client.get_buckets_bucket_access_policies(bucket_ids=["28674514-e27d-48b3-ae81-d3d2e868f647"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list bucket access policy by bucket name
res = client.get_buckets_bucket_access_policies(bucket_names=["bkt1"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list bucket access policy by policy name
res = client.get_buckets_bucket_access_policies(names=["bkt1/access-policy"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: allow_errors, context_names, continuation_token, filter, limit, offset, sort
# See section "Common Fields" for examples

post_buckets_bucket_access_policies

from pypureclient.flashblade import BucketAccessPolicyPost, BucketAccessPolicyRule, BucketAccessPolicyRulePrincipal

# create an empty access policy
res = client.post_buckets_bucket_access_policies(bucket_names=["bkt1"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# create an access policy with the public read rule
rule = BucketAccessPolicyRule(
    name="myrule",
    actions=["s3:GetObject"],
    principals=BucketAccessPolicyRulePrincipal(
        all=True
    ),
    resources=["bkt1/*"]
)
policy = BucketAccessPolicyPost(
    rules=[rule]
)

# post with bucket name
res = client.post_buckets_bucket_access_policies(bucket_names=["bkt1"], policy=policy)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# post with bucket ID
res = client.post_buckets_bucket_access_policies(bucket_ids=["28674514-e27d-48b3-ae81-d3d2e868f647"], policy=policy)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: context_names
# See ids in section "Common Fields" for examples

delete_buckets_bucket_access_policies_rules

# delete a bucket access policy rule by bucket name
client.delete_buckets_bucket_access_policies_rules(bucket_names=["bkt1"], names=["myrule"])
# delete a bucket access policy rule by bucket id
client.delete_buckets_bucket_access_policies_rules(bucket_ids=["28674514-e27d-48b3-ae81-d3d2e868f647"], names=["myrule"])
# delete a bucket access policy rule by policy name
client.delete_buckets_bucket_access_policies_rules(policy_names=["bkt1/access-policy"], names=["myrule"])

# Other valid fields: context_names
# See section "Common Fields" for examples

get_buckets_bucket_access_policies_rules

# list all bucket access policy rules by bucket id
res = client.get_buckets_bucket_access_policies_rules(bucket_ids=["28674514-e27d-48b3-ae81-d3d2e868f647"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list all bucket access policy rules by bucket name
res = client.get_buckets_bucket_access_policies_rules(bucket_names=["bkt1"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list all bucket access policy rules by policy name
res = client.get_buckets_bucket_access_policies_rules(policy_names=["bkt1/access-policy"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list specific bucket access policy rule
res = client.get_buckets_bucket_access_policies_rules(policy_names=["bkt1/access-policy"], names=["myrule"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: allow_errors, context_names, continuation_token, filter, limit, offset, sort
# See section "Common Fields" for examples

post_buckets_bucket_access_policies_rules

from pypureclient.flashblade import BucketAccessPolicyRulePost, BucketAccessPolicyRulePrincipal

# create a public read rule
rule = BucketAccessPolicyRulePost(
    actions=["s3:GetObject"],
    principals=BucketAccessPolicyRulePrincipal(
        all=True
    ),
    resources=["bkt1/*"]
)

# create by policy name
res = client.post_buckets_bucket_access_policies_rules(policy_names=["bkt1/access-policy"], names=["myrule"], rule=rule)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# create by bucket name
res = client.post_buckets_bucket_access_policies_rules(bucket_names=["bkt1"], names=["myrule"], rule=rule)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# create by bucket id
res = client.post_buckets_bucket_access_policies_rules(bucket_ids=["28674514-e27d-48b3-ae81-d3d2e868f647"], names=["myrule"], rule=rule)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: context_names
# See ids in section "Common Fields" for examples

delete_buckets_cross_origin_resource_sharing_policies

# delete a bucket cross-origin resource sharing policy by bucket name
client.delete_buckets_cross_origin_resource_sharing_policies(bucket_names=["bkt1"])
# delete a bucket cross-origin resource sharing policy by bucket id
client.delete_buckets_cross_origin_resource_sharing_policies(bucket_ids=["28674514-e27d-48b3-ae81-d3d2e868f647"])
# delete a bucket cross-origin resource sharing policy by name
client.delete_buckets_cross_origin_resource_sharing_policies(names=["bkt1/cors-policy"])

# Other valid fields: context_names
# See section "Common Fields" for examples

get_buckets_cross_origin_resource_sharing_policies

# list bucket cross-origin resource sharing policy by bucket id
res = client.get_buckets_cross_origin_resource_sharing_policies(bucket_ids=["28674514-e27d-48b3-ae81-d3d2e868f647"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list bucket cross-origin resource sharing policy by bucket name
res = client.get_buckets_cross_origin_resource_sharing_policies(bucket_names=["bkt1"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list bucket cross-origin resource sharing policy by policy name
res = client.get_buckets_cross_origin_resource_sharing_policies(names=["bkt1/cors-policy"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: allow_errors, context_names, continuation_token, filter, limit, offset, sort
# See section "Common Fields" for examples

post_buckets_cross_origin_resource_sharing_policies

from pypureclient.flashblade import CrossOriginResourceSharingPolicyPatch, CrossOriginResourceSharingPolicyRule

# create an empty cross-origin resource sharing policy
res = client.post_buckets_cross_origin_resource_sharing_policies(bucket_names=["bkt1"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# create a cross-origin resource sharing policy with the allow all rule
rule = CrossOriginResourceSharingPolicyRule(
    name="myrule",
    allowed_headers=["*"],
    allowed_methods=["GET","PUT","HEAD","POST","DELETE"],
    allowed_origins=["*"]
)
policy = CrossOriginResourceSharingPolicyPatch(
    rules=[rule]
)

# post with bucket name
res = client.post_buckets_cross_origin_resource_sharing_policies(bucket_names=["bkt1"], policy=policy)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# post with bucket ID
res = client.post_buckets_cross_origin_resource_sharing_policies(bucket_ids=["28674514-e27d-48b3-ae81-d3d2e868f647"], policy=policy)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: context_names
# See ids in section "Common Fields" for examples

delete_buckets_cross_origin_resource_sharing_policies_rules

# delete a bucket cross-origin resource sharing policy rule by bucket name
client.delete_buckets_cross_origin_resource_sharing_policies_rules(bucket_names=["bkt1"], names=["myrule"])
# delete a bucket cross-origin resource sharing policy rule by bucket id
client.delete_buckets_cross_origin_resource_sharing_policies_rules(bucket_ids=["28674514-e27d-48b3-ae81-d3d2e868f647"], names=["myrule"])
# delete a bucket cross-origin resource sharing policy rule by policy name
client.delete_buckets_cross_origin_resource_sharing_policies_rules(policy_names=["bkt1/cors-policy"], names=["myrule"])

# Other valid fields: context_names
# See section "Common Fields" for examples

get_buckets_cross_origin_resource_sharing_policies_rules

# list all bucket cross-origin resource sharing policy rules by bucket id
res = client.get_buckets_cross_origin_resource_sharing_policies_rules(bucket_ids=["28674514-e27d-48b3-ae81-d3d2e868f647"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list all bucket cross-origin resource sharing policy rules by bucket name
res = client.get_buckets_cross_origin_resource_sharing_policies_rules(bucket_names=["bkt1"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list all bucket cross-origin resource sharing policy rules by policy name
res = client.get_buckets_cross_origin_resource_sharing_policies_rules(policy_names=["bkt1/cors-policy"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list specific bucket cross-origin resource sharing policy rule
res = client.get_buckets_cross_origin_resource_sharing_policies_rules(policy_names=["bkt1/cors-policy"], names=["myrule"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: allow_errors, context_names, continuation_token, filter, limit, offset, sort
# See section "Common Fields" for examples

post_buckets_cross_origin_resource_sharing_policies_rules

from pypureclient.flashblade import CrossOriginResourceSharingPolicyRulePost

# create an allow all rule
rule = CrossOriginResourceSharingPolicyRulePost(
    allowed_headers=["*"],
    allowed_methods=["GET","PUT","HEAD","POST","DELETE"],
    allowed_origins=["*"]
)

# create by policy name
res = client.post_buckets_cross_origin_resource_sharing_policies_rules(policy_names=["bkt1/cors-policy"], names=["myrule"], rule=rule)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# create by bucket name
res = client.post_buckets_cross_origin_resource_sharing_policies_rules(bucket_names=["bkt1"], names=["myrule"], rule=rule)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# create by bucket id
res = client.post_buckets_cross_origin_resource_sharing_policies_rules(bucket_ids=["28674514-e27d-48b3-ae81-d3d2e868f647"], names=["myrule"], rule=rule)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: context_names
# See ids in section "Common Fields" for examples

delete_buckets

# delete the bucket object mybucket on the array
client.delete_buckets(names=["mybucket"])

# Other valid fields: context_names, ids
# See section "Common Fields" for examples

get_buckets

# list all buckets
res = client.get_buckets()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list all destroyed buckets
res = client.get_buckets(destroyed=True)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list and sort by unique in descendant order
res = client.get_buckets(limit=5, sort="space.unique-")
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list with page size 5
res = client.get_buckets(limit=5)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list all remaining object store accounts
res = client.get_buckets(continuation_token=res.continuation_token)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list with filter
res = client.get_buckets(filter='name=\'mybucket*\'')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: allow_errors, context_names, ids, names, offset, total_only
# See section "Common Fields" for examples

patch_buckets

from pypureclient.flashblade import Bucket, ObjectLockConfigRequestBody, PublicAccessConfig, BucketEradicationConfig

# Destroy the bucket named "mybucket", and also suspend versioning
res = client.patch_buckets(names=["mybucket"],
                           bucket=Bucket(destroyed=True, versioning="suspended"))
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Recover the bucket "mybucket", and also enable versioning
res = client.patch_buckets(names=["mybucket"],
                           bucket=Bucket(destroyed=False, versioning="enabled"))
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Update the quota settings for "mybucket". Enable a hard limit (i.e. enforced)
# quota of 10G for this bucket.
res = client.patch_buckets(names=["mybucket"],
                           bucket=Bucket(quota_limit=str(10*1024*1024*1024),
                                         hard_limit_enabled=True))
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Reduce the hard limit quota for "mybucket" to 1G while ignoring its current usage (i.e.
# the operation should not fail due to the bucket's size currently being greater than 1G)
res = client.patch_buckets(names=["mybucket"],
                           bucket=Bucket(quota_limit=str(1*1024*1024*1024)),
                           ignore_usage=True)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Clear the quota limit for "mybucket"
res = client.patch_buckets(names=["mybucket"],
                           bucket=Bucket(quota_limit='',))
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Enable object lock for "mybucket"
res = client.patch_buckets(names=["mybucket"],
                           bucket=Bucket(object_lock_config=ObjectLockConfigRequestBody(enabled=True)))
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Change default retention to 1 day and default retention mode to "compliance" for "mybucket".
res = client.patch_buckets(names=["mybucket"],
                           bucket=Bucket(object_lock_config=ObjectLockConfigRequestBody(
                               default_retention=86400000,  # 1 day in ms
                               default_retention_mode="compliance")))
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Change retention lock to "ratcheted" to prevent the level of locked objects protection
# from being decreased and to disable manual eradication of the bucket for "mybucket".
res = client.patch_buckets(names=["mybucket"],
                           bucket=Bucket(retention_lock="ratcheted"))
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Freeze locked objects to prevent object overwrite after object lock is enabled for "mybucket".
res = client.patch_buckets(names=["mybucket2"],
                           bucket=Bucket(object_lock_config=ObjectLockConfigRequestBody(freeze_locked_objects=True)))
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Disable block new public policies for "mybucket".
res = client.patch_buckets(names=["mybucket"],
                           bucket=Bucket(public_access_config=PublicAccessConfig(block_new_public_policies=False)))
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Disable block public access for "mybucket".
res = client.patch_buckets(names=["mybucket"],
                           bucket=Bucket(public_access_config=PublicAccessConfig(block_public_access=False)))
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Block new public policies and public access for "mybucket".
res = client.patch_buckets(names=["mybucket"],
                           bucket=Bucket(public_access_config=PublicAccessConfig(
                           block_new_public_policies=True,
                           block_public_access=True)))
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Change eradication mode to "retention-based" to prevent eradication of the bucket
# as long as there areany objects are protected with object lock of the bucket for "mybucket".
res = client.patch_buckets(names=["mybucket"],
                           bucket=Bucket(
                           eradication_config=
                           BucketEradicationConfig(eradication_mode="retention-based")))
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: context_names, ids
# See section "Common Fields" for examples

get_buckets_performance

# list instantaneous performance for all buckets
res = client.get_buckets_performance()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list instantaneous performance for buckets 'bucket1' and 'bucket2'
res = client.get_buckets_performance(names=['bucket1', 'bucket2'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list historical buckets performance for all buckets between some
# start time and end time
res = client.get_buckets_performance(
    start_time=START_TIME,
    end_time=END_TIME,
    resolution=30000)

# list historical buckets performance for buckets 'bucket1' and 'bucket2' between some
# start time and end time
res = client.get_buckets_performance(
    start_time=START_TIME,
    end_time=END_TIME,
    resolution=30000,
    names=['bucket1', 'bucket2'])

# total instantaneous performance across 2 buckets
res = client.get_buckets_performance(names=['bucket1', 'bucket2'], total_only=True)
print(res)

# Other valid fields: continuation_token, filter, ids, limit, offset, sort
# See section "Common Fields" for examples

post_buckets

from pypureclient.flashblade import BucketPost, Reference, ObjectLockConfigRequestBody, BucketEradicationConfig

# Create the bucket "mybucket" under the account named "myaccount"
attr = BucketPost()
attr.account = Reference(name='myaccount')
res = client.post_buckets(names=["mybucket"], bucket=attr)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Make another bucket in "myaccount" with id '10314f42-020d-7080-8013-000ddt400090'. Provide an
# initial hard limit (i.e. enforced) quota configuration of 5G.
attr = BucketPost(account=Reference(id='10314f42-020d-7080-8013-000ddt400090'),
                  quota_limit=str(5 * 1024 * 1024),
                  hard_limit_enabled=True)
res = client.post_buckets(names=["mybucket2"], bucket=attr)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Create the bucket "mybucket3" under the account named "myaccount". Freeze locked objects
# to prevent object overwrite after object lock is enabled.
attr = BucketPost()
attr.account = Reference(name='myaccount')
attr.object_lock_config = ObjectLockConfigRequestBody(freeze_locked_objects=True)
res = client.post_buckets(names=["mybucket3"], bucket=attr)

print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Create the bucket "mybucket4" under the account named "myaccount". Freeze locked objects
# to prevent object overwrite, and enable object-lock.
attr = BucketPost()
attr.account = Reference(name='myaccount')
attr.object_lock_config = ObjectLockConfigRequestBody(
    enabled=True,
    freeze_locked_objects=True)
res = client.post_buckets(names=["mybucket4"], bucket=attr)

print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Create the bucket "mybucket5" under the account named "myaccount". Freeze locked objects
# to prevent object overwrite. By default, users will be able to use object lock for new objects
# in "mybucket5" with a retention period of 1 day, and "compliance" retention mode. Furthermore,
# the bucket will have a "ratcheted" retention lock to prevent the level of bucket protection
# from being decreased and to disable manual eradication of the bucket.
attr = BucketPost()
attr.account = Reference(name='myaccount')
attr.object_lock_config = ObjectLockConfigRequestBody(
    enabled=True,
    freeze_locked_objects=True,
    default_retention=86400000,  # 1 day in ms
    default_retention_mode="compliance")
attr.retention_lock = "ratcheted"
res = client.post_buckets(names=["mybucket5"], bucket=attr)

print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Create the bucket "mybucket6" under the account named "myaccount" and
# override the bucket_type, which is 'multi-site-writable' by default.
attr = BucketPost()
attr.bucket_type = 'classic'
attr.account = Reference(name='myaccount')
res = client.post_buckets(names=["mybucket6"], bucket=attr)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Create the bucket "mybucket" under the account named "myaccount". Freeze locked objects
# to prevent object overwrite. By default, users will be able to use object lock for new objects
# in "mybucket" with a retention period of 1 day, and "compliance" retention mode. Furthermore,
# the bucket will have eradication mode set to "retention-based" to prevent eradication of the bucket
# as long as there are any objects are protected with object lock of the bucket for "mybucket".
attr = BucketPost()
attr.account = Reference(name='myaccount')
attr.object_lock_config = ObjectLockConfigRequestBody(
    enabled=True,
    freeze_locked_objects=True,
    default_retention=86400000,  # 1 day in ms
    default_retention_mode="compliance")
attr.eradication_config = BucketEradicationConfig(eradication_mode="retention-based")
res = client.post_buckets(names=["mybucket"], bucket=attr)

print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: context_names
# See ids in section "Common Fields" for examples

get_buckets_s3_specific_performance

# list instantaneous s3 performance for all buckets
res = client.get_buckets_s3_specific_performance()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list instantaneous s3 performance for buckets 'bucket1' and 'bucket2'
res = client.get_buckets_s3_specific_performance(names=['bucket1', 'bucket2'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list historical buckets s3 performance for all buckets between some
# start time and end time
res = client.get_buckets_s3_specific_performance(
    start_time=START_TIME,
    end_time=END_TIME,
    resolution=30000)

# list historical buckets s3 performance for buckets 'bucket1' and 'bucket2' between some
# start time and end time
res = client.get_buckets_s3_specific_performance(
    start_time=START_TIME,
    end_time=END_TIME,
    resolution=30000,
    names=['bucket1', 'bucket2'])

# total instantaneous s3 performance across 2 buckets
res = client.get_buckets_s3_specific_performance(names=['bucket1', 'bucket2'], total_only=True)
print(res)

# Other valid fields: continuation_token, filter, ids, limit, offset, sort
# See section "Common Fields" for examples

Certificate Groups

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

delete_certificate_groups_certificates

# remove 'posix-cert' from the 'all-trusted-certs' group
all_trusted_group = 'all-trusted-certs'
posix_cert = 'posix-cert'
client.delete_certificate_groups_certificates(certificate_names=[posix_cert],
                                              certificate_group_names=[all_trusted_group])


# remove both 'ad-cert-2' and 'ad-cert-1' from both the 'all-trusted-certs' group and the
# 'all-ad-certs' group
ad_cert1 = 'ad-cert-1'
ad_cert2 = 'ad-cert-2'
all_ad_group = 'all-ad-certs'
client.delete_certificate_groups_certificates(certificate_names=[ad_cert1, ad_cert2],
                                              certificate_group_names=[all_trusted_group, all_ad_group])

# Other valid fields: certificate_ids, certificate_group_ids
# See section "Common Fields" for examples

get_certificate_groups_certificates

# list all membership objects for certificate groups and the certificates that belong to
# them
res = client.get_certificate_groups_certificates()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list the membership objects to see what certificates are contained within groups
# 'all-trusted-certs' and 'all-ad-certs' belong to, if any
res = client.get_certificate_groups_certificates(certificate_group_names=['all-trusted-certs',
                                                                          'all-ad-certs'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: continuation_token, certificate_ids, certificate_group_ids,
#                     certificate_names, filter, limit, offset, sort
# See section "Common Fields" for examples

post_certificate_groups_certificates

# add 'posix-cert' to the 'all-trusted-certs' group
all_trusted_group = 'all-trusted-certs'
posix_cert = 'posix-cert'
res = client.post_certificate_groups_certificates(certificate_names=[posix_cert],
                                                  certificate_group_names=[all_trusted_group])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# add both 'ad-cert-2' and 'ad-cert-1' to both the 'all-trusted-certs' group and the
# 'all-ad-certs' group
ad_cert1 = 'ad-cert-1'
ad_cert2 = 'ad-cert-2'
all_ad_group = 'all-ad-certs'
res = client.post_certificate_groups_certificates(certificate_names=[ad_cert1, ad_cert2],
                                                  certificate_group_names=[all_trusted_group, all_ad_group])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: certificate_ids, certificate_group_ids
# See section "Common Fields" for examples

delete_certificate_groups

# delete our group for active directory certificates
group_for_active_directory_certs = 'all-ad-certs'
client.delete_certificate_groups(names=[group_for_active_directory_certs])

# Other valid fields: ids
# See section "Common Fields" for examples

get_certificate_groups

# list all certificate groups
res = client.get_certificate_groups()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list the certificate groups named "all-trusted-certs" and "all-ad-certs"
res = client.get_certificate_groups(names=['all-trusted-certs',
                                           'all-ad-certs'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: continuation_token, filter, ids, limit, offset, sort
# See section "Common Fields" for examples

post_certificate_groups

# create groups to use for all certificates, as well as for all AD certificates
group_for_all_certs = 'all-trusted-certs'
group_for_active_directory_certs = 'all-ad-certs'
res = client.post_certificate_groups(names=[group_for_all_certs,
                                     group_for_active_directory_certs])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

get_certificate_groups_uses

# list the uses of all certificate groups
res = client.get_certificate_groups_uses()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list the uses of certificate groups named "all-trusted-certs" and "all-ad-certs"
res = client.get_certificate_groups_uses(names=['all-trusted-certs',
                                                'all-ad-certs'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: continuation_token, filter, ids, limit, offset, sort
# See section "Common Fields" for examples

Certificates

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

delete_certificates_certificate_groups

# remove 'posix-cert' from the 'all-trusted-certs' group
all_trusted_group = 'all-trusted-certs'
posix_cert = 'posix-cert'
client.delete_certificates_certificate_groups(certificate_names=[posix_cert],
                                              certificate_group_names=[all_trusted_group])

# remove both 'ad-cert-2' and 'ad-cert-1' from both the 'all-trusted-certs' group and the
# 'all-ad-certs' group
ad_cert1 = 'ad-cert-1'
ad_cert2 = 'ad-cert-2'
all_ad_group = 'all-ad-certs'
client.delete_certificates_certificate_groups(certificate_names=[ad_cert1, ad_cert2],
                                              certificate_group_names=[all_trusted_group, all_ad_group])

# Other valid fields: certificate_ids, certificate_group_ids
# See section "Common Fields" for examples

get_certificates_certificate_groups

# list all membership objects for certificate groups and the certificates that belong to them
res = client.get_certificates_certificate_groups()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list the membership objects to see what certificates are contained within groups
# 'all-trusted-certs' and 'all-ad-certs' belong to, if any
res = client.get_certificates_certificate_groups(certificate_group_names=['all-trusted-certs',
                                                                          'all-ad-certs'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# List the membership objects to see certificate groups that contain certificate 'ad-cert-1', if any
res = client.get_certificates_certificate_groups(certificate_names=['ad-cert-1'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: continuation_token, certificate_ids, certificate_group_ids, filter,
#                     limit, offset, sort
# See section "Common Fields" for examples

post_certificates_certificate_groups

# add 'posix-cert' to the 'all-trusted-certs' group
all_trusted_group = 'all-trusted-certs'
posix_cert = 'posix-cert'
res = client.post_certificates_certificate_groups(certificate_names=[posix_cert],
                                                  certificate_group_names=[all_trusted_group])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# add both 'ad-cert-2' and 'ad-cert-1' to both the 'all-trusted-certs' group and the
# 'all-ad-certs' group
ad_cert1 = 'ad-cert-1'
ad_cert2 = 'ad-cert-2'
all_ad_group = 'all-ad-certs'
res = client.post_certificates_certificate_groups(certificate_names=[ad_cert1, ad_cert2],
                                                  certificate_group_names=[all_trusted_group, all_ad_group])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: certificate_ids, certificate_group_ids
# See section "Common Fields" for examples

delete_certificates

# delete our external certificate named "ad-cert-1"
client.delete_certificates(names=['ad-cert-1'])

# Other valid fields: ids
# See section "Common Fields" for examples

get_certificates

# list all certificates
res = client.get_certificates()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list certificates named "ad-cert-1" and "posix-cert"
res = client.get_certificates(names=['ad-cert-1', 'posix-cert'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: continuation_token, filter, ids, limit, offset, sort
# See section "Common Fields" for examples

patch_certificates

from pypureclient.flashblade import CertificatePatch

# change our built-in certificate named "global", which is used by the REST server and S3
# to a new certificate issued by my internal CA
cert_name = 'global'
cert_text = '-----BEGIN CERTIFICATE-----\nMIIESzCCAzOgAwIBAgIJAIJMKJXXDn/JMA0GCSqGSIb3DQEBBQUAMHYxCzAJBgNV\nBAYTAlVTMQ0wCwYDVQQIEwR0ZXN0MQ4wDAYDVQQHEwV0ZXN0IDENMAsGA1UEChME\ndGVzdDENMAsGA1UECxMEdGVzdDEVMBMGA1UEAxMMUHVyZSBTdG9yYWdlMRMwEQYJ\nKoZIhvcNAQkBFgR0ZXN0MB4XDTE3MTEwNjIyMzYyMFoXDTE4MTEwNjIyMzYyMFow\ndjELMAkGA1UEBhMCVVMxDTALBgNVBAgTBHRlc3QxDjAMBgNVBAcTBXRlc3QgMQ0w\nCwYDVQQKEwR0ZXN0MQ0wCwYDVQQLEwR0ZXN0MRUwEwYDVQQDEwxQdXJlIFN0b3Jh\nZ2UxEzARBgkqhkiG9w0BCQEWBHRlc3QwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAw\nggEKAoIBAQDcaGpPXJC1EC515wMEKyXEFuKFEDn4y1V5YmaLt+hXz8cfuA+gS3eD\nltP8PJah+7WrPouUQtfamHsuQtnFFLcVcdl83rIFX0m58zUiWbOUHI5wWnBYsqof\n52k/m40HM5XTATn5xpFsTSxm7vmlsKfGlQS7yI11HbD0OOz9CqT+iMFhTn/Wfyg2\nYOtmYIfCz0kt6wIFHlI9oPERwJ0JiMnPhsg0gerJwYl1j1vDhBiK32OVc4iIdOO4\nPVwpP1YbINr8LJ5qX2DOzBHDnaYrtJk9YEsSAwoqJ2/d29xA9JOeJwahl/M6aO48\nAbXbSlxVwOz0lEs85dseLp9dyTQb/uzjAgMBAAGjgdswgdgwHQYDVR0OBBYEFJJM\nML8khiOYzpaJP8sJCn0JSpx9MIGoBgNVHSMEgaAwgZ2AFJJMML8khiOYzpaJP8sJ\nCn0JSpx9oXqkeDB2MQswCQYDVQQGEwJVUzENMAsGA1UECBMEdGVzdDEOMAwGA1UE\nBxMFdGVzdCAxDTALBgNVBAoTBHRlc3QxDTALBgNVBAsTBHRlc3QxFTATBgNVBAMT\nDFB1cmUgU3RvcmFnZTETMBEGCSqGSIb3DQEJARYEdGVzdIIJAIJMKJXXDn/JMAwG\nA1UdEwQFMAMBAf8wDQYJKoZIhvcNAQEFBQADggEBAKjQ/SFPra2YmtNynNukuHOl\nCryjsXjBkeiyyfg3Bt9+M+9F6Y4Sh3/SSJCb6LQaqTQkeJJeb1fOHNaFjAxkjvaI\n2tnlCwhpQuoSXNgQEMdidMi9+S8hBonlXYePYZUQbvAu1VAZrU6f0k2OEDcAPLvA\nhZLvrmZeug+VZp3JfVOdU+QnzUx2atBBfN5lMFFNdqOzZ5Yz/Ooi9CVA73szIevi\nE728OLimWQ91u1s16isjusK3+zoqirFC7PN6K63sp0gPAldgCQD2bywmwgaYDnzP\n+9ZWNy6ebn927Qh22YUPWhj+kiITkhxcVYPMx4QtRjJhs5pQVBqHOIDnJQJc7qY=\n-----END CERTIFICATE-----'
# use a private key that was encrypted with a passphrase
private_key = '-----BEGIN RSA PRIVATE KEY-----\nProc-Type: 4,ENCRYPTED\nDEK-Info: DES-EDE3-CBC,D6E1A92B08CB859F\n\nh+XvYwbbEIboztkR5/Gku7UsCnZtNI/ZYZru3jm/tRgjXR71PBgi9x1Rv5wyiDXA\n9F8xWyacRQgSqQCO2tc+rqoBTAd33wGo52k7BCuG2VJgbuzlZlC4vsyjKna1yGRw\nFHv+dHPWyTE/Cqcl0QQGjpqQmKbX6OXcUnDRp0IPzRf98A6DVZ/jbwuGl1JIkEme\nCuo4/5Hc4BMeHBYGtzbYZ83nFyrImhMQA+HzeULWSi0Ecx2vbafrlXVd0hI9E3c6\nsahuu6A9DSwEGWWW5x/ubq0i8mS94s7O4EjNoI8w6/yhd2edUTsTddJ2I+DJxOB1\nlBukWeph+/wAiCdVKuHW9A5xbPK0U24ipRh1vOG1ikeFR62gFktSnquOv4zpZL73\nSE7xWP1+FotaEgEL1hkHqfMfEnEL0/5oVyYVB9BZ2VaiystWvFk/mgLJiWGM0zx8\n5rA+0kqNTVYHhwElMUYMXILx3RMGVH+A0kKWvpl3BBuwDbQfgl0m1lLK6zZgtwVL\nkyctAjthTwC4KZorATa2CTBLq5cCSq1itoVueCYozuUPDMmCuC4Xf3dMEcYok+E5\nF4USqn7xcCqTu5ftqoiSt5bdJ7MOfL/KVXjQZAi/eUPaaREI27mqyfnVM6f2VcEp\nsQJnJg+zpcnBY0oICtGsakZWD0iE2ZA4FN177ogl8mlU4sY6XteHtPEFn8jjWuwW\ncylAo4jg/D6LPm+a7v1BYV41xLLQSFRvFGsyGON5CMg2vO9kjNnTDONNEchQ1C4A\nqIAIhjye+VD1F0L4McswRUQMISuWpbTND6HV2/DwXh9mDP2jVsttoJ3mjJrCeR1/\nTcMkN2C1isNUrRh+ReWtmanyhIorPLGX9TuDBef1r6caqVdGvDzjWaVUh6qTHsoY\nzt49SxXykIbZCdEbAQkoXfg8MuK+lxlGVEP/OS1uMXI8tVozBpepI8diFVznWpJo\nHVJCvcrOoIQr/B6kZX6mfqH5EJcnJPC4GUYwu+TRi03fmmKHi56xyWdrm/payoJH\n6ApOXeD4ViaFKkI6f69o5aADVZcmOWMqP6Yd8oxvl1Rn7ArR/RBcQwCMUZEA0dOs\ndu4S9hwTDlekT7unaVuXWmU9Js63DK82K3w+EjWUmYobX4tnM1nqJ4nBS8btt0kc\nBefHQP4gx72ytkJW4cVtFD/us0UBMTvODXDmBeZxlIJsNkU0EWyW+1kKBRpVhHGB\nofPRqYTk/m9yMzuDhutupW1uV+5g+lvpxXKQu4kSzJS6UVWZ33iz7yrvIOrJ3hxZ\nsJjWj+f0Bef/gym2JrGb1J756lPwBY4S/3/yiajbUvRvElOoVQB5XSH+th5N/hUJ\ntD2TJJsWnr/E6vwZjsYwK1hav/YcJi/YJdoXziZkKoYlf2WvwLAsvj9fNrpguwqV\npMJARiVwBDrWiB16GRdHxa0HwCJKB8Vpz9pDYQNdBseAhJzGmh5JaBiIbuVJaVwF\nZP+y2v/3Pa7wzAZTjD46V9EvADK6RW9If12OPHP4G2FvhdngxGbNjgZbEy0HUy4I\n6MRcPb3qaR5tnySoozrwW5IRYy7yZJ+UEg03nUi8eHKUL6anF5YzCg==\n-----END RSA PRIVATE KEY-----'
passphrase = 'example password'

create_body = CertificatePatch(certificate=cert_text, private_key=private_key, passphrase=passphrase)
res = client.patch_certificates(names=[cert_name], certificate=create_body)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: ids
# See section "Common Fields" for examples

post_certificates

from pypureclient.flashblade.FB_2_15 import CertificatePost

# create a new external certificate named "ad-cert-1"
cert_name = 'ad-cert-1'
cert_text = '-----BEGIN CERTIFICATE-----\nMIIESzCCAzOgAwIBAgIJAIJMKJXXDn/JMA0GCSqGSIb3DQEBBQUAMHYxCzAJBgNV\nBAYTAlVTMQ0wCwYDVQQIEwR0ZXN0MQ4wDAYDVQQHEwV0ZXN0IDENMAsGA1UEChME\ndGVzdDENMAsGA1UECxMEdGVzdDEVMBMGA1UEAxMMUHVyZSBTdG9yYWdlMRMwEQYJ\nKoZIhvcNAQkBFgR0ZXN0MB4XDTE3MTEwNjIyMzYyMFoXDTE4MTEwNjIyMzYyMFow\ndjELMAkGA1UEBhMCVVMxDTALBgNVBAgTBHRlc3QxDjAMBgNVBAcTBXRlc3QgMQ0w\nCwYDVQQKEwR0ZXN0MQ0wCwYDVQQLEwR0ZXN0MRUwEwYDVQQDEwxQdXJlIFN0b3Jh\nZ2UxEzARBgkqhkiG9w0BCQEWBHRlc3QwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAw\nggEKAoIBAQDcaGpPXJC1EC515wMEKyXEFuKFEDn4y1V5YmaLt+hXz8cfuA+gS3eD\nltP8PJah+7WrPouUQtfamHsuQtnFFLcVcdl83rIFX0m58zUiWbOUHI5wWnBYsqof\n52k/m40HM5XTATn5xpFsTSxm7vmlsKfGlQS7yI11HbD0OOz9CqT+iMFhTn/Wfyg2\nYOtmYIfCz0kt6wIFHlI9oPERwJ0JiMnPhsg0gerJwYl1j1vDhBiK32OVc4iIdOO4\nPVwpP1YbINr8LJ5qX2DOzBHDnaYrtJk9YEsSAwoqJ2/d29xA9JOeJwahl/M6aO48\nAbXbSlxVwOz0lEs85dseLp9dyTQb/uzjAgMBAAGjgdswgdgwHQYDVR0OBBYEFJJM\nML8khiOYzpaJP8sJCn0JSpx9MIGoBgNVHSMEgaAwgZ2AFJJMML8khiOYzpaJP8sJ\nCn0JSpx9oXqkeDB2MQswCQYDVQQGEwJVUzENMAsGA1UECBMEdGVzdDEOMAwGA1UE\nBxMFdGVzdCAxDTALBgNVBAoTBHRlc3QxDTALBgNVBAsTBHRlc3QxFTATBgNVBAMT\nDFB1cmUgU3RvcmFnZTETMBEGCSqGSIb3DQEJARYEdGVzdIIJAIJMKJXXDn/JMAwG\nA1UdEwQFMAMBAf8wDQYJKoZIhvcNAQEFBQADggEBAKjQ/SFPra2YmtNynNukuHOl\nCryjsXjBkeiyyfg3Bt9+M+9F6Y4Sh3/SSJCb6LQaqTQkeJJeb1fOHNaFjAxkjvaI\n2tnlCwhpQuoSXNgQEMdidMi9+S8hBonlXYePYZUQbvAu1VAZrU6f0k2OEDcAPLvA\nhZLvrmZeug+VZp3JfVOdU+QnzUx2atBBfN5lMFFNdqOzZ5Yz/Ooi9CVA73szIevi\nE728OLimWQ91u1s16isjusK3+zoqirFC7PN6K63sp0gPAldgCQD2bywmwgaYDnzP\n+9ZWNy6ebn927Qh22YUPWhj+kiITkhxcVYPMx4QtRjJhs5pQVBqHOIDnJQJc7qY=\n-----END CERTIFICATE-----'
cert_type = 'external'
create_body = CertificatePost(certificate=cert_text, certificate_type=cert_type)
res = client.post_certificates(names=[cert_name], certificate=create_body)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# create a new array certificate named "ad-cert-2"
cert_name = 'ad-cert-2'
cert_text = '-----BEGIN CERTIFICATE-----\nMIICNTCCAbsCCQCRnJR7HCsWbDAKBggqhkjOPQQDAjCBgjELMAkGA1UEBhMCVVMx\nEzARBgNVBAgMCkNhbGlmb3JuaWExFjAUBgNVBAcMDU1vdW50YWluIFZpZXcxFTAT\nBgNVBAoMDFB1cmUgU3RvcmFnZTEbMBkGA1UECwwSRmxhc2hCbGFkZSBUZXN0aW5n\nMRIwEAYDVQQDDAl0ZXN0LWVjLTIwIBcNMjExMjE1MjMzNzQyWhgPMjEyMTExMjEy\nMzM3NDJaMIGCMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQG\nA1UEBwwNTW91bnRhaW4gVmlldzEVMBMGA1UECgwMUHVyZSBTdG9yYWdlMRswGQYD\nVQQLDBJGbGFzaEJsYWRlIFRlc3RpbmcxEjAQBgNVBAMMCXRlc3QtZWMtMjB2MBAG\nByqGSM49AgEGBSuBBAAiA2IABAjj51tZhGmPS31wdIeBXFfbJ0UR+uw9/qX55ph+\n/bsaQHXYJ5iebbE3XkVugIKoRVywq9ql+DjRe0hFAPUZicPcikkIxuDiYclzm7ja\nN2StP9U6i2HS0gmufU4bRPBDhzAKBggqhkjOPQQDAgNoADBlAjBEOp4LxZxypvxd\n28QtBf8Kug/JuW+dMr3S2Z5Tenl0x7WZCoDxXGUyg8CF5V9T/hcCMQDiuY5ihnEG\nSA8PmcLPoc0tMnUVBIp0k8dyiq47BL8zabhuLc8RTvlYCpfNl4rtFSo=\n-----END CERTIFICATE-----\n'
private_key = '-----BEGIN ENCRYPTED PRIVATE KEY-----\nMIHgMBsGCSqGSIb3DQEFAzAOBAjU/e1D/TrYsgICCAAEgcBlj5k6GkoCr85PNj6y\npRalEktQQs0Y4VnVM9sRKe6FCwH2iMCU4t0KP7SrjNG+I5e41v7F968A2wyhn+7v\nY96zefS1VnumVFzLSNUVpv9eZM9MucaNXc3JJfa1XonsKg8MoRMofD3z7wUQqR6Y\nGUJZfl4ABNW9gbARnoKo4Wi4Vt6FLJjdgLTu3u1sYYB+JZg5EJNNCzwpyNi5rVK3\n-----END ENCRYPTED PRIVATE KEY-----\n'
private_key_password = 'testing-password'
cert_type = 'array'
create_body = CertificatePost(certificate=cert_text, private_key=private_key, passphrase=private_key_password, certificate_type=cert_type)
res = client.post_certificates(names=[cert_name], certificate=create_body)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

get_certificates_uses

# list the uses of all certificates
res = client.get_certificates_uses()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list the uses of certificates named "ad-cert-1" and "posix-cert"
res = client.get_certificates_uses(names=['ad-cert-1', 'posix-cert'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: continuation_token, filter, ids, limit, offset, sort
# See section "Common Fields" for examples

Clients

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

get_arrays_clients_performance

# list client performance for all clients
res = client.get_arrays_clients_performance()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list client performance for one specific array client
res = client.get_arrays_clients_performance(names=['123.123.123.123:8080'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: filter, limit, sort, total_only
# See section "Common Fields" for examples

Directory Services

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

get_directory_services

# list Directory Services configuration
res = client.get_directory_services(names=["nfs"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: continuation_token, filter, ids, limit, offset, sort
# See section "Common Fields" for examples

patch_directory_services

from pypureclient.flashblade import DirectoryService

# update Directory Services smb configuration to specify a join OU in an LDAP server
name = 'smb'
URI = 'ldaps://ad1.mycompany.com'
BASE_DN = 'DC=mycompany,DC=com'
BIND_USER = 'CN=John,OU=Users,DC=mycompany,DC=com'
BIND_PW = 'johnldappassword'

SMB_JOIN_OU = 'OU=PureStorage,OU=StorageArrays,OU=ServiceMachines'
SMB_ATTRS = {'join_ou': SMB_JOIN_OU}

directory_service = DirectoryService(base_dn=BASE_DN, bind_password=BIND_PW, bind_user=BIND_USER, uris=[URI],
                                     enabled=True, smb=SMB_ATTRS)
res = client.patch_directory_services(names=[name], directory_service=directory_service)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# update Directory Services nfs configuration to use an NIS configuration
name = 'nfs'
MASTER_SERVER_HOSTNAME = 'nis.master.server.example.com'
BACKUP_SERVER_HOSTNAME = 'nis.backup.server.example.com'
BACKUP_SERVER_IP = '188.123.4.43'
nis_servers = [MASTER_SERVER_HOSTNAME, BACKUP_SERVER_IP, BACKUP_SERVER_HOSTNAME]

NIS_DOMAIN = 'my-nis-domain'
NFS_ATTRS = {'nis_domains': [NIS_DOMAIN], 'nis_servers': nis_servers}

# the only fields needed in order to enable the nfs directory service when configuring
# NIS are an NIS domain and NIS servers
directory_service = DirectoryService(enabled=True, nfs=NFS_ATTRS)
res = client.patch_directory_services(names=[name],
                                      directory_service=directory_service)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# update the management directory service to use an Oracle Unified Directory server,
# specifying our user object class as "inetOrgPerson" and our login attribute as
# "givenName"
name = 'management'
OUD_URI = 'ldap://my-oud-leader.example.com'
OUD_BASE_DN = 'DC=example,DC=com'
OUD_BIND_USER = 'CN=ServiceAcct,OU=Users,DC=example,DC=com'
OUD_BIND_PW = 'something-absurdly-complex'

USER_LOGIN_ATTR = 'givenName'
USER_OBJ_CLASS = 'inetOrgPerson'
MGMT_ATTRS = {'user_login_attribute': USER_LOGIN_ATTR,
              'user_object_class': USER_OBJ_CLASS}
directory_service = DirectoryService(base_dn=OUD_BASE_DN, bind_password=OUD_BIND_PW,
                                     bind_user=OUD_BIND_USER, uris=[OUD_URI],
                                     enabled=True, management=MGMT_ATTRS)
res = client.patch_directory_services(names=[name],
                                      directory_service=directory_service)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: ids
# See section "Common Fields" for examples

delete_directory_services_roles

# delete Directory Services role configuration
client.delete_directory_services_roles(names=['some-role-name'])

# Other valid fields: ids
# See section "Common Fields" for examples

get_directory_services_roles

# list Directory Services Roles configuration
res = client.get_directory_services_roles()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list settings configuration for a specific role
ROLE_NAME = 'array_admin'
res = client.get_directory_services_roles(role_names=[ROLE_NAME])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: continuation_token, ids, filter, limit, offset, role_ids, sort, names
# See section "Common Fields" for examples

patch_directory_services_roles

from pypureclient.flashblade.FB_2_14 import DirectoryServiceRole, ReferenceWritable

# update Directory Services role configuration
ARRAY_ADMIN_GRP = 'admins'
GROUP_BASE = 'ou=purestorage,ou=us'
CONFIG_NAME = 'example-role-mapping'

NEW_ROLE_NAME = 'array_admin'
role_reference = ReferenceWritable(name=NEW_ROLE_NAME)

directory_service_role = DirectoryServiceRole(group_base=GROUP_BASE, group=ARRAY_ADMIN_GRP, role=role_reference)
res = client.patch_directory_services_roles(names=[CONFIG_NAME],
                                            directory_service_roles=directory_service_role)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: role_ids, ids, role_names
# See section "Common Fields" for examples

post_directory_services_roles

from pypureclient.flashblade.FB_2_14 import DirectoryServiceRole

# create Directory Services role configuration
ARRAY_ADMIN_GRP = 'admins'
GROUP_BASE = 'ou=purestorage,ou=us'
ROLE_NAME = 'array_admin'

directory_service_role = DirectoryServiceRole(role={"name": ROLE_NAME}, group_base=GROUP_BASE, group=ARRAY_ADMIN_GRP)
res = client.post_directory_services_roles(names=['some-role-name'],
                                           directory_service_roles=directory_service_role)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

get_directory_services_test

# test the nfs directory service configuration that exists already
res = client.get_directory_services_test(names=['nfs'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: filter, ids, limit, sort
# See section "Common Fields" for examples

patch_directory_services_test

from pypureclient.flashblade import DirectoryService, Reference

# test the existing nfs directory service configuration, but using a different certificate
# and bind user
test_bind_user = 'CN=differentUser,CN=Users,DC=example,DC=com'
test_certificate_name = 'nfs-server-certificate'
cert_reference = Reference(name=test_certificate_name)
test_ds_config = DirectoryService(bind_user=test_bind_user, ca_certificate=cert_reference)
res = client.patch_directory_services_test(names=['nfs'],
                                           directory_service=test_ds_config)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: ids, filter, sort
# See section "Common Fields" for examples

DNS

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

delete_dns

# delete the dns configuration object dns_to_delete on the array
client.delete_dns(names=["dns_to_delete"])

# Other valid fields: ids, references
# See section "Common Fields" for examples

get_dns

# list DNS configuration
res = client.get_dns()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Valid fields: continuation_token, filter, ids, limit, names, offset, sort
# See section "Common Fields" for examples

patch_dns

from pypureclient.flashblade import Dns

# update domain
res = client.patch_dns(dns=Dns(domain='new_domain'))
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# update nameservers
res = client.patch_dns(dns=Dns(nameservers=['126.24.5.1', '126.24.5.2']))
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# empty nameservers
res = client.patch_dns(dns=Dns(nameservers=[]))
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: names, ids
# See section "Common Fields" for examples

post_dns

from pypureclient.flashblade import DnsPost, Reference

# post the dns configuration object mydns on the array
attr = DnsPost(domain="example-domain.com", nameservers=['126.24.5.1', '126.24.5.2'])
res = client.post_dns(names=["mydns"], dns=attr)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: references
# See section "Common Fields" for examples

Drives

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

get_drives

# list all drives
res = client.get_drives()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list a subset of drives by name
res = client.get_drives(names=['CH1.FB1.BAY3', 'CH1.FB2.BAY1'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list a subset of drives by id
res = client.get_drives(ids=['f9330b89-fb7c-cc8a-07b7-bfb086873982',
                             'a1f9faf6-18b5-7c9d-d816-6df3d2db6dca'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list all healthy drives
res = client.get_drives(filter='status=\'healthy\'')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: continuation_token, limit, offset, sort, total_only
# See section "Common Fields" for examples

File System Exports

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

delete_file_system_exports

# delete export by name
res = client.delete_file_system_exports(names=['_array_server::SMB::fs1'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# delete exports by ids
res = client.delete_file_system_exports(ids=['10314f42-020d-7080-8013-000ddt400013'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: context_names
# See section "Common Fields" for examples

get_file_system_exports

# get all file system exports
res = client.get_file_system_exports()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# get exports by name
res = client.get_file_system_exports(names=['_array_server::SMB::fs1',
                                            '_array_server::NFS::fs1'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# get exports by ids
res = client.get_file_system_exports(ids=['10314f42-020d-7080-8013-000ddt400013',
                                          '10314f42-020d-7080-8013-000ddt400014'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: allow_errors, context_names, filter, limit, offset, sort, continuation_token
# See section "Common Fields" for examples

patch_file_system_exports

from pypureclient.flashblade.FB_2_17 import FileSystemExport, Reference

# update an existing smb export
my_updated_smb_export = FileSystemExport(export_name="new_smb_export_name",
                                         policy=Reference(name="new_smb_client_pol"),
                                         share_policy=Reference(name="new_smb_share_pol"))
res = client.patch_file_system_exports(names=["_array_server::SMB::old_smb_export_name"],
                                       file_system_export=my_updated_smb_export)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# update an existing nfs export
my_updated_nfs_export = FileSystemExport(export_name="new_nfs_export_name",
                                         policy=Reference(name="new_nfs_export_pol"))
res = client.patch_file_system_exports(ids=["cb096ae0-a2c3-acd3-8375-13a7bbd397c2"],
                                       file_system_export=my_updated_nfs_export)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: context_names
# See section "Common Fields" for examples

post_file_system_exports

from pypureclient.flashblade import FileSystemExportPost, Reference

# example 1
# create smb and nfs exports for an existing file system 'my_fs' on the server 'my_server'
my_exports = FileSystemExportPost(export_name="my_export",
                                  server=Reference(name="my_server"),
                                  share_policy=Reference(name="smb_share_policy_1"))
res = client.post_file_system_exports(member_names=["my_fs"],
                                      policy_names=["nfs_export_policy_1", "smb_client_policy_1"],
                                      file_system_export=my_exports)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# example 2
# create only nfs export for an existing file system 'my_fs' on the server 'my_server'
my_nfs_export = FileSystemExportPost(export_name="my_nfs_export",
                                     server=Reference(name="my_server"))
res = client.post_file_system_exports(member_names=["my_fs"],
                                      policy_names=["nfs_export_policy_1"],
                                      file_system_export=my_nfs_export)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# example 3
# create only smb export for an existing file system 'my_fs' on the server 'my_server'
my_smb_export = FileSystemExportPost(export_name="my_export",
                                     server=Reference(name="my_server"),
                                     share_policy=Reference(name="smb_share_policy_1"))
res = client.post_file_system_exports(member_ids=["bfba6e16-963b-d0b4-f597-9f98916f370c"],
                                      policy_ids=["cb096ae0-a2c3-acd3-8375-13a7bbd397c2"],
                                      file_system_export=my_smb_export)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: context_names
# See section "Common Fields" for examples

File System Snapshots

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

delete_file_system_snapshots

# eradicate a destroyed file system snapshot named myfs.mysnap
client.delete_file_system_snapshots(names=["myfs.mysnap"])

# Other valid fields: context_names, ids
# See section "Common Fields" for examples

get_file_system_snapshots

# list all file system snapshots
res = client.get_file_system_snapshots()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list all destroyed file system snapshots
res = client.get_file_system_snapshots(destroyed=True)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list all file system snapshots with owning filesystem 'myfs'
res = client.get_file_system_snapshots(names_or_owner_names='myfs')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list with page size 5, and sort by source file system name
res = client.get_file_system_snapshots(limit=5, sort="source.name")
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list all remaining file system snapshots
res = client.get_file_system_snapshots(continuation_token=res.continuation_token)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list with filter
res = client.get_file_system_snapshots(filter='source.name=\'myfs*\' and contains(suffix, \'1\')')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: allow_errors, context_names, ids, offset, owner_ids, total_only
# See section "Common Fields" for examples

patch_file_system_snapshots

from pypureclient.flashblade import FileSystemSnapshot

# Destroy an existing snapshot
new_attr = FileSystemSnapshot(destroyed=True)

# Update the file system snapshot myfs.mysnap with our new attributes, in this case destroying it
res = client.patch_file_system_snapshots(names=["myfs.mysnap"], file_system_snapshot=new_attr)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# destroying the latest replicated snapshot should specify "latest_replica=True"
res = client.patch_file_system_snapshots(names=["myfs.mysnap"],
                                         latest_replica=True,
                                         file_system_snapshot=new_attr)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: context_names, ids
# See section "Common Fields" for examples

delete_file_system_snapshots_policies

# remove policy with id from a file system snapshot named myfs.2
client.delete_file_system_snapshots_policies(policy_ids=["10314f42-020d-7080-8013-000ddt400090"],
                                             member_names=["myfs.2"])

# Other valid fields: context_names, policy_names, member_ids
# See section "Common Fields" for examples

get_file_system_snapshots_policies

# list all policies
res = client.get_file_system_snapshots_policies()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# assume we have a policy named "p1", and a file system snapshot named "myfs.1"
res = client.get_file_system_snapshots_policies(policy_names=["p1"],
                                                member_names=["myfs.1"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list and sort by name in descendant order
res = client.get_file_system_snapshots_policies(limit=5, sort="policy.name-")
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: allow_errors, context_names, continuation_token, filter, member_ids, policy_ids, offset
# See section "Common Fields" for examples

post_file_system_snapshots

from pypureclient.flashblade import FileSystemSnapshotPost

# create a snapshot for the file system named myfs
res = client.post_file_system_snapshots(source_names=["myfs"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# create a snapshot with suffix mysnap for the file system named myfs
res = client.post_file_system_snapshots(source_names=["myfs"],
                                        file_system_snapshot=FileSystemSnapshotPost("mysnap"))
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# create a snapshot with suffix mysnap for the file system named myfs
res = client.post_file_system_snapshots(source_names=["myfs"],
                                        send=True,
                                        targets=["myremote"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: context_names, source_ids
# See section "Common Fields" for examples

delete_file_system_snapshots_transfer

# eradicate a destroyed file system snapshot named myfs.mysnap
client.delete_file_system_snapshots_transfer(names=["myfs.mysnap"],
                                             remote_names=["myremote"])

# Other valid fields: context_names, ids, remote_ids
# See section "Common Fields" for examples

get_file_system_snapshots_transfer

# list all file systems
res = client.get_file_system_snapshots_transfer()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list snapshot transfers for snapshots with name myfs.mysnap
res = client.get_file_system_snapshots_transfer(names_or_owner_names=["myfs.mysnap"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: allow_errors, context_names, continuation_token, filter, ids, limit, offset, sort, total_only
# See section "Common Fields" for examples

File Systems

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

delete_file_systems_audit_policies

# detach an audit policy from a file system
# assume we have a policy named "p1", and a file system named "myfs"
client.delete_file_systems_audit_policies(policy_names=["p1"], member_names=["myfs"])

# Other valid fields: context_names, policy_ids, member_ids
# See section "Common Fields" for examples

get_file_systems_audit_policies

# list all policies
res = client.get_file_systems_audit_policies()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# assume we have a policy named "p1", and a file system named "myfs"
res = client.get_file_systems_audit_policies(policy_names=["p1"],
                                       member_names=["myfs"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list and sort by name in descendant order
res = client.get_file_systems_audit_policies(limit=5, sort="policy.name-")
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list with page size 5
res = client.get_file_systems_audit_policies(limit=5)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list all remaining policies
res = client.get_file_systems_audit_policies(continuation_token=res.continuation_token)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: allow_errors, context_names, filter, member_ids, offset, policy_ids
# See section "Common Fields" for examples

post_file_systems_audit_policies

# attach an audit policy to a file system
# assume we have a policy named "audit_policy_1", and a file system with id
# "100abf42-0000-4000-8023-000det400090"
res = client.post_file_systems_audit_policies(policy_names=["audit_policy_1"],
                                        member_ids=["100abf42-0000-4000-8023-000det400090"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: context_names, policy_ids, member_names
# See section "Common Fields" for examples

delete_file_systems

# eradicate a destroyed file system with name myfs
client.delete_file_systems(names=["myfs"])

# Other valid fields: context_names, ids
# See section "Common Fields" for examples

get_file_systems

# list all file systems
res = client.get_file_systems()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list all destroyed file systems
res = client.get_file_systems(destroyed=True)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list first five filesystems using default sort
res = client.get_file_systems(limit=5)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list first five filesystems and sort by provisioned in descendant order
res = client.get_file_systems(limit=5, sort="provisioned-")
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list all remaining file systems
res = client.get_file_systems(continuation_token=res.continuation_token)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list with filter to see only file systems with at least one type of nfs enabled
res = client.get_file_systems(filter='nfs.v3_enabled or nfs.v4_1_enabled')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: allow_errors, context_names, ids, names, offset, sort, total_only
# See section "Common Fields" for examples

get_file_systems_groups_performance

# list performance for all groups
res = client.get_file_systems_groups_performance(file_system_names=["fs1"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list performance for one group
res = client.get_file_systems_groups_performance(file_system_names=["fs1"],
                                                 gids=[100])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list performance for one group by filesystem id
res = client.get_file_systems_groups_performance(file_system_ids=["10314f42-020d-7080-8013-000ddt400090"],
                                                 group_names=["group1"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list performance by name
res = client.get_file_systems_groups_performance(names=["fs1/100"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: filter, limit, sort, total_only
# See section "Common Fields" for examples

get_file_systems_locks_clients

# Get all the clients (limit the result to 1000) who have acquired file locks
res = client.get_file_systems_locks_clients(limit=1000)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: filter, continuation_token
# See section "Common Fields" for examples

delete_file_systems_locks

# Delete all locks created by a specified client IP
res = client.delete_file_systems_locks(client_names='1.1.1.1')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Delete a single lock by name
res = client.delete_file_systems_locks(names='3-NFSv3-0-1024')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Delete all locks for a specific file
res = client.delete_file_systems_locks(file_system_names='root', paths='/dir/file')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Delete all locks for files (recursively) within a specified folder
res = client.delete_file_systems_locks(file_system_names='root', paths='/dir',
                                       recursive=True)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: file_system_ids, inodes, references
# See section "Common Fields" for examples

get_file_systems_locks

# Get all file locks and limit the number of returned entries to 1000
res = client.get_file_systems_locks(limit=1000)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Get a single lock information by lock name
res = client.get_file_systems_locks(names="3-NFSv3-0-1024")
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Get all locks created by a client with specified client IP
res = client.get_file_systems_locks(client_names='1.1.1.1')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Get locks for a specific file
res = client.get_file_systems_locks(file_system_names='root', paths='/dir/file')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))


# Other valid fields: file_system_ids, filter, inodes, continuation_token
# See section "Common Fields" for examples

post_file_systems_locks_nlm_reclamations

# Initiates the NLM reclamation
res = client.post_file_systems_locks_nlm_reclamations()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

delete_file_systems_open_files

# Close open files with specified IDs
res = client.delete_file_systems_open_files(ids=['54043195528445954', '54043195528445955'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

get_file_systems_open_files

# List all SMB open files, limit response to 10
res = client.get_file_systems_open_files(protocols=['smb'], limit=10)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Get single SMB open file by open file ID
res = client.get_file_systems_open_files(protocols=['smb'], ids=['54043195528445954'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Get all SMB files opened by clients with specified client IPs
res = client.get_file_systems_open_files(protocols=['smb'], client_names=['1.1.1.1', '2.2.2.2'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Get all SMB files opened by clients with specified users
res = client.get_file_systems_open_files(protocols=['smb'], user_names=['0:0', '1:1'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Get all SMB open file records for a specific file
res = client.get_file_systems_open_files(protocols=['smb'], file_system_names=['root'], paths=['/dir/file'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Get all SMB files opened in session with specified session names
res = client.get_file_systems_open_files(protocols=['smb'], session_names=['456135-smb', '456136-smb'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: continuation_token, file_system_ids
# See section "Common Fields" for examples

# session_names = None,  # type: List[str]

patch_file_systems

from pypureclient.flashblade.FB_2_17 import FileSystemPatch, NfsPatch, Http, Reference, Smb, MultiProtocol, StorageClassInfo

# update a file system object with a new provisioned size. enable hard limits.
# enable NFSv4.1, and disable NFSv3. enable SMB. disable HTTP
# adjust the default user quota to a new value
# change access control style to independent, disable safeguard acls
# set the nfs export policy to "export_policy_1"
# set the smb share policy to "share_policy_1"
# set the qos policy to "qos_policy_1"
# set the smb continuous availability_enabled to True
# set the group ownership to "parent-directory"
# set the storage class to "S500X-A"
# note that name field should be None
new_attr = FileSystemPatch(provisioned=1024, hard_limit_enabled=True,
                           nfs=NfsPatch(v3_enabled=False,
                                        v4_1_enabled=True,
                                        add_rules="1.1.1.1(rw,no_root_squash)",
                                        export_policy=Reference(name="export_policy_1")),
                           http=Http(enabled=False),
                           smb=Smb(enabled=True,
                                   share_policy=Reference(name="share_policy_1"),
                                   continuous_availability_enabled=True),
                           qos_policy=Reference(name="qos_policy_1"),
                           default_user_quota=4096,
                           multi_protocol=MultiProtocol(safeguard_acls=False,
                                                        access_control_style="independent"),
                           group_ownership="parent-directory",
                           storage_class=StorageClassInfo(name="S500X-A"))
# update the file system named myfs on the array
res = client.patch_file_systems(names=["myfs"], ignore_usage=True, file_system=new_attr,
                                discard_detailed_permissions=True,
                                cancel_in_progress_storage_class_transition=True)

print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# update the filesystem object to use an export_policy instead of export rules.
new_attr = FileSystemPatch(nfs=NfsPatch(export_policy=Reference(name="export_policy_1")))
res = client.patch_file_systems(names=["myfs"], file_system=new_attr)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# destroy a file system even if it has a replica link
destroy_attr = FileSystemPatch(destroyed=True,
                               nfs=NfsPatch(v4_1_enabled=False),
                               smb=Smb(enabled=False),
                               multi_protocol=MultiProtocol(access_control_style="mode-bits"))
res = client.patch_file_systems(names=["myfs"], delete_link_on_eradication=True,
                                file_system=destroy_attr)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# update the file system with id '10314f42-020d-7080-8013-000ddt400090' on the array
res = client.patch_file_systems(ids=['10314f42-020d-7080-8013-000ddt400090'],
                                ignore_usage=True, file_system=new_attr,
                                discard_non_snapshotted_data=False)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# rename a file system
new_attr = FileSystemPatch(name="new_name")
res = client.patch_file_systems(names=["old_name"], file_system=new_attr)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# clear the attached QoS policy
new_attr = FileSystemPatch(qos_policy=Reference(name=""))
res = client.patch_file_systems(names=["myfs"], file_system=new_attr)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: context_names
# See section "Common Fields" for examples

get_file_systems_performance

# list instantaneous nfs performance for all file systems
res = client.get_file_systems_performance(protocol='nfs')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list instantaneous native smb performance for file systems 'fs1' and 'fs2'
res = client.get_file_systems_performance(names=['fs1', 'fs2'], protocol='smb')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list instantaneous nfs performance for file system with id '10314f42-020d-7080-8013-000ddt400090'
res = client.get_file_systems_performance(ids=['10314f42-020d-7080-8013-000ddt400090'],
                                          protocol='nfs')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list historical file systems nfs performance for all file systems between some
# start time and end time
res = client.get_file_systems_performance(
    start_time=START_TIME,
    end_time=END_TIME,
    protocol='nfs',
    resolution=30000)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list historical file systems nfs performance for file systems 'fs1' and 'fs2' between some
# start time and end time
res = client.get_file_systems_performance(
    start_time=START_TIME,
    end_time=END_TIME,
    resolution=30000,
    protocol='nfs',
    names=['fs1', 'fs2'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# total instantaneous performance across 2 filesystems
res = client.get_file_systems_performance(names=['fs1', 'fs2'], protocol='nfs',
                                          total_only=True)
print(res)

# Other valid fields: continuation_token, filter, ids, limit, offset, sort
# See section "Common Fields" for examples

get_file_systems_policies_all

# list all policies attached to the filesystem regardless of type.
res = client.get_file_systems_policies_all()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# assume we have a snapshot or nfs policy named "p1", and a file system named "myfs"
res = client.get_file_systems_policies_all(policy_names=["p1"],
                                           member_names=["myfs"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list all policies attached to file system named "myfs"
res = client.get_file_systems_policies_all(member_names=["myfs"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: allow_errors, context_names, continuation_token, filter, limit, member_ids, offset, sort, policy_ids
# See section "Common Fields" for examples

delete_file_systems_policies

# attach policy to a file system
# assume we have a policy named "p1", and a file system named "myfs"
client.delete_file_systems_policies(policy_names=["p1"],
                                    member_names=["myfs"])

# Other valid fields: context_names, policy_ids, member_ids
# See section "Common Fields" for examples

get_file_systems_policies

# list all policies
res = client.get_file_systems_policies()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# assume we have a policy named "p1", and a file system named "myfs"
res = client.get_file_systems_policies(policy_names=["p1"],
                                       member_names=["myfs"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list and sort by name in descendant order
res = client.get_file_systems_policies(limit=5, sort="policy.name-")
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list with page size 5
res = client.get_file_systems_policies(limit=5)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list all remaining policies
res = client.get_file_systems_policies(continuation_token=res.continuation_token)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: allow_errors, context_names, filter, member_ids, offset, policy_ids
# See section "Common Fields" for examples

post_file_systems_policies

# attach policy to a file system
# assume we have a policy named "p1", and a file system with id
# "100abf42-0000-4000-8023-000det400090"
res = client.post_file_systems_policies(policy_names=["p1"],
                                        member_ids=["100abf42-0000-4000-8023-000det400090"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: context_names, policy_ids, member_names
# See section "Common Fields" for examples

post_file_systems

from pypureclient.flashblade import FileSystemPost, Nfs, Smb, Reference, MultiProtocolPost, FileSystemEradicationConfig

# create a local file system object with given name, provisioned size, default quotas,
# NFSv4.1 enabled, nfs export policy "export_policy_1", smb enabled, smb share
# policy "share_policy_1", and qos policy "qos_policy_1"
default_user_space_quota = 1024000
default_group_space_quota = 1024000000
export_policy = Reference(name="export_policy_1")
share_policy = Reference(name="share_policy_1")
qos_policy_1 = Reference(name="qos_policy_1")
myfs = FileSystemPost(provisioned=5000, hard_limit_enabled=True,
                      nfs=Nfs(v4_1_enabled=True, export_policy=export_policy),
                      smb=Smb(enabled=True, share_policy=share_policy),
                      qos_policy=qos_policy_1,
                      default_user_quota=default_user_space_quota,
                      default_group_quota=default_group_space_quota,
                      multi_protocol=MultiProtocolPost(access_control_style="nfs"))
# post the file system object myfs on the array with the specific default user and group
# quotas
res = client.post_file_systems(names=["myfs"], file_system=myfs)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# copy snapshot 'myfs.mysnap' to file system 'myfs'
myfs = FileSystemPost(source=Reference(name='myfs.mysnap'))
# post the file system object myfs on the array
res = client.post_file_systems(names=["myfs"], overwrite=True,
                               discard_non_snapshotted_data=True, file_system=myfs)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# create WORM file system
era_conf = FileSystemEradicationConfig(eradication_mode='retention-based')
myfs = FileSystemPost(eradication_config=era_conf)
res = client.post_file_systems(names=["myfs"], policy_names=['worm-policy'], file_system=myfs)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

res = client.post_file_systems(names=["myfs"], policy_ids=['10314f42-020d-7080-8013-000ddt400014'], file_system=myfs)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# By default, both nfs and smb exports are created for the file system with the same name as the file system.
# To create a file system without exports, set the default_exports param to an empty string.
# To manually create exports after creating the file system, use `post_file_system_exports` API
myfs_without_exports = FileSystemPost()
res = client.post_file_systems(names=["myfs_without_exports"],
                               file_system=myfs_without_exports,
                               default_exports=[""])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: context_names
# See section "Common Fields" for examples

delete_file_systems_sessions

# Delete session by name
res = client.delete_file_systems_sessions(names='54043195528445954')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Delete all sessions of specified protocol
res = client.delete_file_systems_sessions(protocols='nfs', disruptive=True)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Delete all sessions created by specified user
res = client.delete_file_systems_sessions(user_names='0:0', disruptive=True)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Delete all sessions created by specified client IP
res = client.delete_file_systems_sessions(client_names='1.1.1.1', disruptive=True)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Delete all sessions of specified protocol created by specified client IP and user 
res = client.delete_file_systems_sessions(protocols='nfs',
                                          client_names='1.1.1.1',
                                          user_names='0:0')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

get_file_systems_sessions

# List all sessions, limit response to 10
res = client.get_file_systems_sessions(limit=10)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Get single session by name
res = client.get_file_systems_sessions(names='54043195528445954')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Get all sessions created by a client with specified client IP
res = client.get_file_systems_sessions(client_names='1.1.1.1')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Get all sessions with specified protocol
res = client.get_file_systems_sessions(protocols='nfs')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Get all sessions created by a client with specified user
res = client.get_file_systems_sessions(user_names='0:0')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: continuation_token
# See section "Common Fields" for examples

get_file_systems_users_performance

# list performance for all users
res = client.get_file_systems_users_performance(file_system_names=["fs1"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list performance for one user
res = client.get_file_systems_users_performance(file_system_names=["fs1"],
                                                uids=[100])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list performance for one user by filesystem id
res = client.get_file_systems_users_performance(file_system_ids=["10314f42-020d-7080-8013-000ddt400090"],
                                                user_names=["user1"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list performance by name
res = client.get_file_systems_users_performance(names=["fs1/100"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: filter, limit, sort, total_only
# See section "Common Fields" for examples

get_file_systems_worm_data_policies

# Get all WORM data policy members
res = client.get_file_systems_worm_data_policies()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list by policy name
res = client.get_file_systems_worm_data_policies(
    policy_names=['test-policy-name']
)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list by member name
res = client.get_file_systems_worm_data_policies(
    member_names=['member-name']
)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list by policy ids
res = client.get_file_systems_worm_data_policies(
    policy_ids=['10314f42-0120d-7080-8013-000ddt400013']
)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list by member ids
res = client.get_file_systems_worm_data_policies(
    member_ids=['10314f42-020d-7080-8013-000ddt400014']
)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: allow_errors, context_names, filter, limit, offset, sort, continuation_token
# See section "Common Fields" for examples

Fleets

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

delete_fleets

# delete fleet by name
res = client.delete_fleets(names=['my-fleet'])
print(res)

# delete fleet by id
res = client.delete_fleets(ids=['635c0a0c-37ad-4f91-bad7-5224c284c2ad'])
print(res)

get_fleets_fleet_key

res = client.get_fleets_fleet_key()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: continuation_token, filter, limit, offset, sort, total_only
# See section "Common Fields" for examples

post_fleets_fleet_key

res = client.post_fleets_fleet_key()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

get_fleets

res = client.get_fleets()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: continuation_token, filter, ids, limit, names, offset, sort, total_only
# See section "Common Fields" for examples

delete_fleets_members

# delete fleet member by name
res = client.delete_fleets_members(member_names=['my-fleet-member'])
print(res)

# delete fleet member by id
res = client.delete_fleets_members(member_ids=['635c0a0c-37ad-4f91-bad7-5224c284c2ad'])
print(res)

# delete fleet member by name unilaterally
res = client.delete_fleets_members(member_names=['my-fleet-member'], unreachable=True)

get_fleets_members

# list fleet members
res = client.get_fleets_members()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: fleets, members, continuation_token, filter, fleet_ids, fleet_names, limit, member_ids, member_names, offset, sort, total_only
# See section "Common Fields" for examples

post_fleets_members

from pypureclient.flashblade.FB_2_17 import FleetMemberPost, FleetMemberPostMembers, FleetMemberPostMembersMember

fleet_member_post_member=FleetMemberPostMembersMember(name='my-new-fleet-member')
fleet_key='$secret-fleet-key$'
fleet_member_post_members=FleetMemberPostMembers(member=fleet_member_post_member, key=fleet_key)
fleet_member_post=FleetMemberPost(members=[fleet_member_post_members])

# create fleet member based on fleet name
res = client.post_fleets_members(
    fleet_names=['my-fleet'],
    members=fleet_member_post)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# create fleet member based on fleet id
res = client.post_fleets_members(
    fleet_ids=['635c0a0c-37ad-4f91-bad7-5224c284c2ad'],
    members=fleet_member_post
    )
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

patch_fleets

from pypureclient.flashblade.FB_2_17 import FleetPatch

fleet_patch = FleetPatch(name='my-new-fleet-name')

# rename an existing fleet using fleet name
res = client.patch_fleets(
    names=['my-fleet'],
    fleet=fleet_patch)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# rename an existing fleet using fleet id
res = client.patch_fleets(
    ids=['635c0a0c-37ad-4f91-bad7-5224c284c2ad'],
    fleet=fleet_patch)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

post_fleets

res = client.post_fleets(names=["my-fleet"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

Hardware

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

get_hardware

# list all fans
res = client.get_hardware(filter='type=\'fan\'')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list all XFMs
res = client.get_hardware(filter='type=\'xfm\'')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list all Drives
res = client.get_hardware(filter='type=\'bay\'')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: continuation_token, limit, offset, sort, ids, names
# See section "Common Fields" for examples

patch_hardware

from pypureclient.flashblade import Hardware

# turn visual identifier on
res = client.patch_hardware(names=['CH1.FB1'], hardware=Hardware(identify_enabled=True))
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# turn visual identifier off
res = client.patch_hardware(names=['CH1.FB1'], hardware=Hardware(identify_enabled=False))
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: ids
# See section "Common Fields" for examples

Hardware Connectors

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

get_hardware_connectors

# list all hardware connectors
res = client.get_hardware_connectors()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list and sort by name in descendant order
res = client.get_hardware_connectors(limit=5, sort="name-")
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list with page size 5
res = client.get_hardware_connectors(limit=5)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list all remaining hardware connectors
res = client.get_hardware_connectors(continuation_token=res.continuation_token)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list with filter
res = client.get_hardware_connectors(filter='port_count=4')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: offset, ids, names
# See section "Common Fields" for examples

patch_hardware_connectors

from pypureclient.flashblade import HardwareConnector

# Set port count on CH1.FM1.ETH1 (can also set lane_speed)
res = client.patch_hardware_connectors(names=['CH1.FM1.ETH1'],
                                       hardware_connector=HardwareConnector(port_count=4))
# Other valid fields: ids
# See section "Common Fields" for examples

get_hardware_connectors_performance

# list instantaneous performance for all hardware connectors
res = client.get_hardware_connectors_performance()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list instantaneous hardware connectors performance for selected ethernet connectors
res = client.get_hardware_connectors_performance(names=['*ETH2*'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# List hardware connectors performance by id.
res = client.get_hardware_connectors_performance(ids=["10314f42-020d-7080-8013-000ddt400090"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list historical hardware connectors performance for all connectors between some
# start time and end time
res = client.get_hardware_connectors_performance(
    start_time=START_TIME,
    end_time=END_TIME,
    resolution=30000)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: filter, limit, offset, sort, total_only
# See section "Common Fields" for examples

Keytabs

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

delete_keytabs

# delete the keytab with the name 'oldkeytab.1'
client.delete_keytabs(names=['oldkeytab.1'])

# delete the keytab with id '10314f42-020d-7080-8013-000ddt400090'
client.delete_keytabs(ids=['10314f42-020d-7080-8013-000ddt400090'])

# delete all keytabs that were encrypted with older aes128 ciphers
res = client.get_keytabs(filter='contains(encryption_type, "aes256")')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    items = list(res.items)
    print(items)
    for keytab in items:
        name_to_delete = keytab.name
        client.delete_keytabs(names=[name_to_delete])

get_keytabs_download

# download keytab file and list the file name
res = client.get_keytabs_download()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# export all keytabs on the system with a certain encryption type, and write their binary
# to a file
desired_encryption_type = 'aes256-cts-hmac-sha1-96'
filter_str = 'encryption_type="{}"'.format(desired_encryption_type)
res = client.get_keytabs(filter=filter_str)
# get the names from our results
names_to_export = []
for keytab_entry_obj in list(res.items):
    names_to_export.append(keytab_entry_obj.name)
# download file composed of the keytabs we gathered, encoded in binary
res = client.get_keytabs_download(keytab_names=names_to_export)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: keytab_ids
# See section "Common Fields" for examples

get_keytabs

# list all keytabs on the system
res = client.get_keytabs()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list first five keytabs using default sort. only looking for ones beginning with 'kt1.'
res = client.get_keytabs(limit=5, names=["kt1.*"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list first five keytabs, sorting by the key version number used to generate them
res = client.get_keytabs(limit=5, sort="kvno")
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list all keytabs, filtering only for keytabs with aes256 in their encryption type
res = client.get_keytabs(filter='contains(encryption_type, "aes256")')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: continuation_token, ids, offset
# See section "Common Fields" for examples

post_keytabs

from pypureclient.flashblade import KeytabPost, Reference

# Rotate keytabs for active directory account
account = Reference(name="test-config", resource_type="active-directory")
keytab = KeytabPost(source=account)
res = client.post_keytabs(keytab=keytab)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: name_prefixes
# See section "Common Fields" for examples

post_keytabs_upload

# read the binary data from your keytab file
with open('/etc/krb5.keytab', 'rb') as binary_keytab_file:
    my_binary_keytab_data = binary_keytab_file.read()
# upload the binary data. we use a tuple of (filename, file contents) as the keytab file to
# upload in order to be generically compatible across different python versions
res = client.post_keytabs_upload(name_prefixes='binary-uploaded-krb5',
                                 keytab_file=('krb5.keytab', my_binary_keytab_data))
# our result is the contents of the file we just uploaded
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# we can also upload a base64 encoded keytab file, in case we were sent a keytab
# through some medium where binary wasn't feasible (e.g. copied into a bash terminal,
# sent as text over an internal corporate messaging system)
with open('/etc/krb5.txt', 'r') as base64_keytab_file:
    my_base64_keytab_data = base64_keytab_file.read()

res = client.post_keytabs_upload(name_prefixes='base64-uploaded-krb5',
                                 keytab_file=('krb5.txt', my_base64_keytab_data))
# our result is the contents of the file we just uploaded
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

Kmip

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

delete_kmip

# Delete the KMIP server with the name 'kmip-server-1'
client.delete_kmip(names=['kmip-server-1'])

# Delete the KMIP server with id '10314f42-020d-7080-8013-000ddt400090'
client.delete_kmip(ids=['10314f42-020d-7080-8013-000ddt400090'])

get_kmip

# List the KMIP server configurations
res = client.get_kmip()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: names, ids, continuation_token, filter, limit, offset, sort
# See section "Common Fields" for examples

patch_kmip

from pypureclient.flashblade import KmipServer

# Update a KMIP server configuration with a new set of URIs

kmip_server_name = 'kmip-server-1'
kmip_uris = ['kmip1.example.com:5696', 'kmip2.example.com:5696']
create_body = KmipServer(uris=kmip_uris)

res = client.patch_kmip(names=[kmip_server_name], kmip_server=create_body)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: ids
# See section "Common Fields" for examples

post_kmip

from pypureclient.flashblade import KmipServer, Reference

# Create a new KMIP server named "kmip-server-1"

kmip_server_name = 'kmip-server-1'
kmip_uris = ['kmip.example.com:5696']
certificate = Reference(name='external', resource_type='certificates')

create_body = KmipServer(uris=kmip_uris, ca_certificate=certificate)
res = client.post_kmip(names=[kmip_server_name], kmip_server=create_body)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

get_kmip_test

# Test the KMIP server configuration named "my_kmip_server"
res = client.get_kmip_test(names=["my_kmip_server"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: ids

Lifecycle Rules

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

delete_lifecycle_rules

# Delete the lifecycle rule named 'myrule' from bucket 'mybucket'
client.delete_lifecycle_rules(names=['mybucket/myrule'])

# Delete the lifecycle rule with id '10314f42-020d-7080-8013-000ddt400090'
client.delete_lifecycle_rules(ids=['10314f42-020d-7080-8013-000ddt400090'])

# Delete all the lifecycle rules from bucket 'mybucket'
client.delete_lifecycle_rules(bucket_names=['mybucket'])

# Delete all the lifecycle rules from bucket with id '100abf42-0000-4000-8023-000det400090'
client.delete_lifecycle_rules(bucket_ids=['100abf42-0000-4000-8023-000det400090'])

# Other valid fields: context_names
# See section "Common Fields" for examples

get_lifecycle_rules

# List all lifecycle rules
res = client.get_lifecycle_rules()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# List first two lifecycle rules in bucket 'mybucket'. Use default sorting.
res = client.get_lifecycle_rules(limit=2, bucket_names=['mybucket'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# List all lifecycle rules in bucket with id '100abf42-0000-4000-8023-000det400090'
res = client.get_lifecycle_rules(limit=2, bucket_ids=['100abf42-0000-4000-8023-000det400090'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# List the first lifecycle rule when sorting by prefix.
res = client.get_lifecycle_rules(limit=1, sort='prefix')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: allow_errors, context_names, continuation_token, filter, ids, limit, names, offset, sort
# See section "Common Fields" for examples

patch_lifecycle_rules

from pypureclient.flashblade import LifecycleRule

# modify the lifecycle rule 'myrule' for the bucket 'mybucket', changing the 'keep_previous_version_for'.
attr = LifecycleRule(enabled=True,
                     keep_previous_version_for=7*24*60*60*1000,
                     prefix='mynewprefix')
res = client.patch_lifecycle_rules(names=['mybucket/myrule'], lifecycle=attr)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# modify the lifecycle rule 'myrule' again for the bucket 'mybucket' again, adding 'keep_current_version_for'.
attr = LifecycleRule(enabled=True,
                     keep_current_version_for=7*24*60*60*1000,
                     prefix='mynewprefix')
res = client.patch_lifecycle_rules(bucket_names=['mybucket'], names=['myrule'], lifecycle=attr)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# modify the lifecycle rule 'myrule' again for the bucket 'mybucket' again, deleting 'keep_current_version_for' and
# adding 'keep_current_version_until' and 'abort_incomplete_multipart_uploads_after'
attr = LifecycleRule(enabled=True,
                     keep_current_version_for=0,
                     keep_current_version_until=1639267200000,  # 2021-12-12
                     abort_incomplete_multipart_uploads_after=172800000,  # 2 day
                     prefix='mynewprefix')
res = client.patch_lifecycle_rules(bucket_ids=['10314f42-020d-7080-8013-000ddt400091'],
                                   ids=["10314f42-020d-7080-8013-000ddt400090"], lifecycle=attr, confirm_date=True)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: context_names
# See section "Common Fields" for examples

post_lifecycle_rules

from pypureclient.flashblade import LifecycleRulePost, Reference

# create a lifecycle rule 'myrule' for the bucket 'mybucket' with 'keep_previous_version_for'
attr = LifecycleRulePost(bucket=Reference(name='mybucket'),
                         rule_id='myrule',
                         keep_previous_version_for=2*24*60*60*1000,
                         prefix='myprefix')
res = client.post_lifecycle_rules(rule=attr)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# create a lifecycle rule 'myrule1' for the bucket 'mybucket' with 'keep_current_version_for'
attr = LifecycleRulePost(bucket=Reference(name='mybucket'),
                         rule_id='myrule1',
                         keep_current_version_for=2*24*60*60*1000,
                         prefix='myprefix')
res = client.post_lifecycle_rules(rule=attr)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# create a lifecycle rule 'myrule2' for the bucket 'mybucket' with
# 'keep_current_version_until' and 'abort_incomplete_multipart_uploads_after'
attr = LifecycleRulePost(bucket=Reference(name='mybucket'),
                         rule_id='myrule2',
                         keep_current_version_until=1639267200000,  # 2021-12-12
                         abort_incomplete_multipart_uploads_after=172800000,  # 2 day
                         prefix='myprefix')
res = client.post_lifecycle_rules(rule=attr, confirm_date=True)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: context_names
# See ids in section "Common Fields" for examples

Logs

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

get_logs_async_download

res = client.get_logs_async_download(names=['array-name_logs_2022-01-02.03_1643259782296.zip'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

get_logs_async

res = client.get_logs_async()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: continuation_token, filter, ids, limit, names, offset, sort
# See section "Common Fields" for examples

patch_logs_async

from pypureclient.flashblade import LogsAsync, Reference

logs_async_attr = LogsAsync(start_time=1643664575040, end_time=1643668175040, hardware_components=[Reference(name='CH1')])
res = client.patch_logs_async(logs_async=logs_async_attr)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

get_logs

res = client.get_logs(start_time=1527415200000, end_time=1527415200000)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

Maintenance Windows

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

delete_maintenance_windows

# Delete maintenance windows
res = client.delete_maintenance_windows(names=['array'])

# Other valid fields: ids
# See section "Common Fields" for examples

get_maintenance_windows

# List Maintenance Windows
res = client.get_maintenance_windows()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: continuation_token, filter, ids, limit, names, offset, sort, references
# See section "Common Fields" for examples

post_maintenance_windows

from pypureclient.flashblade import MaintenanceWindowPost

# post the maintenance window on the array
duration = 60 * 60 * 1000  # 1 hour in milliseconds
body = MaintenanceWindowPost(timeout=duration)
res = client.post_maintenance_windows(names=["array"], maintenance_window=body)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

Network Interfaces

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

get_network_interfaces_connectors

# list all network connectors
res = client.get_network_interfaces_connectors()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list and sort by name in descendant order
res = client.get_network_interfaces_connectors(limit=5, sort="name-")
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list with page size 5
res = client.get_network_interfaces_connectors(limit=5)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list all remaining network connectors
res = client.get_network_interfaces_connectors(continuation_token=res.continuation_token)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list with filter
res = client.get_network_interfaces_connectors(filter='port_count=4')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: offset, ids, names
# See section "Common Fields" for examples

patch_network_interfaces_connectors

from pypureclient.flashblade import HardwareConnector

# Set port count on CH1.FM1.ETH1 (can also set lane_speed)
res = client.patch_network_interfaces_connectors(names=['CH1.FM1.ETH1'],
                                       network_connector=HardwareConnector(port_count=4))
# Other valid fields: ids
# See section "Common Fields" for examples

get_network_interfaces_connectors_performance

# list instantaneous performance for all network connectors
res = client.get_network_interfaces_connectors_performance()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list instantaneous network connectors performance for selected ethernet connectors
res = client.get_network_interfaces_connectors_performance(names=['*ETH2*'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# List network connectors performance by id.
res = client.get_network_interfaces_connectors_performance(ids=["10314f42-020d-7080-8013-000ddt400090"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list historical network connectors performance for all connectors between some
# start time and end time
res = client.get_network_interfaces_connectors_performance(
    start_time=START_TIME,
    end_time=END_TIME,
    resolution=30000)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: filter, limit, offset, sort, total_only
# See section "Common Fields" for examples

get_network_interfaces_connectors_settings

# list all global network settings for network connectors
res = client.get_network_interfaces_connectors_settings()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list and sort by name in descendant order
res = client.get_network_interfaces_connectors_settings(limit=5, sort="name-")
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list with page size 5
res = client.get_network_interfaces_connectors_settings(limit=5)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: offset, ids, names, continuation_token, filter
# See section "Common Fields" for examples

delete_network_interfaces

# delete a network interface with name myvip
client.delete_network_interfaces(names=["myvip"])

# Other valid fields: ids
# See section "Common Fields" for examples

get_network_interfaces

# list all network interfaces
res = client.get_network_interfaces()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list and sort by name in descendant order
res = client.get_network_interfaces(limit=5, sort="name-")
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list with page size 5
res = client.get_network_interfaces(limit=5)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list all remaining network interfaces
res = client.get_network_interfaces(continuation_token=res.continuation_token)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list with filter
res = client.get_network_interfaces(filter='(services=\'replication\')')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: ids, names, offset
# See section "Common Fields" for examples

patch_network_interfaces

from pypureclient.flashblade.FB_2_16 import NetworkInterface

# Update the existing network interface "myvip"
# Change the address to "1.2.3.201"
# Change the service type to "replication"
res = client.patch_network_interfaces(
    names=['myvip'], network_interface=NetworkInterface(address='1.2.3.201', services=['replication']))
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Update the existing network interface "myvip"
# Change the associated server to "my_server"
# Change the address to "1.2.3.201"
res = client.patch_network_interfaces(
    names=['myvip'],
    network_interface=NetworkInterface(
        address='1.2.3.201',
        server='my_server'))
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: ids
# See section "Common Fields" for examples

get_network_interfaces_ping

# Default behavior will send a single ping from both FMs/XFMs and one blade.
ping_dest = 'localhost'
res = client.get_network_interfaces_ping(destination=ping_dest)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Send 5 pings from the component being specified. Also include the full
# user-to-user latency.
res = client.get_network_interfaces_ping(destination=ping_dest,
                                         count=5,
                                         component_name='CH1.FB1',
                                         print_latency=True)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Send pings using 120-byte packets, and using the specified interface (subnet, vip, or IP)
# as the source. Do not resolve the destination's IP address to a hostname
res = client.get_network_interfaces_ping(destination=ping_dest,
                                         packet_size=120,
                                         source='fm1.admin0',
                                         resolve_hostname=False)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

post_network_interfaces

from pypureclient.flashblade import NetworkInterface

# create vip named myvip on the array
res = client.post_network_interfaces(
    names=["myvip"],
    network_interface=NetworkInterface(address='1.2.3.101',
                                       services=["data"],
                                       type="vip"))
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# create a replication vip named replvip on the array
res = client.post_network_interfaces(
    names=["replvip"],
    network_interface=NetworkInterface(address='1.2.3.101',
                                       services=["replication"],
                                       type="vip"))
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# create vip inside 'my_server' server object
res = client.post_network_interfaces(
    names=["replvip"],
    network_interface=NetworkInterface(address='1.2.3.101',
                                       services=["replication"],
                                       type="vip",
                                       server={"name": "my_server"}))
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

get_network_interfaces_trace

# Default behavior traces the route of UDP packets from both FMs/XFMs and one blade.
trace_dest = 'localhost'
res = client.get_network_interfaces_trace(destination=trace_dest)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Trace only from the component being specified. Use TCP and do not allow packet fragmentation.
res = client.get_network_interfaces_trace(destination=trace_dest,
                                          component_name='CH1.FB1',
                                          method='tcp',
                                          fragment_packet=False)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Trace the route to a specified port at the destination, using the specified interface (vip,
# subnet or IP) as the source. Do not resolve the destination's IP address to a hostname, and
# discover the MTU.
res = client.get_network_interfaces_trace(destination=trace_dest,
                                          port=80,
                                          source='fm1.admin0',
                                          resolve_hostname=False,
                                          discover_mtu=True)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

Object Store Access Keys

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

delete_object_store_access_keys

# delete an access key with name 'PSABSSZRHPMEDKHMAAJPJBONPJGGDDAOFABDEXAMPLE'
client.delete_object_store_access_keys(names=["PSABSSZRHPMEDKHMAAJPJBONPJGGDDAOFABDEXAMPLE"])

# Other valid fields: context_names
# See section "Common Fields" for examples

get_object_store_access_keys

# list all object store access keys
res = client.get_object_store_access_keys()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list and sort by created in descendant order
res = client.get_object_store_access_keys(limit=5, sort="created-")
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list with page size 5
res = client.get_object_store_access_keys(limit=5)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list all remaining object store access keys
res = client.get_object_store_access_keys(continuation_token=res.continuation_token)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list with filter
res = client.get_object_store_access_keys(filter='user.name=\'acc1/myobjuser\'')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: allow_errors, context_names, names, offset
# See section "Common Fields" for examples

patch_object_store_access_keys

from pypureclient.flashblade import ObjectStoreAccessKey

# Disable the object store access key named "PSABSSZRHPMEDKHMAAJPJBONPJGGDDAOFABDEXAMPLE"
res = client.patch_object_store_access_keys(
    names=['PSABSSZRHPMEDKHMAAJPJBONPJGGDDAOFABDEXAMPLE'], object_store_access_key=ObjectStoreAccessKey(enabled=False))
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: context_names
# See section "Common Fields" for examples

post_object_store_access_keys

from pypureclient.flashblade import ObjectStoreAccessKeyPost

# generate access key and secret key for object store user
# note: you need to handle the secret key since you can't retrieve it from the array after create
res = client.post_object_store_access_keys(
    object_store_access_key=ObjectStoreAccessKeyPost(user={'name': 'acc1/myobjuser'}))
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# make another access key for the user with id '100abf42-0000-4000-8023-000det400090'
res = client.post_object_store_access_keys(
    object_store_access_key=ObjectStoreAccessKeyPost(user={'id': '100abf42-0000-4000-8023-000det400090'}))
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# import credentials from another FlashBlade
res = client.post_object_store_access_keys(
    names=['PSABSSZRHPMEDKHMAAJPJBONPJGGDDAOFABDGLBJLHO'],
    object_store_access_key=ObjectStoreAccessKeyPost(
        user={'name': 'acc1/myobjuser'}, secret_access_key='BAG61F63105e0d3669/e066+5C5DFBE2c127d395LBGG'
    )
)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: context_names
# See ids in section "Common Fields" for examples

Object Store Accounts

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

delete_object_store_accounts

# delete a object store account with name myobjaccount
client.delete_object_store_accounts(names=["myobjaccount"])

# Other valid fields: context_names, ids
# See section "Common Fields" for examples

get_object_store_accounts

# list all object store accounts
res = client.get_object_store_accounts()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list and sort by unique in descendant order
res = client.get_object_store_accounts(limit=5, sort="space.unique-")
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list with page size 5
res = client.get_object_store_accounts(limit=5)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list all remaining object store accounts
res = client.get_object_store_accounts(continuation_token=res.continuation_token)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list with filter
res = client.get_object_store_accounts(filter='name=\'myobjaccount*\'')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: allow_errors, context_names, ids, names, offset, total_only
# See section "Common Fields" for examples

patch_object_store_accounts

from pypureclient.flashblade import BucketDefaults, ObjectStoreAccountPatch, PublicAccessConfig

# Update the quota settings for the account named "my-obj-store-account". Enable a
# hard limit (i.e. enforced) quota of 100G.
res = client.patch_object_store_accounts(names=["my-obj-store-account"],
                                         object_store_account=ObjectStoreAccountPatch(quota_limit=str(100*1024*1024*1024),
                                                                                      hard_limit_enabled=True))
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Reduce the hard limit quota for "my-obj-store-account" to 80G while ignoring its current usage (i.e.
# the operation should not fail due to the account's size currently being greater than 80G)
res = client.patch_object_store_accounts(names=["my-obj-store-account"],
                                         object_store_account=ObjectStoreAccountPatch(quota_limit=str(80*1024*1024*1024)),
                                         ignore_usage=True)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Update the BucketDefaults for "my-obj-store-account". Enable a soft (i.e. alerted but unenforced)
# quota limit of 10G for each new bucket for which an overriding quota configuration is not provided.
bucket_default_attr = BucketDefaults(quota_limit=str(10*1024*1024*1024),
                                     hard_limit_enabled=False)
res = client.patch_object_store_accounts(names=["my-obj-store-account"],
                                         object_store_account=ObjectStoreAccountPatch(bucket_defaults=bucket_default_attr))
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Clear the quota limit for "my-obj-store-account"
res = client.patch_object_store_accounts(names=["my-obj-store-account"],
                                         object_store_account=ObjectStoreAccountPatch(quota_limit=''))
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Disable block new public policies for "my-obj-store-account".
res = client.patch_object_store_accounts(names=["my-obj-store-account"],
                           object_store_account=ObjectStoreAccountPatch(
                                public_access_config=PublicAccessConfig(block_new_public_policies=False)))
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Disable block public access for "my-obj-store-account".
res = client.patch_object_store_accounts(names=["my-obj-store-account"],
                          object_store_account=ObjectStoreAccountPatch(
                               public_access_config=PublicAccessConfig(block_public_access=False)))
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Block new public policies and public access for "my-obj-store-account".
res = client.patch_object_store_accounts(names=["my-obj-store-account"],
                          object_store_account=ObjectStoreAccountPatch(
                               public_access_config=PublicAccessConfig(
                                    block_new_public_policies=True,
                                    block_public_access=True)))
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: context_names, ids
# See section "Common Fields" for examples

post_object_store_accounts

from pypureclient.flashblade import BucketDefaults, ObjectStoreAccountPost

# Post the object store account object "myobjaccount" on the array. Provide an initial quota
# configuration that uses a hard (i.e. enforced) quota limit of 1T for the account, and a default
# soft quota limit of 50G for buckets that will be created in the account.
bucket_default_attr = BucketDefaults(quota_limit=str(50*1024*1024*1024),
                                     hard_limit_enabled=False)
res = client.post_object_store_accounts(names=["myobjaccount"],
                                        object_store_account=ObjectStoreAccountPost(quota_limit=str(1024*1024*1024*1024),
                                                                                    hard_limit_enabled=True,
                                                                                    bucket_defaults=bucket_default_attr))
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: context_names
# See ids in section "Common Fields" for examples

Object Store Remote Credentials

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

delete_object_store_remote_credentials

# delete the remote credentials with the name 'remote/credentials'
client.delete_object_store_remote_credentials(names=['remote/credentials'])

# delete the remote credentials with the id '10314f42-020d-7080-8013-000ddt400090'
client.delete_object_store_remote_credentials(ids=['10314f42-020d-7080-8013-000ddt400090'])

# Other valid fields: context_names, ids
# See section "Common Fields" for examples

get_object_store_remote_credentials

# list all remote credentials
res = client.get_object_store_remote_credentials()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list first five remote credentials using default sort
res = client.get_object_store_remote_credentials(limit=5)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list first five remote credentials and sort by access key
res = client.get_object_store_remote_credentials(limit=5, sort='access_key_id')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list all remaining remote credentials
res = client.get_object_store_remote_credentials(continuation_token=res.continuation_token)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list with filter to see only remote credentials that are on a specific remote
res = client.get_object_store_remote_credentials(filter='name=\'s3target/*\'')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: allow_errors, context_names, ids, names, offset
# See section "Common Fields" for examples

patch_object_store_remote_credentials

from pypureclient.flashblade import ObjectStoreRemoteCredentials

# Change the name of an existing set of remote credentials to "remote/credentials2"
# Change the access key id of an existing set of remote credentials
# Change the secret access key of an existing set of remote credentials
new_attr = ObjectStoreRemoteCredentials(name='remote/credentials2',
                                        access_key_id='PSFBIKZFCAAAKOEJ',
                                        secret_access_key='0BEC00003+b1228C223c0FbF1ab5e4GICJGBPJPEOLJCD')
# update the the remote credentials with the name 'remote/credentials1' with our new attributes
res = client.patch_object_store_remote_credentials(names=['remote/credentials1'],
                                                   remote_credentials=new_attr)
print(res)
# update the the remote credentials with the id '10314f42-020d-7080-8013-000ddt400090' with our new attributes
res = client.patch_object_store_remote_credentials(ids=['10314f42-020d-7080-8013-000ddt400090'],
                                                   remote_credentials=new_attr)
print(res)

# Other valid fields: context_names
# See section "Common Fields" for examples

post_object_store_remote_credentials

from pypureclient.flashblade import ObjectStoreRemoteCredentials

# create a remote credentials object corresponding to user credentials on the remote
name = "remote/credentials"
access_key = "PSFBIKZFCAAAKOEJ"
secret_key = "0BEC00003+b1228C223c0FbF1ab5e4GICJGBPJPEOLJCD"
remote_credentials = ObjectStoreRemoteCredentials(access_key_id=access_key, secret_access_key=secret_key)
# post the remote credentials object on the local array
res = client.post_object_store_remote_credentials(names=[name], remote_credentials=remote_credentials)
print(res)

# Other valid fields: context_names
# See ids in section "Common Fields" for examples

Object Store Roles

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

delete_object_store_roles

# delete object store role by name
client.delete_object_store_roles(names=["acc1/myobjrole"])

# delete object store role by id
client.delete_object_store_roles(ids=["10314f42-020d-7080-8013-000ddt400012"])

# Other valid fields: context_names
# See section "Common Fields" for examples

get_object_store_roles

# list all object store roles
res = client.get_object_store_roles()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list and sort by created in descendant order
res = client.get_object_store_roles(limit=5, sort="created-")
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list with page size 5
res = client.get_object_store_roles(limit=5)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list all remaining object store roles
res = client.get_object_store_roles(continuation_token=res.continuation_token)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list with filter
res = client.get_object_store_roles(filter='name=\'acc1/myobjrole*\'')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: allow_errors, context_names, ids, names, offset
# See section "Common Fields" for examples

delete_object_store_roles_object_store_access_policies

# remove a policy from a role
client.delete_object_store_roles_object_store_access_policies(
    member_names=["acc1/myobjrole"], policy_names=["pure:policy/bucket-list"])

# remove a policy from a role by id
client.delete_object_store_roles_object_store_access_policies(
    member_ids=["10314f42-020d-7080-8013-000ddt400090"], policy_ids=["10314f42-020d-7080-8013-000ddt400012"])

# Other valid fields: context_names
# See section "Common Fields" for examples

get_object_store_roles_object_store_access_policies

# list access policies for object store roles
res = client.get_object_store_roles_object_store_access_policies()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list access policies for specific role
res = client.get_object_store_roles_object_store_access_policies(member_names=["acc1/myobjrole"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list access policies for specific role by id
res = client.get_object_store_roles_object_store_access_policies(member_ids=["10314f42-020d-7080-8013-000ddt400090"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list only roles with full access
res = client.get_object_store_roles_object_store_access_policies(policy_names=["pure:policy/full-access"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list only roles with a specific policy by id
res = client.get_object_store_roles_object_store_access_policies(policy_ids=["10314f42-020d-7080-8013-000ddt400012"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: allow_errors, context_names, continuation_token, filter, limit, offset, sort
# See section "Common Fields" for examples

post_object_store_roles_object_store_access_policies

# add a policy to a role
res = client.post_object_store_roles_object_store_access_policies(
    member_names=["acc1/myobjrole"], policy_names=["pure:policy/bucket-list"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# add a member to a policy by id
res = client.post_object_store_roles_object_store_access_policies(
    member_ids=["10314f42-020d-7080-8013-000ddt400090"], policy_ids=["10314f42-020d-7080-8013-000ddt400012"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: context_names
# See ids in section "Common Fields" for examples

get_object_store_roles_object_store_trust_policies_download

# download trust policy by object store role id
res = client.get_object_store_roles_object_store_trust_policies_download(role_ids=["f8b3b3b3-3b3b-3b3b-3b3b-3b3b3b3b3b3b"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# download trust policy by object store role name
res = client.get_object_store_roles_object_store_trust_policies_download(role_names=["acc1/myobjrole"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# download trust policy by trust policy name
res = client.get_object_store_roles_object_store_trust_policies_download(names=["acc1/myobjrole/trust-policy"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

get_object_store_roles_object_store_trust_policies

# list trust policy by object store role id
res = client.get_object_store_roles_object_store_trust_policies(role_ids=["f8b3b3b3-3b3b-3b3b-3b3b-3b3b3b3b3b3b"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list trust policy by object store role name
res = client.get_object_store_roles_object_store_trust_policies(role_names=["acc1/myobjrole"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list trust policy by trust policy name
res = client.get_object_store_roles_object_store_trust_policies(names=["acc1/myobjrole/trust-policy"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: allow_errors, context_names, continuation_token, filter, limit, offset, sort
# See section "Common Fields" for examples

delete_object_store_roles_object_store_trust_policies_rules

# remove a rule by role name and rule name
client.delete_object_store_roles_object_store_trust_policies_rules(role_names=["acc1/myobjrole"], names=["myrule"])
# remove a rule by role name and rule index
client.delete_object_store_roles_object_store_trust_policies_rules(role_names=["acc1/myobjrole"], indices=[1])
# remove a rule by role id and rule name
client.delete_object_store_roles_object_store_trust_policies_rules(role_ids=["f8b3b3b3-3b3b-3b3b-3b3b-3b3b3b3b3b3b"], names=["myrule"])
# remove a rule by role id and rule index
client.delete_object_store_roles_object_store_trust_policies_rules(role_ids=["f8b3b3b3-3b3b-3b3b-3b3b-3b3b3b3b3b3b"], indices=[1])
# remove a rule by policy name and rule name
client.delete_object_store_roles_object_store_trust_policies_rules(policy_names=["acc1/myobjrole/trust-policy"], names=["myrule"])
# remove a rule by policy name and rule index
client.delete_object_store_roles_object_store_trust_policies_rules(policy_names=["acc1/myobjrole/trust-policy"], indices=[1])

# Other valid fields: context_names
# See section "Common Fields" for examples

get_object_store_roles_object_store_trust_policies_rules

# list all rules of a specific object store access policy by role name
res = client.get_object_store_roles_object_store_trust_policies_rules(role_names=["acc1/myobjrole"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list all rules of a specific object store access policy by role id
res = client.get_object_store_roles_object_store_trust_policies_rules(role_ids=["10314f42-020d-7080-8013-000ddt400012"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list rules for specific policy
res = client.get_object_store_roles_object_store_trust_policies_rules(policy_names=["acc1/myobjrole/trust-policy"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list specific rule name
res = client.get_object_store_roles_object_store_trust_policies_rules(policy_names=["acc1/myobjrole/trust-policy"], names=["myrule"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list specific rule index
res = client.get_object_store_roles_object_store_trust_policies_rules(policy_names=["acc1/myobjrole/trust-policy"], indices=[1])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: allow_errors, context_names, continuation_token, filter, limit, offset, sort
# See section "Common Fields" for examples

patch_object_store_roles_object_store_trust_policies_rules

from pypureclient.flashblade.FB_2_17 import TrustPolicyRule, TrustPolicyRuleCondition, Reference

rule = TrustPolicyRule(
    effect='allow',
    actions=['sts:AssumeRoleWithSAML'],
    principals=[Reference(name='SAMLProvider')],
    conditions=[
        TrustPolicyRuleCondition(
            key='saml:aud',
            operator='StringEquals',
            values=['https://signin.flashblade.purestorage.com/']
        )
    ]
)
# patch a rule for the object store trust policy for a rule name
res = client.patch_object_store_roles_object_store_trust_policies_rules(role_names=['acc1/myobjrole'], names=['myrule'], rule=rule)
# patch a rule for the object store trust policy for a rule index
res = client.patch_object_store_roles_object_store_trust_policies_rules(role_names=['acc1/myobjrole'], indices=[1], rule=rule)
# patch a rule for the object store trust policy for a policy name
res = client.patch_object_store_roles_object_store_trust_policies_rules(policy_names=['acc1/myobjrole/trust-policy'], indices=[1], rule=rule)
# patch a rule for the object store trust policy for a role id
res = client.patch_object_store_roles_object_store_trust_policies_rules(role_ids=['f8b3b3b3-3b3b-3b3b-3b3b-3b3b3b3b3b3b'], indices=[1], rule=rule)

# Other valid fields: context_names
# See section "Common Fields" for examples

post_object_store_roles_object_store_trust_policies_rules

from pypureclient.flashblade.FB_2_17 import TrustPolicyRule, TrustPolicyRuleCondition, Reference

rule = TrustPolicyRule(
    effect='allow',
    actions=['sts:AssumeRoleWithSAML'],
    principals=[Reference(name='SAMLProvider')],
    conditions=[
        TrustPolicyRuleCondition(
            key='saml:aud',
            operator='StringEquals',
            values=['https://signin.flashblade.purestorage.com/']
        )
    ]
)
# Create a new rule for the object store trust policy for a role name
res = client.post_object_store_roles_object_store_trust_policies_rules(role_names=['acc1/myobjrole'], names=['myrule'], rule=rule)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    res_items = (list(res.items))
    print(res_items)
# Create a new rule for the object store trust policy for a role ID
res = client.post_object_store_roles_object_store_trust_policies_rules(role_ids=['10314f42-020d-7080-8013-000ddt400012'], names=['myrule'], rule=rule)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    res_items = (list(res.items))
    print(res_items)
# Create a new rule for the object store trust policy for a trust policy name
res = client.post_object_store_roles_object_store_trust_policies_rules(policy_names=['acc1/myobjrole/trust-policy'], names=['myrule'], rule=rule)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    res_items = (list(res.items))
    print(res_items)

# Other valid fields: context_names
# See ids in section "Common Fields" for examples

patch_object_store_roles_object_store_trust_policies_upload

# upload trust policy by object store role id
body = {
    "Version": "2012-10-07",
    "Statement": [
        {
            "Effect": "Allow",
            "Principal": {
                "Federated": "arn:aws:iam:::saml-provider/ADFS"
            },
            "Action": "sts:AssumeRoleWithSAML",
            "Condition": {
                "StringEquals": {
                    "SAML:aud": "https://signin.aws.amazon.com/saml"
                }
            }
        }
    ]
}
res = client.patch_object_store_roles_object_store_trust_policies_upload(role_ids=["f8b3b3b3-3b3b-3b3b-3b3b-3b3b3b3b3b3b"], policy_document=body)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(res.items)
# upload trust policy by object store role name
res = client.patch_object_store_roles_object_store_trust_policies_upload(role_names=["acc1/myobjrole"], policy_document=body)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(res.items)
# upload trust policy by trust policy name
res = client.patch_object_store_roles_object_store_trust_policies_upload(names=["acc1/myobjrole/trust-policy"], policy_document=body)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(res.items)

# Other valid fields: context_names
# See section "Common Fields" for examples

patch_object_store_roles

from pypureclient.flashblade.FB_2_17 import ObjectStoreRole

# update role by role name
res = client.patch_object_store_roles(names=["acc1/myobjrole"],
                                      object_store_role=ObjectStoreRole(max_session_duration=7200))
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# update role by role id
res = client.patch_object_store_roles(ids=["f8b3b3b3-3b3b-3b3b-3b3b-3b3b3b3b3b3b"],
                                      object_store_role=ObjectStoreRole(max_session_duration=7200))
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: context_names
# See section "Common Fields" for examples

post_object_store_roles

from pypureclient.flashblade.FB_2_17 import ObjectStoreRole

res = client.post_object_store_roles(names=["acc1/myobjrole"], object_store_role=ObjectStoreRole(max_session_duration=7200))
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: context_names
# See ids in section "Common Fields" for examples

Object Store Users

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

delete_object_store_users

client.delete_object_store_users(names=["acc1/myobjuser"])

# Other valid fields: context_names, ids
# See section "Common Fields" for examples

get_object_store_users

# list all object store users
res = client.get_object_store_users()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list and sort by created in descendant order
res = client.get_object_store_users(limit=5, sort="created-")
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list with page size 5
res = client.get_object_store_users(limit=5)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list all remaining object store users
res = client.get_object_store_users(continuation_token=res.continuation_token)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list with filter
res = client.get_object_store_users(filter='name=\'acc1/myobjuser*\'')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: allow_errors, context_names, ids, names, offset
# See section "Common Fields" for examples

delete_object_store_users_object_store_access_policies

# remove a policy from a user
client.delete_object_store_users_object_store_access_policies(
    member_names=["acc1/myobjuser"], policy_names=["pure:policy/bucket-list"])

# remove a policy from a user by id
client.delete_object_store_users_object_store_access_policies(
    member_ids=["10314f42-020d-7080-8013-000ddt400090"], policy_ids=["10314f42-020d-7080-8013-000ddt400012"])

# Other valid fields: context_names
# See section "Common Fields" for examples

get_object_store_users_object_store_access_policies

# list access policies for object store users
res = client.get_object_store_users_object_store_access_policies()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list access policies for specific user
res = client.get_object_store_users_object_store_access_policies(
    member_names=["acc1/myobjuser"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list access policies for specific user by id
res = client.get_object_store_users_object_store_access_policies(member_ids=["10314f42-020d-7080-8013-000ddt400090"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list only users with full access
res = client.get_object_store_users_object_store_access_policies(policy_names=["pure:policy/full-access"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list only users with a specific policy by id
res = client.get_object_store_users_object_store_access_policies(policy_ids=["10314f42-020d-7080-8013-000ddt400012"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: allow_errors, context_names, continuation_token, filter, limit, offset, sort
# See section "Common Fields" for examples

post_object_store_users_object_store_access_policies

# add a policy to a user
res = client.post_object_store_users_object_store_access_policies(
    member_names=["acc1/myobjuser"], policy_names=["pure:policy/bucket-list"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# add a member to a policy by id
res = client.post_object_store_users_object_store_access_policies(
    member_ids=["10314f42-020d-7080-8013-000ddt400090"], policy_ids=["10314f42-020d-7080-8013-000ddt400012"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: context_names
# See ids in section "Common Fields" for examples

post_object_store_users

# post the object store user object myobjuser on the array without full access
res = client.post_object_store_users(names=["acc1/myobjuser"], full_access=False)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: context_names
# See ids in section "Common Fields" for examples

Object Store Virtual Hosts

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

delete_object_store_virtual_hosts

# delete the object store virtual host on the array
client.delete_object_store_virtual_hosts(names=["s3.myhost.com"])

# delete by id
client.delete_object_store_virtual_hosts(ids=["10314f42-020d-7080-8013-000ddt400090"])

# Other valid fields: context_names
# See section "Common Fields" for examples

get_object_store_virtual_hosts

# list all object store virtual hosts
res = client.get_object_store_virtual_hosts()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list and sort by created in descendant order
res = client.get_object_store_virtual_hosts(limit=3, sort="name-")
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list with page size 3
res = client.get_object_store_virtual_hosts(limit=3)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list with filter
res = client.get_object_store_virtual_hosts(filter='name=\'s3.myhost*\'')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list by name
res = client.get_object_store_virtual_hosts(names=['s3.myhost*'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list by id
res = client.get_object_store_virtual_hosts(ids=['10314f42-020d-7080-8013-000ddt400090'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: allow_errors, context_names, continuation_token, offset
# See section "Common Fields" for examples

post_object_store_virtual_hosts

# post the object store virtual host on the array
res = client.post_object_store_virtual_hosts(names=["s3.myhost.com"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: context_names
# See ids in section "Common Fields" for examples

Oidc Sso

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

delete_sso_oidc_idps

# delete a SSO OIDC configuration by name
res = client.delete_sso_oidc_idps(names=['test-sso'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# delete a SSO OIDC configuration by id
res = client.delete_sso_oidc_idps(ids=['10314f42-020d-7080-8013-000ddt400012'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

get_sso_oidc_idps

# Get all SSO OIDC configurations
res = client.get_sso_oidc_idps()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Get an SSO OIDC configuration by name
res = client.get_sso_oidc_idps(names=['test-sso'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Get an SSO OIDC configuration by ID
res = client.get_sso_oidc_idps(ids=['10314f42-020d-7080-8013-000ddt400012'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: filter, limit, offset, sort, continuation_token
# See section "Common Fields" for examples

patch_sso_oidc_idps

from pypureclient.flashblade.FB_2_17 import OidcSso, OidcSsoPostIdp, Reference

provider_url_ca_certificate = Reference(name='test-ca-certificate')
provider_url_ca_certificate_group = Reference(name='test-ca-certificate-group')
idp = OidcSsoPostIdp(provider_url='https://test-provider-url',
                  provider_url_ca_certificate=provider_url_ca_certificate,
                  provider_url_ca_certificate_group=provider_url_ca_certificate_group)
oidc = OidcSso(enabled=True, services=['object'], idp=idp)
# Patch an SSO OIDC configuration by name
res = client.patch_sso_oidc_idps(names=['test-oidc'], idp=oidc)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    res_items = (list(res.items))
    print(res_items)
# Patch an SSO OIDC configuration by id (random UUID)
res = client.patch_sso_oidc_idps(ids=['100abf42-0000-4000-8023-000det400090'], idp=oidc)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    res_items = (list(res.items))
    print(res_items)

post_sso_oidc_idps

from pypureclient.flashblade.FB_2_17 import OidcSso, OidcSsoPostIdp, Reference

# create a SSO OIDC configuration
provider_url_ca_certificate = Reference(name='test-ca-certificate')
provider_url_ca_certificate_group = Reference(name='test-ca-certificate-group')
idp = OidcSsoPostIdp(provider_url='https://test-provider-url',
                  provider_url_ca_certificate=provider_url_ca_certificate,
                  provider_url_ca_certificate_group=provider_url_ca_certificate_group)
oidc = OidcSso(enabled=True, services=['object'], idp=idp)
res = client.post_sso_oidc_idps(names=['test-oidc'], idp=oidc)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    res_items = (list(res.items))
    print(res_items)

Policies Audit For File Systems

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

delete_audit_file_systems_policies

# delete a policy by name
client.delete_audit_file_systems_policies(names=['audit_policy_1'])

# delete a policy by ID
client.delete_audit_file_systems_policies(ids=['2a37c647-19e9-4308-b469-89d9a9753160'])

# Other valid fields: context_names
# See section "Common Fields" for examples

get_audit_file_systems_policies

# list all audit policies
res = client.get_audit_file_systems_policies()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

policyname = 'audit_policy_1'

# list audit policy for policy policyname
res = client.get_audit_file_systems_policies(names=[policyname])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# List audit policies specified by id.
res = client.get_audit_file_systems_policies(ids=['83efe671-3265-af1e-6dd2-c9ff155c2a18'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: allow_errors, context_names, filter, limit, offset, sort, continuation_token
# See section "Common Fields" for examples

delete_audit_file_systems_policies_members

# detach an audit policy from a file system
# assume we have a policy named "p1", and a file system named "myfs"
client.delete_audit_file_systems_policies_members(policy_names=["p1"], member_names=["myfs"])

# Other valid fields: context_names, policy_ids, member_ids
# See section "Common Fields" for examples

get_audit_file_systems_policies_members

# list all policies
res = client.get_audit_file_systems_policies_members()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# assume we have a policy named "p1", and a file system named "myfs"
res = client.get_audit_file_systems_policies_members(policy_names=["p1"],
                                       member_names=["myfs"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list and sort by name in descendant order
res = client.get_audit_file_systems_policies_members(limit=5, sort="policy.name-")
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list with page size 5
res = client.get_audit_file_systems_policies_members(limit=5)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list all remaining policies
res = client.get_audit_file_systems_policies_members(continuation_token=res.continuation_token)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: allow_errors, context_names, filter, member_ids, policy_ids, offset
# See section "Common Fields" for examples

post_audit_file_systems_policies_members

# attach an audit policy to a file system
# assume we have a policy named "p1", and a file system named "myfs"
res = client.post_audit_file_systems_policies_members(policy_names=["p1"],
                                        member_names=["myfs"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: context_names, member_ids, policy_ids
# See section "Common Fields" for examples

patch_audit_file_systems_policies

from pypureclient.flashblade.FB_2_17 import AuditFileSystemsPoliciesPatch, Reference

policyname = 'audit_policy_1'

# Disable the policy.
policy = AuditFileSystemsPoliciesPatch(enabled=False)
res = client.patch_audit_file_systems_policies(names=[policyname], policy=policy) # need to change body name to policy in PURest
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))


# add one log target and remove old log target
policy = AuditFileSystemsPoliciesPatch(enabled=True)
policy.add_log_targets = [Reference(name='syslog2')]
policy.remove_log_targets = [Reference(name='syslog1')]
res = client.patch_audit_file_systems_policies(names=[policyname], policy=policy) # need to change body name to policy in PURest
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: context_names, ids
# See section "Common Fields" for examples

post_audit_file_systems_policies

from pypureclient.flashblade.FB_2_17 import AuditFileSystemsPolicy, Reference

# Create an audit policy with a syslog target named 'syslog1'
policyname = 'audit_policy_1'
policy = AuditFileSystemsPolicy()
policy.log_targets = [Reference(name='syslog1')]

res = client.post_audit_file_systems_policies(names=[policyname], policy=policy)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: context_names
# See section "Common Fields" for examples

Policies Network Access

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

get_network_access_policies

# list all network access policies
res = client.get_network_access_policies()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list network access policies specified by name
res = client.get_network_access_policies(names=['default-network-access-policy'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# List network access policies specified by id.
res = client.get_network_access_policies(ids=['83efe671-3265-af1e-6dd2-c9ff155c2a18'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: filter, limit, offset, sort, continuation_token
# See section "Common Fields" for examples

get_network_access_policies_members

# list all network access policies
res = client.get_network_access_policies_members()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# assume we have a policy named, and an array named "test-array"
res = client.get_network_access_policies_members(policy_names=["default-network-access-policy"],
                                                 member_names=["test-array"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list network access policies specified by name
res = client.get_network_access_policies_members(policy_names=['default-network-access-policy'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# List network access policies specified by member id.
res = client.get_network_access_policies_members(member_ids=['83efe671-3265-af1e-6dd2-c9ff155c2a18'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list only members with a specific policy by id
res = client.get_network_access_policies_members(policy_ids=["10314f42-020d-7080-8013-000ddt400012"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: filter, limit, offset, sort, continuation_token
# See section "Common Fields" for examples

patch_network_access_policies

from pypureclient.flashblade import NetworkAccessPolicy, NetworkAccessPolicyRule

# Rename the policy.
policy_attr = NetworkAccessPolicy(name='new-default-rules')
res = client.patch_network_access_policies(names=['default-network-access-policy'], policy=policy_attr)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Bulk specify a set of new rules for the policy.
# Note: The rules must be ordered by client type grouped by
#    IP addresses, netmasks, and asterisk (*).
bulk_rules = [
    NetworkAccessPolicyRule(client='1.2.3.4', effect='deny', interfaces=['snmp', 'management-ssh']),
    NetworkAccessPolicyRule(client='*', interfaces=['snmp', 'management-ssh', 'management-web-ui'])
]
policy_attr = NetworkAccessPolicy(rules=bulk_rules)
res = client.patch_network_access_policies(names=['default-network-access-policy'], policy=policy_attr)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# update the network access policy with id '83efe671-3265-af1e-6dd2-c9ff155c2a18'
res = client.patch_network_access_policies(ids=['83efe671-3265-af1e-6dd2-c9ff155c2a18'],
                                           policy=policy_attr)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    res_items = (list(res.items))
    print(res_items)

# Other valid fields: ids, versions
# See section "Common Fields" for examples

delete_network_access_policies_rules

# delete a policy rule by name
client.delete_network_access_policies_rules(names=['default-network-access-policy.1'])

# delete a policy by name with a version specifier.
# The delete will fail if the policy version differs from specified version.
policy_version = '00000000-7b11-a468-0000-0000503669ea'
client.delete_network_access_policies_rules(names=['default-network-access-policy.1'], versions=[policy_version])

# delete a policy by ID
client.delete_network_access_policies_rules(ids=['2a37c647-19e9-4308-b469-89d9a9753160'])

get_network_access_policies_rules

# list all network access policy rules
res = client.get_network_access_policies_rules()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list all network access policy rules for policy 'default-network-rules'
res = client.get_network_access_policies_rules(policy_names=['default-network-access-policy'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# List network access policy rule named 'default-network-rules.1' for policy 'default-network-rules'
res = client.get_network_access_policies_rules(names=['default-network-access-policy.1'],
                                               policy_names=['default-network-access-policy'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: filter, limit, offset, sort, continuation_token, ids, policy_ids
# See section "Common Fields" for examples

patch_network_access_policies_rules

from pypureclient.flashblade import NetworkAccessPolicyRule

policyname = 'default-network-access-policy'

# Patch client policy rule 'default-network-rules.1' in network access policy named 'default-network-rules'
res = client.patch_network_access_policies_rules(names=[policyname+'.1'],
                                                 rule=NetworkAccessPolicyRule(effect='deny'))

# Patch a policy by name with a version specifier.
# The Patch will fail if the policy version differs from specified version.
policy_version = '00000000-7b11-a468-0000-0000503669ea'
res = client.patch_network_access_policies_rules(names=[policyname+'.1'],
                                                 rule=NetworkAccessPolicyRule(interfaces=['snmp']),
                                                 versions=[policy_version])

# Insert or Move a rule default-network-rules.1 rule before 'default-network-rules.2` in policy named 'default-network-rules'
res = client.patch_network_access_policies_rules(names=[policyname+'.1'],
                                                 before_rule_name=policyname+'.2',
                                                 rule=NetworkAccessPolicyRule(interfaces=['snmp', "management-ssh"]))

# Insert or Move a rule 'default-network-rules.1` before rule id `10314f42-020d-7080-8013-000ddt400012` in policy named 'default-network-rules'
res = client.patch_network_access_policies_rules(names=[policyname+'.1'],
                                                 before_rule_id="10314f42-020d-7080-8013-000ddt400012",
                                                 rule=NetworkAccessPolicyRule(client='1.1.1.1'))

print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: ids
# See section "Common Fields" for examples

post_network_access_policies_rules

from pypureclient.flashblade import NetworkAccessPolicyRule

policyname = 'default-network-access-policy'

# Create a new client policy rule in the policy named 'default-network-rules'
res = client.post_network_access_policies_rules(policy_names=[policyname],
                                                rule=NetworkAccessPolicyRule(client='192.168.1.0/24', interfaces=['snmp']))

# Insert or Move a policy by name with a version specifier.
# The Post will fail if the policy version differs from specified version.
policy_version = '00000000-7b11-a468-0000-0000503669ea'
res = client.post_network_access_policies_rules(policy_names=[policyname],
                                                rule=NetworkAccessPolicyRule(client='*', interfaces=['management-ssh']),
                                                versions=[policy_version])

# Insert or Move a rule default-network-rules.1 rule before 'default-network-rules.2` in policy named 'default-network-rules'
res = client.post_network_access_policies_rules(before_rule_name=policyname+'.2',
                                                policy_names=[policyname],
                                                rule=NetworkAccessPolicyRule(client='*', interfaces=['management-ssh']))

# Insert or Move a rule 'default-network-rules.1` before rule id `10314f42-020d-7080-8013-000ddt400012` in policy named 'default-network-rules'
res = client.post_network_access_policies_rules(before_rule_id="10314f42-020d-7080-8013-000ddt400012",
                                                policy_names=[policyname],
                                                rule=NetworkAccessPolicyRule(client='*', interfaces=['management-ssh']))

print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: policy_ids
# See section "Common Fields" for examples

Policies Nfs

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

delete_nfs_export_policies

# delete a policy by name
client.delete_nfs_export_policies(names=["export_policy_1"])

# delete a policy by name with a version specifier.
# The delete will fail if the policy version differs from specified version.
# The version can be retrieved from the response from
# get_nfs_export_policies, patch_nfs_export_policies or post_nfs_export_policies.
policy_version = '00000000-7b11-a468-0000-0000503669ea'
client.delete_nfs_export_policies(names=["export_policy_1"], versions=[policy_version])

# delete a policy by ID
client.delete_nfs_export_policies(ids=["10314f42-020d-7080-8013-000ddt400012"])

# Other valid fields: context_names
# See section "Common Fields" for examples

get_nfs_export_policies

# list all nfs export policies
res = client.get_nfs_export_policies()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list nfs export policies specified by name
res = client.get_nfs_export_policies(names=['export_policy_1'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# List nfs export policies specified by id.
res = client.get_nfs_export_policies(ids=['83efe671-3265-af1e-6dd2-c9ff155c2a18'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: allow_errors, context_names, filter, limit, offset, sort, continuation_token
# See section "Common Fields" for examples

patch_nfs_export_policies

from pypureclient.flashblade import NfsExportPolicy, NfsExportPolicyRule

# Disable the policy.
policy_attr = NfsExportPolicy(enabled=False)
res = client.patch_nfs_export_policies(names=['export_policy_1'], policy=policy_attr)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Bulk specify new rules for the policy.
# Note: The rules must be ordered by client type grouped by
#    IP addresses, netmasks, netgroups, and asterisk (*).
bulk_rules = [NfsExportPolicyRule(client='10.20.30.40', access='root-squash', permission='rw'),
              NfsExportPolicyRule(client='192.168.0.0/28', access='root-squash', permission='ro',
                                  security=['sys']),
              NfsExportPolicyRule(client='@devgroup', access='root-squash', permission='rw',
                                  anonuid='500', anongid='500'),
              NfsExportPolicyRule(client='*', access='root-squash', permission='ro', secure=True),
              ]
policy_attr = NfsExportPolicy(rules=bulk_rules)
res = client.patch_nfs_export_policies(names=["export_policy_1"], policy=policy_attr)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# update the nfs export policy with id '83efe671-3265-af1e-6dd2-c9ff155c2a18'
res = client.patch_nfs_export_policies(ids=['83efe671-3265-af1e-6dd2-c9ff155c2a18'],
                                       policy=policy_attr)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    res_items = (list(res.items))
    print(res_items)
    curr_version = res_items[0].version

# update the nfs export policy using a version retrieved from a previous get, patch or post call.
# The call to patch_nfs_export_policies will fail if the version differs from the current version.
# That indicates that the export policy or one of its rules was modified since the version
# was acquired.
res = client.patch_nfs_export_policies(names=["export_policy_1"], policy=policy_attr,
                                       versions=[curr_version])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    res_items = (list(res.items))
    print(res_items)

# Other valid fields: context_names, ids
# See section "Common Fields" for examples

post_nfs_export_policies

from pypureclient.flashblade import (NfsExportPolicy, NfsExportPolicyRuleInPolicy)

# Create an export policy with 2 rules. The first for client 10.20.30.40 with readwrite permissions
# and root-squash.  The second with read-only permissions for all other clients.
policyname = "export_policy_1"
policy = NfsExportPolicy()
policy.rules = [
    NfsExportPolicyRuleInPolicy(client='10.20.30.40', permission='rw', access='root-squash'),
    NfsExportPolicyRuleInPolicy(client='*', permission='ro')
]
res = client.post_nfs_export_policies(names=[policyname], policy=policy)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: context_names
# See section "Common Fields" for examples

delete_nfs_export_policies_rules

# delete a policy rule by name
client.delete_nfs_export_policies_rules(names=['export_policy_1.1'])

# delete a policy rule by name with a version specifier.
# The delete will fail if the policy version differs from specified version.
# The policy_version can be retrieved from the response from
# get_nfs_export_policies, patch_nfs_export_policies, post_nfs_export_policies,
# get_nfs_export_policies_rule, patch_nfs_export_policies_rule, or post_nfs_export_policies_rule.
policy_version = '00000000-7b11-a468-0000-0000503669ea'
client.delete_nfs_export_policies_rules(names=['export_policy_1.1'], versions=[policy_version])

# delete a policy by ID
client.delete_nfs_export_policies_rules(ids=['2a37c647-19e9-4308-b469-89d9a9753160'])

# Other valid fields: context_names
# See section "Common Fields" for examples

get_nfs_export_policies_rules

# list all nfs export policy rules
res = client.get_nfs_export_policies_rules()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list all nfs export policy rules for export_policy 'export_policy_1'
res = client.get_nfs_export_policies_rules(policy_names=['export_policy_1'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# List nfs export policy rule named 'export_policy_1.1'
res = client.get_nfs_export_policies_rules(names=['export_policy_1.1'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: allow_errors, context_names, filter, limit, offset, sort, continuation_token, ids, policy_ids
# See section "Common Fields" for examples

patch_nfs_export_policies_rules

from pypureclient.flashblade import NfsExportPolicyRule

rulename = 'export_policy_1.2'

# Patch export policy rule 'export_policy_1.2' in the export policy named 'export_policy_1'
res = client.patch_nfs_export_policies_rules(names=[rulename],
                                             rule=NfsExportPolicyRule(permission='ro'))
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Move an export policy rule in the rules list.
# to index 1. (indexes are 1 based.)
res = client.patch_nfs_export_policies_rules(names=[rulename],
                                             rule=NfsExportPolicyRule(index=1))
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Move an exported rule before the rule named 'export_policy_1.1'.
res = client.patch_nfs_export_policies_rules(names=[rulename],
                                             rule=NfsExportPolicyRule(),
                                             before_rule_name='export_policy_1.1')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Move an export rule before the rule with id '38e24e2d-9e24-46c3-9701-52a7d97a7343'.
res = client.patch_nfs_export_policies_rules(names=[rulename],
                                             rule=NfsExportPolicyRule(),
                                             before_rule_id='38e24e2d-9e24-46c3-9701-52a7d97a7343')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Patch an existing rule specifying the client, readwrite permissions, rootsquash, anonuid,
# anongid, atime, fileid_32bit, secure and security attributes.
res = client.patch_nfs_export_policies_rules(names=[rulename],
                                             rule=NfsExportPolicyRule(client='10.20.0.0/24',
                                                                      permission='rw',
                                                                      access='root-squash',
                                                                      anonuid='400',
                                                                      anongid='500',
                                                                      atime=True,
                                                                      secure=True,
                                                                      security=['sys']))
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    res_items = list(res.items)
    print(res_items)
    policy_version = res_items[0].policy_version

# Patch an existing rule while ensuring that the policy has not been changed since the last patch.
res = client.patch_nfs_export_policies_rules(names=[rulename],
                                             rule=NfsExportPolicyRule(permission='ro'),
                                             versions=[policy_version])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: context_names, ids
# See section "Common Fields" for examples

post_nfs_export_policies_rules

from pypureclient.flashblade import NfsExportPolicyRule

policyname = "export_policy_1"

# Create a new export policy rule in the export policy named 'export_policy_1'
res = client.post_nfs_export_policies_rules(rule=NfsExportPolicyRule(client='10.20.30.1',
                                                                     permission='rw'),
                                            policy_names=[policyname])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Create a new export policy rule in the export policy named 'export_policy_1'
# and insert it at index 1. (indexes are 1 based.)
res = client.post_nfs_export_policies_rules(rule=NfsExportPolicyRule(client='10.20.30.2',
                                                                     permission='rw',
                                                                     index=1),
                                            policy_names=[policyname])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Create a new export policy rule in the export policy named 'export_policy_1'
# and insert it before the rule named 'export_policy_1.1'.
res = client.post_nfs_export_policies_rules(rule=NfsExportPolicyRule(client='10.20.30.3',
                                                                     permission='rw'),
                                            policy_names=[policyname],
                                            before_rule_name='export_policy_1.1')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Create a new export policy rule in the export policy named 'export_policy_1'
# and insert it before the rule with id '10314f42-020d-7080-8013-000ddt400090'.
res = client.post_nfs_export_policies_rules(rule=NfsExportPolicyRule(client='10.20.30.4',
                                                                     permission='rw'),
                                            policy_names=[policyname],
                                            before_rule_id='10314f42-020d-7080-8013-000ddt400090')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Create a new export policy rule in the export policy named 'export_policy_1'
# specifying a subnet mask for the client, readwrite permissions, and rootsquash to anonuid=400
# and anongid=500.
res = client.post_nfs_export_policies_rules(rule=NfsExportPolicyRule(client='10.20.0.0/24',
                                                                     permission='rw',
                                                                     access='root-squash',
                                                                     anonuid='400',
                                                                     anongid='500'),
                                            policy_names=[policyname])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))


# Create a new export policy rule in the export policy named 'export_policy_1'
# specifying a netgroup for the client, and the atime, fileid_32bit, secure, and security attributes.
res = client.post_nfs_export_policies_rules(rule=NfsExportPolicyRule(client='@dev_group',
                                                                     atime=True,
                                                                     secure=True,
                                                                     security=['sys'],
                                                                     anongid='500'),
                                            policy_names=[policyname])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    res_items = list(res.items)
    print(res_items)
    policy_version = res_items[0].policy_version

# Create a new export policy ensuring that the policy has not been changed since the last rule was added.
res = client.post_nfs_export_policies_rules(rule=NfsExportPolicyRule(client='*'),
                                            policy_names=[policyname],
                                            versions=[policy_version])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: context_names, policy_ids
# See section "Common Fields" for examples

Policies Object Store Access

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

delete_object_store_access_policies

# delete a policy by name
client.delete_object_store_access_policies(names=["acc1/mypolicy"])

# delete a policy by ID
client.delete_object_store_access_policies(ids=["10314f42-020d-7080-8013-000ddt400012"])

# Other valid fields: context_names
# See section "Common Fields" for examples

get_object_store_access_policies

# list all object store access policies
res = client.get_object_store_access_policies()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list all object store access policies without listing their rules
res = client.get_object_store_access_policies(exclude_rules=True)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Valid fields: allow_errors, context_names, continuation_token, filter, ids, limit, names, offset, sort
# See section "Common Fields" for examples

delete_object_store_access_policies_object_store_roles

# remove a member from a policy
client.delete_object_store_access_policies_object_store_roles(
    member_names=["acc1/myobjrole"], policy_names=["pure:policy/bucket-list"])

# remove a member from a policy by id
client.delete_object_store_access_policies_object_store_roles(
    member_ids=["10314f42-020d-7080-8013-000ddt400090"], policy_ids=["10314f42-020d-7080-8013-000ddt400012"])

# Other valid fields: context_names
# See section "Common Fields" for examples

get_object_store_access_policies_object_store_roles

# list access policies for object store roles
res = client.get_object_store_access_policies_object_store_roles()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list access policies for specific role
res = client.get_object_store_access_policies_object_store_roles(member_names=["acc1/myobjrole"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list access policies for specific role by id
res = client.get_object_store_access_policies_object_store_roles(member_ids=["10314f42-020d-7080-8013-000ddt400090"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list only roles with full access
res = client.get_object_store_access_policies_object_store_roles(policy_names=["pure:policy/full-access"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list only roles with a specific policy by id
res = client.get_object_store_access_policies_object_store_roles(policy_ids=["10314f42-020d-7080-8013-000ddt400012"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list by (role_name, policy_name), (role_id, policy_id), (role_name, policy_id), and (role_id, policy_name)
res = client.get_object_store_access_policies_object_store_roles(member_names=["acc1/myobjrole"], policy_names=["pure:policy/full-access"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
res = client.get_object_store_access_policies_object_store_roles(member_ids=["10314f42-020d-7080-8013-000ddt400090"], policy_ids=["10314f42-020d-7080-8013-000ddt400012"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
res = client.get_object_store_access_policies_object_store_roles(member_ids=["10314f42-020d-7080-8013-000ddt400090"], policy_names=["pure:policy/full-access"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
res = client.get_object_store_access_policies_object_store_roles(member_names=["acc1/myobjrole"], policy_ids=["10314f42-020d-7080-8013-000ddt400012"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: allow_errors, context_names, continuation_token, filter, limit, offset, sort
# See section "Common Fields" for examples

post_object_store_access_policies_object_store_roles

# add a member to a policy
res = client.post_object_store_access_policies_object_store_roles(
    member_names=["acc1/myobjrole"], policy_names=["pure:policy/bucket-list"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# add a member to a policy by id
res = client.post_object_store_access_policies_object_store_roles(
    member_ids=["10314f42-020d-7080-8013-000ddt400090"], policy_ids=["10314f42-020d-7080-8013-000ddt400012"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: context_names
# See ids in section "Common Fields" for examples

delete_object_store_access_policies_object_store_users

# remove a member from a policy
client.delete_object_store_access_policies_object_store_users(
    member_names=["acc1/myobjuser"], policy_names=["pure:policy/bucket-list"])

# remove a member from a policy by id
client.delete_object_store_access_policies_object_store_users(
    member_ids=["10314f42-020d-7080-8013-000ddt400090"], policy_ids=["10314f42-020d-7080-8013-000ddt400012"])

# Other valid fields: context_names
# See section "Common Fields" for examples

get_object_store_access_policies_object_store_users

# list access policies for object store users
res = client.get_object_store_access_policies_object_store_users()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list access policies for specific user
res = client.get_object_store_access_policies_object_store_users(member_names=["acc1/myobjuser"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list access policies for specific user by id
res = client.get_object_store_access_policies_object_store_users(member_ids=["10314f42-020d-7080-8013-000ddt400090"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list only users with full access
res = client.get_object_store_access_policies_object_store_users(policy_names=["pure:policy/full-access"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list only users with a specific policy by id
res = client.get_object_store_access_policies_object_store_users(policy_ids=["10314f42-020d-7080-8013-000ddt400012"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: allow_errors, context_names, continuation_token, filter, limit, offset, sort
# See section "Common Fields" for examples

post_object_store_access_policies_object_store_users

# add a member to a policy
res = client.post_object_store_access_policies_object_store_users(
    member_names=["acc1/myobjuser"], policy_names=["pure:policy/bucket-list"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# add a member to a policy by id
res = client.post_object_store_access_policies_object_store_users(
    member_ids=["10314f42-020d-7080-8013-000ddt400090"], policy_ids=["10314f42-020d-7080-8013-000ddt400012"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: context_names
# See ids in section "Common Fields" for examples

patch_object_store_access_policies

from pypureclient.flashblade import ObjectStoreAccessPolicy, PolicyRuleObjectAccess, PolicyRuleObjectAccessCondition

# update a policy by changing its rules, where some rules bypass our action restriction enforcement
rule = PolicyRuleObjectAccess(
    name="myupdatedrule",
    actions=["s3:ListBucket"],
    resources=["mybucket/myobject"],
    conditions=PolicyRuleObjectAccessCondition(
        source_ips=["1.2.3.4"],
        s3_prefixes=["home/"],
        s3_delimiters=["/"],
    ),
    effect="deny"
)
policy = ObjectStoreAccessPolicy(
    rules=[rule]
)
res = client.patch_object_store_access_policies(
    names=["acc1/mypolicy"], policy=policy, enforce_action_restrictions=False)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# update a different policy with the same rules, but by ID this time
res = client.patch_object_store_access_policies(
    ids=["10314f42-020d-7080-8013-000ddt400012"], policy=policy, enforce_action_restrictions=False)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: context_names
# See section "Common Fields" for examples

post_object_store_access_policies

from pypureclient.flashblade import ObjectStoreAccessPolicyPost, PolicyRuleObjectAccess, PolicyRuleObjectAccessCondition

# create a basic policy (no description, no rules yet)
res = client.post_object_store_access_policies(names=["acc1/mypolicy"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# create a policy with a description and some rules, where some rules bypass our action restriction enforcement
rule = PolicyRuleObjectAccess(
    name="myrule",
    actions=["s3:ListBucket"],
    resources=["mybucket/myobject"],
    conditions=PolicyRuleObjectAccessCondition(
        source_ips=["1.2.3.4"],
        s3_prefixes=["home/"],
        s3_delimiters=["/"],
    ),
    effect="deny"
)
policy = ObjectStoreAccessPolicyPost(
    description="This is my policy description.",
    rules=[rule]
)
res = client.post_object_store_access_policies(
    names=["acc1/mynewpolicy"], policy=policy, enforce_action_restrictions=False)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: context_names
# See ids in section "Common Fields" for examples

delete_object_store_access_policies_rules

# delete a rule by policy name
client.delete_object_store_access_policies_rules(policy_names=["acc1/mypolicy"], names=["myrule"])

# delete by policy ID
client.delete_object_store_access_policies_rules(
    policy_ids=["10314f42-020d-7080-8013-000ddt400012"], names=["myrule"])

# Other valid fields: context_names
# See section "Common Fields" for examples

get_object_store_access_policies_rules

# list all object store access policy rules
res = client.get_object_store_access_policies_rules()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list rules for specific policy
res = client.get_object_store_access_policies_rules(policy_names=["pure:policy/full-access"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list rules for specific policy by id
res = client.get_object_store_access_policies_rules(policy_ids=["10314f42-020d-7080-8013-000ddt400012"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list specific rule
res = client.get_object_store_access_policies_rules(policy_names=["pure:policy/full-access"], names=["myrule"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: allow_errors, context_names, continuation_token, filter, limit, offset, sort
# See section "Common Fields" for examples

patch_object_store_access_policies_rules

from pypureclient.flashblade import PolicyRuleObjectAccess, PolicyRuleObjectAccessCondition

rule = PolicyRuleObjectAccess(
    actions=["s3:ListBucket"],
    resources=["*"],
    conditions=PolicyRuleObjectAccessCondition(
        source_ips=["1.2.3.4"],
        s3_prefixes=["home/"],
        s3_delimiters=["/"],
    ),
    effect="deny"
)
res = client.patch_object_store_access_policies_rules(policy_names=["acc1/mypolicy"], names=["myrule"], rule=rule)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# update the rule in a way which doesn't follow our action restrictions; also use policy ID instead of name
rule = PolicyRuleObjectAccess(
    actions=["s3:ListBucket"],
    resources=["mybucket/myobject"],
    conditions=PolicyRuleObjectAccessCondition(
        source_ips=["1.2.3.4"],
        s3_prefixes=["home/"],
        s3_delimiters=["/"],
    ),
    effect="allow"
)
res = client.patch_object_store_access_policies_rules(
    policy_ids=["10314f42-020d-7080-8013-000ddt400012"], names=["myrule"], rule=rule, enforce_action_restrictions=False)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: context_names
# See section "Common Fields" for examples

post_object_store_access_policies_rules

from pypureclient.flashblade import PolicyRuleObjectAccessPost, PolicyRuleObjectAccessCondition

rule = PolicyRuleObjectAccessPost(
    actions=["s3:ListBucket"],
    resources=["*"],
    conditions=PolicyRuleObjectAccessCondition(
        source_ips=["1.2.3.4"],
        s3_prefixes=["home/"],
        s3_delimiters=["/"],
    ),
    effect="deny"
)
res = client.post_object_store_access_policies_rules(policy_names=["acc1/mypolicy"], names=["myrule"], rule=rule)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# create a rule which doesn't follow our action restrictions; also use policy ID instead of name
rule2 = PolicyRuleObjectAccessPost(
    actions=["s3:ListBucket"],
    resources=["mybucket/myobject"],
    conditions=PolicyRuleObjectAccessCondition(
        source_ips=["1.2.3.4"],
        s3_prefixes=["home/"],
        s3_delimiters=["/"],
    ),
    effect="allow"
)
res = client.post_object_store_access_policies_rules(
    policy_ids=["10314f42-020d-7080-8013-000ddt400012"], names=["myrule2"], rule=rule2, enforce_action_restrictions=False)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: context_names
# See ids in section "Common Fields" for examples

get_object_store_access_policy_actions

# list all object store access policy actions
res = client.get_object_store_access_policy_actions()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Valid fields: allow_errors, context_names, continuation_token, filter, limit, names, offset, sort
# See section "Common Fields" for examples

Policies Password

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

get_password_policies

# Get all password policies
res = client.get_password_policies()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# get a password policy
res = client.get_password_policies(names=['policy-name'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# get a password policy by id
res = client.get_password_policies(ids=['10314f42-020d-7080-8013-000ddt400013'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: filter, limit, offset, sort, continuation_token
# See section "Common Fields" for examples

patch_password_policies

from pypureclient.flashblade.FB_2_16 import PasswordPolicy

# update a password policy
policy_body = PasswordPolicy(
            enabled=True,
            lockout_duration=0,
            max_login_attempts=0,
            min_password_length=0,
            password_history=0,
            min_password_age=0,
            enforce_username_check=False,
            min_character_groups=0,
            min_characters_per_group=0,
            enforce_dictionary_check=False,
)

res = client.patch_password_policies(names='management',
                                      policy=policy_body)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    res_items = (list(res.items))
    print(res_items)

# Other valid fields: ids
# See section "Common Fields" for examples

Policies Qo S

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

delete_qos_policies

# delete an existing qos policy named 'my_qos_policy'
res = client.delete_qos_policies(names=['my_qos_policy'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# delete an existing qos policy using id
res = client.delete_qos_policies(ids=['635c0a0c-37ad-4f91-bad7-5224c284c2ad'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

get_qos_policies_file_systems

# list all qos policies and their file system members
res = client.get_qos_policies_file_systems()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list qos policies attached to a set of file systems using their names
res = client.get_qos_policies_file_systems(member_names=["my_fs_1", "my_fs_2"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list qos policies attached to a set of file systems using their ids
res = client.get_qos_policies_file_systems(member_ids=["ac46ad53-de6e-432b-a543-64838dddd100",
                                                       "bdfab698-7213-4902-8f93-346d48fa8daa"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list file systems associated with a set of qos policies using their names
res = client.get_qos_policies_file_systems(policy_names=["my_qos_policy_1", "my_qos_policy_2"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list file systems associated with a set of qos policies using their ids
res = client.get_qos_policies_file_systems(policy_ids=["fe0534ab-045e-4627-aeb6-3f92591a34dd",
                                                       "f170146e-72f0-4c12-b909-33ce74534685"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: continuation_token, filter, limit, offset, sort
# See section "Common Fields" for examples

get_qos_policies

# list all qos policies
res = client.get_qos_policies()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# get a specific qos policy using name
res = client.get_qos_policies(names=["myqos"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# get a specific qos policy using id
res = client.get_qos_policies(ids=["38453e5c-1c5d-459f-8d76-a2bb5d1db56a"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# filter example - enabled only
res = client.get_qos_policies(filter="enabled")
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# filter example - disabled only
res = client.get_qos_policies(filter="enabled='False'")
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# filter example - list policies with max bytes per sec less than 1G
res = client.get_qos_policies(filter="max_total_bytes_per_sec<1073741824")
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# filter example - list policies with max bytes per sec greater than or equal to 1G
res = client.get_qos_policies(filter="max_total_bytes_per_sec>='1G'")
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: continuation_token, limit, offset, sort
# See section "Common Fields" for examples

get_qos_policies_members

# list all qos policies and their managed object members
res = client.get_qos_policies_members()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list qos policies attached to a set of members using their names
res = client.get_qos_policies_members(member_names=["my_fs_1", "my_fs_2"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list qos policies attached to a set of members using their ids
res = client.get_qos_policies_members(member_ids=["635c0a0c-37ad-4f91-acq0-5224c284c2ad",
                                                  "dc227307-c29a-4868-b5da-7f249777f222"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list members associated with a set of qos policies using their names
res = client.get_qos_policies_members(policy_names=["my_qos_policy_1", "my_qos_policy_2"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list members associated with a set of qos policies using their ids
res = client.get_qos_policies_members(policy_ids=["18f91fa7-840e-453a-9313-eed2914dea3a",
                                                  "d9b82931-0e58-4834-a59f-d2d751bba927"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: continuation_token, filter, limit, offset, sort
# See section "Common Fields" for examples

patch_qos_policies

from pypureclient.flashblade.FB_2_17 import QosPolicy

# patch an existing QoS policy named 'my_qos_policy' with the desired settings
# name field can be used in patch operation to rename the policy
QOS_POLICY_NAME = 'my_qos_policy'
QOS_POLICY_RENAME = 'my_qos_policy_renamed'
qos_policy = QosPolicy(
    name=QOS_POLICY_RENAME,
    max_total_bytes_per_sec=1073741824,
    max_total_ops_per_sec=24000,
    enabled=False
)

# patch using name
res = client.patch_qos_policies(names=[QOS_POLICY_NAME], policy=qos_policy)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# patch using id
res = client.patch_qos_policies(ids=['635c0a0c-37ad-4f91-bad7-5224c284c2ad'], policy=qos_policy)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

post_qos_policies

from pypureclient.flashblade.FB_2_17 import QosPolicy

# create a QoS policy object with the desired settings
# note that name field is used for rename operation and NOT specified during creation
# the policy is enabled by default
qos_policy = QosPolicy(
    max_total_bytes_per_sec=1073741824,
    max_total_ops_per_sec=12000
)
QOS_POLICY_NAME = 'my_qos_policy'
res = client.post_qos_policies(names=[QOS_POLICY_NAME], policy=qos_policy)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

Policies Smb Client

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

delete_smb_client_policies

# delete a policy by name
client.delete_smb_client_policies(names=["client_policy_1"])

# delete a policy by ID
client.delete_smb_client_policies(ids=["10314f42-020d-7080-8013-000ddt400012"])

# Other valid fields: context_names
# See section "Common Fields" for examples

get_smb_client_policies

# list all smb client policies
res = client.get_smb_client_policies()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list smb client policies specified by name
res = client.get_smb_client_policies(names=['client_policy_1'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# List smb client policies specified by id.
res = client.get_smb_client_policies(ids=['83efe671-3265-af1e-6dd2-c9ff155c2a18'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: allow_errors, context_names, filter, limit, offset, sort, continuation_token
# See section "Common Fields" for examples

patch_smb_client_policies

from pypureclient.flashblade import SmbClientPolicy, SmbClientPolicyRule

# Bulk specify a new rule for the policy.
# Note: The rules must be ordered by client type grouped by
#    IP addresses, (hostname, FQDN, netmasks), and asterisk (*).
bulk_rules = [
    SmbClientPolicyRule(client='*', permission='ro', encryption='required')
]
policy_attr = SmbClientPolicy(rules=bulk_rules, access_based_enumeration_enabled=False)
res = client.patch_smb_client_policies(names=["client_policy_1"], policy=policy_attr)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# update the smb client policy with id '83efe671-3265-af1e-6dd2-c9ff155c2a18'
res = client.patch_smb_client_policies(ids=['83efe671-3265-af1e-6dd2-c9ff155c2a18'],
                                       policy=policy_attr)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    res_items = (list(res.items))
    print(res_items)

# Other valid fields: context_names, ids
# See section "Common Fields" for examples

post_smb_client_policies

from pypureclient.flashblade import SmbClientPolicy, SmbClientPolicyRule

# Create a client policy with a rule which allows Read (but no other) permissions and
# requires encryption for everyone.
policyname = 'client_policy_1'
policy = SmbClientPolicy()
policy.rules = [SmbClientPolicyRule(client='*',  permission='ro', encryption='required')]

res = client.post_smb_client_policies(names=[policyname], policy=policy)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: context_names
# See section "Common Fields" for examples

delete_smb_client_policies_rules

# delete a policy rule by name
client.delete_smb_client_policies_rules(names=['client_policy_1.1'])

# delete a policy by name with a version specifier.
# The delete will fail if the policy version differs from specified version.
policy_version = '00000000-7b11-a468-0000-0000503669ea'
client.delete_smb_client_policies_rules(names=['client_policy_1.1'], versions=[policy_version])

# delete a policy by ID
client.delete_smb_client_policies_rules(ids=['2a37c647-19e9-4308-b469-89d9a9753160'])

# Other valid fields: context_names
# See section "Common Fields" for examples

get_smb_client_policies_rules

# list all smb client policy rules
res = client.get_smb_client_policies_rules()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list all smb client policy rules for client policy 'client_policy_1'
res = client.get_smb_client_policies_rules(policy_names=['client_policy_1'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# List smb client policy rule named 'client_policy_1.1' for policy 'client_policy_1'
res = client.get_smb_client_policies_rules(policy_names=['client_policy_1'],
                                          names=['client_policy_1.1'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: allow_errors, context_names, filter, limit, offset, sort, continuation_token, ids, policy_ids
# See section "Common Fields" for examples

patch_smb_client_policies_rules

from pypureclient.flashblade import SmbClientPolicyRule

policyname = 'client_policy_1'

# Patch client policy rule 'client_policy_1.1' in client policy named 'client_policy_1'
res = client.patch_smb_client_policies_rules(names=[policyname+'.1'],
                                             rule=SmbClientPolicyRule(permission='ro', encryption='required'))

print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Patch a policy by name with a version specifier.
# The Patch will fail if the policy version differs from specified version.
policy_version = '00000000-7b11-a468-0000-0000503669ea'
res = client.patch_smb_client_policies_rules(names=[policyname+'.1'],
                                             rule=SmbClientPolicyRule(permission='ro', encryption='required'),
                                             versions=[policy_version])

print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Insert or Move a rule client_policy_1.1 rule before 'client_policy_1.2` in client policy named 'client_policy_1'
res = client.patch_smb_client_policies_rules(names=[policyname+'.1'],
                                             before_rule_name=[policyname+'.2'],
                                             rule=SmbClientPolicyRule(permission='ro', encryption='required'))

print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Insert or Move a rule 'client_policy_1.1` before rule id `10314f42-020d-7080-8013-000ddt400012` in client policy named 'client_policy_1'
res = client.patch_smb_client_policies_rules(names=[policyname+'.1'],
                                             before_rule_id=["10314f42-020d-7080-8013-000ddt400012"],
                                             rule=SmbClientPolicyRule(permission='ro', encryption='required'))

print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: context_names, ids
# See section "Common Fields" for examples

post_smb_client_policies_rules

from pypureclient.flashblade import SmbClientPolicyRule

policyname = 'client_policy_1'

# Create a new client policy rule in the client policy named 'client_policy_1'
# with specified client, permission, and encryption
res = client.post_smb_client_policies_rules(policy_names=[policyname],
                                            rule=SmbClientPolicyRule(client='*', permission='ro', encryption='required'))

# Insert or Move a policy by name with a version specifier.
# The Post will fail if the policy version differs from specified version.
policy_version = '00000000-7b11-a468-0000-0000503669ea'
res = client.post_smb_client_policies_rules(policy_names=[policyname],
                                            rule=SmbClientPolicyRule(client='*', permission='ro', encryption='required'),
                                            versions=[policy_version])

# Insert or Move a rule client_policy_1.1 rule before 'client_policy_1.2` in client policy named 'client_policy_1'
res = client.post_smb_client_policies_rules(before_rule_name=[policyname+'.2'],
                                            policy_names=[policyname],
                                            rule=SmbClientPolicyRule(client='*', permission='ro', encryption='required'))

# Insert or Move a rule 'client_policy_1.1` before rule id `10314f42-020d-7080-8013-000ddt400012` in client policy named 'client_policy_1'
res = client.post_smb_client_policies_rules(before_rule_id=["10314f42-020d-7080-8013-000ddt400012"],
                                            policy_names=[policyname],
                                            rule=SmbClientPolicyRule(client='*', permission='ro', encryption='required'))

print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: context_names, policy_ids
# See section "Common Fields" for examples

Policies Smb Share

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

delete_smb_share_policies

# delete a policy by name
client.delete_smb_share_policies(names=["share_policy_1"])

# delete a policy by ID
client.delete_smb_share_policies(ids=["10314f42-020d-7080-8013-000ddt400012"])

# Other valid fields: context_names
# See section "Common Fields" for examples

get_smb_share_policies

# list all smb share policies
res = client.get_smb_share_policies()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list smb share policies specified by name
res = client.get_smb_share_policies(names=['share_policy_1'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# List smb share policies specified by id.
res = client.get_smb_share_policies(ids=['83efe671-3265-af1e-6dd2-c9ff155c2a18'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: allow_errors, context_names, filter, limit, offset, sort, continuation_token
# See section "Common Fields" for examples

patch_smb_share_policies

from pypureclient.flashblade import SmbSharePolicy, SmbSharePolicyRule

# Disable the policy.
policy_attr = SmbSharePolicy(enabled=False)
res = client.patch_smb_share_policies(names=['share_policy_1'], policy=policy_attr)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Bulk specify a new rule for the policy.
# Note: The rules must be ordered by client type grouped by
#    IP addresses, netmasks, netgroups, and asterisk (*).
bulk_rules = [
    SmbSharePolicyRule(principal='everyone', read='deny')
]
policy_attr = SmbSharePolicy(rules=bulk_rules)
res = client.patch_smb_share_policies(names=["share_policy_1"], policy=policy_attr)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# update the smb share policy with id '83efe671-3265-af1e-6dd2-c9ff155c2a18'
res = client.patch_smb_share_policies(ids=['83efe671-3265-af1e-6dd2-c9ff155c2a18'],
                                       policy=policy_attr)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    res_items = (list(res.items))
    print(res_items)

# Other valid fields: context_names, ids
# See section "Common Fields" for examples

post_smb_share_policies

from pypureclient.flashblade import (SmbSharePolicy, SmbSharePolicyRule)

# Create a share policy with a rule which allows Read (but no other) permissions for everyone.
policyname = 'share_policy_1'
policy = SmbSharePolicy()
policy.rules = [
    SmbSharePolicyRule(principal='everyone', read='allow')
]
res = client.post_smb_share_policies(names=[policyname], policy=policy)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: context_names
# See section "Common Fields" for examples

delete_smb_share_policies_rules

# delete a policy rule by name
client.delete_smb_share_policies_rules(policy_names=['share_policy_1'], names=['everyone'])

# delete a policy by ID
client.delete_smb_share_policies_rules(policy_ids=['10314f42-020d-7080-8013-000ddt400012'], ids=['2a37c647-19e9-4308-b469-89d9a9753160'])

# Other valid fields: context_names
# See section "Common Fields" for examples

get_smb_share_policies_rules

# list all smb share policy rules
res = client.get_smb_share_policies_rules()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list all smb share policy rules for share_policy 'share_policy_1'
res = client.get_smb_share_policies_rules(policy_names=['share_policy_1'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# List smb share policy rule named 'everyone' for policy 'share_policy_1'
res = client.get_smb_share_policies_rules(policy_names=['share_policy_1'],
                                          names=['everyone'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: allow_errors, context_names, filter, limit, offset, sort,
#                     continuation_token, ids, policy_ids
# See section "Common Fields" for examples

patch_smb_share_policies_rules

from pypureclient.flashblade import SmbSharePolicyRule

# Patch share policy rule 'everyone' in share policy named 'share_policy_1'
res = client.patch_smb_share_policies_rules(policy_names=['share_policy_1'],
                                            names=['everyone'],
                                            rule=SmbSharePolicyRule(read='deny'))
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Patch share policy rule 'everyone' in share policy with policy_id = xxxxxxxxxxxx
res = client.patch_smb_share_policies_rules(policy_ids=["10314f42-020d-7080-8013-000ddt400012"],
                                            names=['everyone'],
                                            rule=SmbSharePolicyRule(read='deny'))
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: context_names, ids
# See section "Common Fields" for examples

post_smb_share_policies_rules

from pypureclient.flashblade import SmbSharePolicyRule

policyname = 'share_policy_1'

# Create a new share policy rule in the share policy named 'share_policy_1'
res = client.post_smb_share_policies_rules(rule=SmbSharePolicyRule(principal='everyone',
                                                                   read='allow'),
                                           policy_names=[policyname])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: context_names, policy_ids
# See section "Common Fields" for examples

Policies Snapshot

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

delete_policies

# delete a policy name p1
client.delete_policies(names=["p1"])

# Other valid fields: context_names, ids
# See section "Common Fields" for examples

post_policies_file_system_replica_links

res = client.post_policies_file_system_replica_links(
    policy_names=['policy_1'],
    local_file_system_names=['local_fs'],
    remote_names=['myremote'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: context_names, policy_ids, local_file_system_ids, remote_ids, member_ids
# See section "Common Fields" for examples

delete_policies_file_system_snapshots

# attach policy to a file system snapshot
# assume we have a policy named "p1", and a file system snapshot named "myfs.suffix"
client.delete_policies_file_system_snapshots(policy_names=["p1"],
                                             member_names=["myfs.suffix"])

# Other valid fields: context_names, policy_ids, member_ids
# See section "Common Fields" for examples

get_policies_file_system_snapshots

# list all policies
res = client.get_policies_file_system_snapshots()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# assume we have a policy named "p1", and a file system snapshot named "myfs.1"
res = client.get_policies_file_system_snapshots(policy_names=["p1"],
                                                member_names=["myfs.1"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# assume we have a policy with id "10314f42-020d-7080-8013-000ddt400090",
# and a file system snapshot with name "myfs.2"
res = client.get_policies_file_system_snapshots(policy_ids=["10314f42-020d-7080-8013-000ddt400090"],
                                                member_names=["myfs.2"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list and sort by name in descendant order
res = client.get_policies_file_system_snapshots(limit=5, sort="policy.name-")
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list with page size 5
res = client.get_policies_file_system_snapshots(limit=5)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: allow_errors, context_names, continuation_token, filter, member_ids, offset
# See section "Common Fields" for examples

delete_policies_file_systems

# attach policy to a file system
# assume we have a policy named "p1", and a file system named "myfs"
client.delete_policies_file_systems(policy_names=["p1"],
                                    member_names=["myfs"])

# Other valid fields: context_names, policy_ids, member_ids
# See section "Common Fields" for examples

get_policies_file_systems

# list all policies
res = client.get_policies_file_systems()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# assume we have a policy named "p1", and a file system named "myfs"
res = client.get_policies_file_systems(policy_names=["p1"],
                                       member_names=["myfs"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list and sort by name in descendant order
res = client.get_policies_file_systems(limit=5, sort="policy.name-")
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list with page size 5
res = client.get_policies_file_systems(limit=5)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list all remaining policies
res = client.get_policies_file_systems(continuation_token=res.continuation_token)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: allow_errors, context_names, filter, member_ids, policy_ids, offset
# See section "Common Fields" for examples

post_policies_file_systems

# attach policy to a file system
# assume we have a policy named "p1", and a file system named "myfs"
res = client.post_policies_file_systems(policy_names=["p1"],
                                        member_names=["myfs"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: context_names, member_ids, policy_ids
# See section "Common Fields" for examples

get_policies

# list all policies
res = client.get_policies()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list and sort by name in descendant order
res = client.get_policies(limit=5, sort="name-")
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list with page size 5
res = client.get_policies(limit=5)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list all remaining policies
res = client.get_policies(continuation_token=res.continuation_token)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: allow_errors, context_names, filter, ids, names, offset, sort
# See section "Common Fields" for examples

get_policies_members

# list all policies
res = client.get_policies_members()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# assume we have a policy named "p1", and a file system named "myfs"
res = client.get_policies_members(policy_names=["p1"],
                                  member_names=["myfs"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
res = client.get_policies_members(policy_names=["p1"],
                                  member_names=["myfs"],
                                  remote_names=["myremote"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# assume we have a policy named "p1", and a file system snapshot named "myfs.1"
res = client.get_policies_members(policy_names=["p1"],
                                  member_names=["myfs.1"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list and sort by name in descendant order
res = client.get_policies_members(limit=5, sort="policy.name-")
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list with page size 5
res = client.get_policies_members(limit=5)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list all remaining policies
res = client.get_policies_members(continuation_token=res.continuation_token)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: allow_errors, context_names, filter, local_file_system_ids, local_file_system_names,
#                     member_ids, member_types, offset, policy_ids, remote_ids, remote_file_system_ids,
#                     remote_file_system_names
# See section "Common Fields" for examples

patch_policies

from pypureclient.flashblade import PolicyPatch, PolicyRule

# Update the policy "p1", and set the "enabled" field to "False", add a rule and remove a rule
# By passing destroy_snapshots=True, we accept that snapshots created by the
# removed rule will be destroyed.
rule_to_be_removed = PolicyRule(every=1000*60*5, keep_for=1000*60*60)
rule_to_be_added = PolicyRule(every=1000*60*10, keep_for=1000*60*60)
res = client.patch_policies(
    names=["p1"],
    destroy_snapshots=True,
    policy=PolicyPatch(enabled=False,
                       remove_rules=[rule_to_be_removed],
                       add_rules=[rule_to_be_added]))
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: context_names, ids
# See section "Common Fields" for examples

post_policies

from pypureclient.flashblade import Policy, PolicyRule

# post a policy object p1 on the array
attr = Policy(enabled=True,
              rules=[
                  # Take a snapshot every 5m and keep for 1h
                  PolicyRule(every=1000*60*5, keep_for=1000*60*60)
              ])
res = client.post_policies(names=["p1"], policy=attr)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: context_names
# See section "Common Fields" for examples

Policies Ssh Certificate Authority

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

delete_admins_ssh_certificate_authority_policies

# remove admin member from a policy
res = client.delete_admins_ssh_certificate_authority_policies(
    member_names=["user1"], policy_names=["test-ca-policy"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# add a member to a policy by id
client.delete_admins_ssh_certificate_authority_policies(
    member_ids=["10314f42-020d-7080-8013-000ddt400090"], policy_ids=["10314f42-020d-7080-8013-000ddt400012"])

get_admins_ssh_certificate_authority_policies

# list all ssh ca policy members for admins
res = client.get_admins_ssh_certificate_authority_policies()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# assume we have a policy named, and an admin member named "test-admin"
res = client.get_admins_ssh_certificate_authority_policies(policy_names=["test-policy"],
                                                           member_names=["test-admin"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list ssh certificate authority policies admin members specified by name
res = client.get_admins_ssh_certificate_authority_policies(policy_names=["test-policy"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# List ssh certificate authority policies specified by member id.
res = client.get_admins_ssh_certificate_authority_policies(member_ids=['83efe671-3265-af1e-6dd2-c9ff155c2a18'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list only admin members with a specific policy by id
res = client.get_admins_ssh_certificate_authority_policies(policy_ids=["10314f42-020d-7080-8013-000ddt400012"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: filter, limit, offset, sort, continuation_token
# See section "Common Fields" for examples

post_admins_ssh_certificate_authority_policies

# add admin member to a ssh certificate authority policy
res = client.post_admins_ssh_certificate_authority_policies(
    member_names=["user1"], policy_names=["test-ca-policy"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# add a member to a policy by id
res = client.post_admins_ssh_certificate_authority_policies(
    member_ids=["10314f42-020d-7080-8013-000ddt400090"], policy_ids=["10314f42-020d-7080-8013-000ddt400012"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

delete_arrays_ssh_certificate_authority_policies

# remove an array member from a policy
res = client.delete_arrays_ssh_certificate_authority_policies(
    member_names=["test-array"], policy_names=["test-ca-policy"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# add a member to a policy by id
client.delete_arrays_ssh_certificate_authority_policies(
    member_ids=["10314f42-020d-7080-8013-000ddt400090"], policy_ids=["10314f42-020d-7080-8013-000ddt400012"])

get_arrays_ssh_certificate_authority_policies

# list all ssh ca policy members for arrays
res = client.get_arrays_ssh_certificate_authority_policies()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# assume we have a policy named, and an array member named "test-array"
res = client.get_arrays_ssh_certificate_authority_policies(policy_names=["test-policy"],
                                                           member_names=["test-array"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list ssh certificate authority policies array members specified by name
res = client.get_arrays_ssh_certificate_authority_policies(policy_names=["test-policy"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# List ssh certificate authority policies member specified by member id.
res = client.get_arrays_ssh_certificate_authority_policies(member_ids=['83efe671-3265-af1e-6dd2-c9ff155c2a18'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list only array members with a specific policy by id
res = client.get_arrays_ssh_certificate_authority_policies(policy_ids=["10314f42-020d-7080-8013-000ddt400012"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: filter, limit, offset, sort, continuation_token
# See section "Common Fields" for examples

post_arrays_ssh_certificate_authority_policies

# add array member to a ssh certificate authority policy
res = client.post_arrays_ssh_certificate_authority_policies(
    member_names=["test-array"], policy_names=["test-ca-policy"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# add a member to a policy by id
res = client.post_arrays_ssh_certificate_authority_policies(
    member_ids=["10314f42-020d-7080-8013-000ddt400090"], policy_ids=["10314f42-020d-7080-8013-000ddt400012"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

delete_ssh_certificate_authority_policies_admins

# remove admin member from a policy
res = client.delete_ssh_certificate_authority_policies_admins(
    member_names=["user1"], policy_names=["test-ca-policy"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# add a member to a policy by id
client.delete_ssh_certificate_authority_policies_admins(
    member_ids=["10314f42-020d-7080-8013-000ddt400090"], policy_ids=["10314f42-020d-7080-8013-000ddt400012"])

get_ssh_certificate_authority_policies_admins

# list all ssh ca policy members for admins
res = client.get_ssh_certificate_authority_policies_admins()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# assume we have a policy named, and an admin member named "test-admin"
res = client.get_ssh_certificate_authority_policies_admins(policy_names=["test-policy"],
                                                           member_names=["test-admin"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list ssh certificate authority policies admin members specified by name
res = client.get_ssh_certificate_authority_policies_admins(policy_names=["test-policy"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# List ssh certificate authority policies specified by member id.
res = client.get_ssh_certificate_authority_policies_admins(member_ids=['83efe671-3265-af1e-6dd2-c9ff155c2a18'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list only admin members with a specific policy by id
res = client.get_ssh_certificate_authority_policies_admins(policy_ids=["10314f42-020d-7080-8013-000ddt400012"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: filter, limit, offset, sort, continuation_token
# See section "Common Fields" for examples

post_ssh_certificate_authority_policies_admins

# add admin member to a ssh certificate authority policy
res = client.post_ssh_certificate_authority_policies_admins(
    member_names=["user1"], policy_names=["test-ca-policy"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# add a member to a policy by id
res = client.post_ssh_certificate_authority_policies_admins(
    member_ids=["10314f42-020d-7080-8013-000ddt400090"], policy_ids=["10314f42-020d-7080-8013-000ddt400012"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

delete_ssh_certificate_authority_policies_arrays

# remove an array member from a policy
res = client.delete_ssh_certificate_authority_policies_arrays(
    member_names=["test-array"], policy_names=["test-ca-policy"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# add a member to a policy by id
client.delete_ssh_certificate_authority_policies_arrays(
    member_ids=["10314f42-020d-7080-8013-000ddt400090"], policy_ids=["10314f42-020d-7080-8013-000ddt400012"])

get_ssh_certificate_authority_policies_arrays

# list all ssh ca policy members for arrays
res = client.get_ssh_certificate_authority_policies_arrays()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# assume we have a policy named, and an array member named "test-array"
res = client.get_ssh_certificate_authority_policies_arrays(policy_names=["test-policy"],
                                                           member_names=["test-array"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list ssh certificate authority policies array members specified by name
res = client.get_ssh_certificate_authority_policies_arrays(policy_names=["test-policy"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# List ssh certificate authority policies member specified by member id.
res = client.get_ssh_certificate_authority_policies_arrays(member_ids=['83efe671-3265-af1e-6dd2-c9ff155c2a18'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list only array members with a specific policy by id
res = client.get_ssh_certificate_authority_policies_arrays(policy_ids=["10314f42-020d-7080-8013-000ddt400012"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: filter, limit, offset, sort, continuation_token
# See section "Common Fields" for examples

post_ssh_certificate_authority_policies_arrays

# add array member to a ssh certificate authority policy
res = client.post_ssh_certificate_authority_policies_arrays(
    member_names=["test-array"], policy_names=["test-ca-policy"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# add a member to a policy by id
res = client.post_ssh_certificate_authority_policies_arrays(
    member_ids=["10314f42-020d-7080-8013-000ddt400090"], policy_ids=["10314f42-020d-7080-8013-000ddt400012"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

delete_ssh_certificate_authority_policies

# delete a policy rule by name
client.delete_ssh_certificate_authority_policies(names=['default-policy'])

# delete a policy by ID
client.delete_ssh_certificate_authority_policies(ids=['2a37c647-19e9-4308-b469-89d9a9753160'])

get_ssh_certificate_authority_policies

# list all ssh certificiate_authority policies
res = client.get_ssh_certificate_authority_policies()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list ssh certificate authority policies specified by name
res = client.get_ssh_certificate_authority_policies(names=['test-policy'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# List ssh certificate authority policies specified by id.
res = client.get_ssh_certificate_authority_policies(ids=['83efe671-3265-af1e-6dd2-c9ff155c2a18'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: filter, limit, offset, sort, continuation_token
# See section "Common Fields" for examples

get_ssh_certificate_authority_policies_members

# list all ssh ca policy members
res = client.get_ssh_certificate_authority_policies_members()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# assume we have a policy named, and an array named "test-array"
res = client.get_ssh_certificate_authority_policies_members(policy_names=["test-policy"],
                                                            member_names=["test-array"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list ssh certificate authority policies specified by name
res = client.get_ssh_certificate_authority_policies_members(policy_names=["test-policy"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# List ssh certificate authority policies members specified by member id.
res = client.get_ssh_certificate_authority_policies_members(member_ids=['83efe671-3265-af1e-6dd2-c9ff155c2a18'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list only members with a specific policy by id
res = client.get_ssh_certificate_authority_policies_members(policy_ids=["10314f42-020d-7080-8013-000ddt400012"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: filter, limit, offset, sort, continuation_token
# See section "Common Fields" for examples

patch_ssh_certificate_authority_policies

from pypureclient.flashblade.FB_2_14 import SshCertificateAuthorityPolicy, ReferenceWritable


certificate = ReferenceWritable(name='external', resource_type='certificates')
policy_attr = SshCertificateAuthorityPolicy(signing_authority=certificate,
                                            static_authorized_principals=["user1", "user2"])
res = client.patch_ssh_certificate_authority_policies(names=["test-policy"], policy=policy_attr)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

public_key_by_id = ReferenceWritable(id='83efe671-3265-af1e-6dd2-c9ff15533a19', resource_type='public-keys')
policy_attr = SshCertificateAuthorityPolicy(signing_authority=public_key_by_id,
                                            static_authorized_principals=[])
# update the policy with id '83efe671-3265-af1e-6dd2-c9ff155c2a18'
res = client.patch_ssh_certificate_authority_policies(ids=['83efe671-3265-af1e-6dd2-c9ff155c2a18'],
                                                      policy=policy_attr)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    res_items = (list(res.items))
    print(res_items)

# Other valid fields: ids
# See section "Common Fields" for examples

post_ssh_certificate_authority_policies

from pypureclient.flashblade.FB_2_14 import SshCertificateAuthorityPolicyPost, Reference

# create the ssh certificate authority policy with a reference to the existing certificate
certificate = Reference(name='external', resource_type='certificates')
policy_attr = SshCertificateAuthorityPolicyPost(signing_authority=certificate,
                                                static_authorized_principals=["user1", "user2"])
res = client.post_ssh_certificate_authority_policies(names=["test-policy"], policy=policy_attr)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# create the ssh certificate authority policy with a different signing authority, also
# omitting the principals list.
public_key_by_id = Reference(id='83efe671-3265-af1e-6dd2-c9ff15533a19', resource_type='public-keys')
policy_attr_with_key = SshCertificateAuthorityPolicyPost(signing_authority=public_key_by_id)
res = client.post_ssh_certificate_authority_policies(names=['ca-policy-with-key-reference'],
                                                     policy=policy_attr_with_key)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    res_items = (list(res.items))
    print(res_items)

Policies Tls

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

delete_network_interfaces_tls_policies

# remove a policy from a network interface by name
client.delete_network_interfaces_tls_policies(
    member_names=["datavip1"], policy_names=["strong-tls"])

# remove a policy from a network interface by id
client.delete_network_interfaces_tls_policies(
    member_ids=["10314f42-020d-7080-8013-000ddt400090"], policy_ids=["10314f42-020d-7080-8013-000ddt400012"])

get_network_interfaces_tls_policies

# list TLS policies for network interfaces
res = client.get_network_interfaces_tls_policies()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list TLS policies for specific network interface
res = client.get_network_interfaces_tls_policies(member_names=["datavip1"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list TLS policies for specific network interface by id
res = client.get_network_interfaces_tls_policies(member_ids=["10314f42-020d-7080-8013-000ddt400090"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list only network interfaces belonging to a specific policy by name
res = client.get_network_interfaces_tls_policies(policy_names=["strong-tls-policy"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list only network interfaces with a specific policy by id
res = client.get_network_interfaces_tls_policies(policy_ids=["10314f42-020d-7080-8013-000ddt400012"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: continuation_token, filter, limit, offset, sort
# See section "Common Fields" for examples

post_network_interfaces_tls_policies

# add a policy to a network interface by name
client.post_network_interfaces_tls_policies(
    member_names=["datavip1"], policy_names=["strong-tls"])

# add a policy to a network interface by id
client.post_network_interfaces_tls_policies(
    member_ids=["10314f42-020d-7080-8013-000ddt400090"], policy_ids=["10314f42-020d-7080-8013-000ddt400012"])

delete_tls_policies

# delete a TLS policy by name
tls_policy_name = 'example_policy'
res = client.delete_tls_policies(names=[tls_policy_name])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# delete a TLS policy by id
tls_policy_id = '10314f42-020d-7080-8013-000ddt400013'
res = client.delete_tls_policies(ids=[tls_policy_id])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

get_tls_policies

# get all TLS Policies
res = client.get_tls_policies()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# get a TLS Policy by name
res = client.get_tls_policies(names=['test_tls_policy'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# get a TLS Policy by id
res = client.get_tls_policies(ids=['10314f42-020d-7080-8013-000ddt400013'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# evaluate and retrieve the effective ciphers for a TLS policy
res = client.get_tls_policies(names=['test_tls_policy'], effective=True)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# get the details of purity_defined "default" values in policies
res = client.get_tls_policies(purity_defined=True)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: filter, limit, offset, sort, continuation_token
# See section "Common Fields" for examples

get_tls_policies_members

# list TLS policies for members
res = client.get_tls_policies_members()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list TLS policies for specific member
res = client.get_tls_policies_members(member_names=["datavip1"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list TLS policies for specific member by id
res = client.get_tls_policies_members(member_ids=["10314f42-020d-7080-8013-000ddt400090"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list only members belonging to a specific policy by name
res = client.get_tls_policies_members(policy_names=["strong-tls-policy"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list only members with a specific policy by id
res = client.get_tls_policies_members(policy_ids=["10314f42-020d-7080-8013-000ddt400012"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: continuation_token, filter, limit, offset, sort
# See section "Common Fields" for examples

delete_tls_policies_network_interfaces

# remove a policy from a network interface by name
client.delete_tls_policies_network_interfaces(
    member_names=["datavip1"], policy_names=["strong-tls"])

# remove a policy from a network interface by id
client.delete_tls_policies_network_interfaces(
    member_ids=["10314f42-020d-7080-8013-000ddt400090"], policy_ids=["10314f42-020d-7080-8013-000ddt400012"])

get_tls_policies_network_interfaces

# list TLS policies for network interfaces
res = client.get_tls_policies_network_interfaces()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list TLS policies for specific network interface
res = client.get_tls_policies_network_interfaces(member_names=["datavip1"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list TLS policies for specific network interface by id
res = client.get_tls_policies_network_interfaces(member_ids=["10314f42-020d-7080-8013-000ddt400090"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list only network interfaces belonging to a specific policy by name
res = client.get_tls_policies_network_interfaces(policy_names=["strong-tls-policy"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list only network interfaces with a specific policy by id
res = client.get_tls_policies_network_interfaces(policy_ids=["10314f42-020d-7080-8013-000ddt400012"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: continuation_token, filter, limit, offset, sort
# See section "Common Fields" for examples

post_tls_policies_network_interfaces

# add a policy to a network interface by name
client.post_tls_policies_network_interfaces(
    member_names=["datavip1"], policy_names=["strong-tls"])

# add a policy to a network interface by id
client.post_tls_policies_network_interfaces(
    member_ids=["10314f42-020d-7080-8013-000ddt400090"], policy_ids=["10314f42-020d-7080-8013-000ddt400012"])

patch_tls_policies

from pypureclient.flashblade.FB_2_17 import TlsPolicy, Reference

# update a TLS policy object with the desired settings
# note that name field is NOT specified during creation
# the policy is enabled by default. specifying an appliance certificate is mandatory,
# but other fields are optional and have default values
appliance_certificate = Reference(name='new-identity-to-clients')
tls_policy = TlsPolicy(
    appliance_certificate=appliance_certificate,
    min_tls_version='1.2',
    enabled_tls_ciphers=['TLS_CHACHA20_POLY1305_SHA256', 'AESGCM'],
    disabled_tls_ciphers=['SHA'],
    enabled=True
)
tls_policy_name = 'example_policy'
res = client.patch_tls_policies(names=[tls_policy_name], policy=tls_policy)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# policies can also be updated by id
tls_policy_id = '10314f42-020d-7080-8013-000ddt400013'
res = client.patch_tls_policies(ids=[tls_policy_id], policy=tls_policy)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

post_tls_policies

from pypureclient.flashblade.FB_2_17 import TlsPolicy, Reference

# create a TLS policy object with the desired settings
# note that name field is NOT specified during creation
# the policy is enabled by default. specifying an appliance certificate is mandatory,
# but other fields are optional and have default values
appliance_certificate = Reference(name='identity-to-clients')
tls_policy = TlsPolicy(
    appliance_certificate=appliance_certificate,
    min_tls_version='1.2',
    enabled_tls_ciphers=['default'],
    disabled_tls_ciphers=['TLS_CHACHA20_POLY1305_SHA256', 'SHA']
)
tls_policy_name = 'example_policy'
res = client.post_tls_policies(names=[tls_policy_name], policy=tls_policy)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

Policies Worm Data

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

delete_worm_data_policies

# Delete a WORM data policy
res = client.delete_worm_data_policies(names=['worm-policy-name'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: context_names, ids
# See section "Common Fields" for examples

get_worm_data_policies

# Get all WORM data policies
res = client.get_worm_data_policies()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# get a WORM data policy
res = client.get_worm_data_policies(names=['policy-name'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# get a WORM data policy by id
res = client.get_worm_data_policies(ids=['10314f42-020d-7080-8013-000ddt400013'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: allow_errors, context_names, filter, limit, offset, sort, continuation_token
# See section "Common Fields" for examples

get_worm_data_policies_members

# Get all WORM data policy members
res = client.get_worm_data_policies_members()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list by policy name
res = client.get_worm_data_policies_members(
    policy_names=['test-policy-name']
)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list by member name
res = client.get_worm_data_policies_members(
    member_names=['member-name']
)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list by policy ids
res = client.get_worm_data_policies_members(
    policy_ids=['10314f42-0120d-7080-8013-000ddt400013']
)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list by member ids
res = client.get_worm_data_policies_members(
    member_ids=['10314f42-020d-7080-8013-000ddt400014']
)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: allow_errors, context_names, filter, limit, offset, sort, continuation_token
# See section "Common Fields" for examples

patch_worm_data_policies

from pypureclient.flashblade.FB_2_17 import WormDataPolicy

# update a WORM data policy
policy_body = WormDataPolicy(
    enabled=True, retention_lock='unlocked', mode='compliance',
    min_retention=1000, max_retention=10000, default_retention=5000)

res = client.patch_worm_data_policies(names=['worm-policy-name'],
                                      policy=policy_body)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    res_items = (list(res.items))
    print(res_items)

# Other valid fields: context_names, ids
# See section "Common Fields" for examples

post_worm_data_policies

from pypureclient.flashblade.FB_2_17 import WormDataPolicy

# create a WORM data policy
policy_body = WormDataPolicy(
    enabled=True, retention_lock='unlocked', mode='compliance',
    min_retention=1000, max_retention=10000, default_retention=5000)

res = client.post_worm_data_policies(names=['worm-policy-name'],
                                     policy=policy_body)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    res_items = (list(res.items))
    print(res_items)

# Other valid fields: context_names
# See section "Common Fields" for examples

Policies All

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

get_policies_all

# list all policies of all types
res = client.get_policies_all()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Valid fields: allow_errors, context_names, continuation_token, filter, ids, limit, names, offset, sort
# See section "Common Fields" for examples

get_policies_all_members

# list all policy/member pairs (for all policy types)
res = client.get_policies_all_members()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# assume we have a policy named "p1", and a file system named "myfs"
res = client.get_policies_all_members(policy_names=["p1"],
                                      member_names=["myfs"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
res = client.get_policies_all_members(policy_names=["p1"],
                                      member_names=["myfs"],
                                      remote_names=["myremote"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# assume we have a policy named "p1", and a file system snapshot named "myfs.1"
res = client.get_policies_all_members(policy_names=["p1"],
                                      member_names=["myfs.1"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list and sort by name in descendant order
res = client.get_policies_all_members(limit=5, sort="policy.name-")
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list with page size 5
res = client.get_policies_all_members(limit=5)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list all remaining policies
res = client.get_policies_all_members(continuation_token=res.continuation_token)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list only members with a specific policy by id
res = client.get_policies_all_members(policy_ids=["10314f42-020d-7080-8013-000ddt400012"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: allow_errors, context_names, filter, local_file_system_ids, local_file_system_names,
#               member_ids, member_types, offset, remote_ids, remote_file_system_ids, remote_file_system_names
# See section "Common Fields" for examples

Public Keys

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

delete_public_keys

# delete public key named "test-key"
client.delete_public_keys(names=['test-key'])

# Other valid fields: ids
# See section "Common Fields" for examples

get_public_keys

# list all public keys
res = client.get_public_keys()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list keys by providing key names
res = client.get_public_keys(names=['ad-key-1', 'some-other-key'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: continuation_token, filter, ids, limit, offset, sort
# See section "Common Fields" for examples

post_public_keys

from pypureclient.flashblade.FB_2_14 import PublicKeyPost

key = 'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQCxlwM29F5T4V+rfKt0sxa25/WVYvNCzzIx8K4BkFDgcOMg3i0Cui4KvDRZ1uVuOxINmjIxEXWNIF/kJh0upMebvsjW11y5pIcqgIQBIDG3vT/xS/6FNCUI+d9Uv8qEyty0OBrDkqmRYxMjlVt4P7RQyRhbIKVEFVr1MeuL3besqLBmtQCIfZDa/rvcmrtMpA6eD//kfISwVUr1qvR41b3iBHwYPaU6D+hWlv1dqcGZ3eNJfGrfx2V02mnhn7y15pr7eUtUhY90gVt6YopnH8o56HC+UBxbzQx6qmKefRyoZSV2DFKYghrIpTouV3SF27db5u/umCvbrN+LDUbQkMscJpNg+FKXy7vPA03rzeXu02+F1B9mLGTDB/eNwbNGyREWndV5gdMexPidffG099/DUPs1f+t5PhnURPoN9GaOjb18mkWDeystxmfaQZs5DMFNwj5aerqZZsucaKuFixsaCh+D+SczjFAjzbq8HG7zwLGnYMx0Tqe09bPbSGrmC5s= example2@purestorage.com'
key_body = PublicKeyPost(public_key=key)
res = client.post_public_keys(names=['rsa-key'], public_key=key_body)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

get_public_keys_uses

# list all public keys uses
res = client.get_public_keys_uses()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list key uses by providing key names
res = client.get_public_keys_uses(names=['ad-key-1', 'some-other-key'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: continuation_token, filter, ids, limit, offset, sort
# See section "Common Fields" for examples

Quotas

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

delete_quotas_groups

# Assume you have a file system named quotaFs
file_system_name = "quotaFs"

# Delete the quotas of groups on the file system with ids 998 and 999
client.delete_quotas_groups(file_system_names=[file_system_name], gids=[998, 999])

# Delete the quotas of groups on the file system with names group1 and group2
client.delete_quotas_groups(file_system_names=[file_system_name],
                            group_names=["group1", "group2"])

# Other valid fields: context_names, file_system_ids, names
# See section "Common Fields" for examples

get_quotas_groups

# List all group quotas for the file system
res = client.get_quotas_groups(file_system_names=["quotaFs"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: allow_errors, context_names, continuation_token, file_system_ids, filter, gids, group_names,
#                     limit, names, offset, sort
# See section "Common Fields" for examples

patch_quotas_groups

from pypureclient.flashblade import GroupQuota

file_system_name = "quotaFs"

# Update the quota for the groups with with ids 998 and 999 to be 2048000
res = client.patch_quotas_groups(file_system_names=[file_system_name],
                                 gids=[998, 999],
                                 quota=GroupQuota(quota=2048000))
# print the created quotas
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Update the quota for the groups with names group1 and group2 to be 1024000
res = client.patch_quotas_groups(file_system_names=[file_system_name],
                                 group_names=["group1", "group2"],
                                 quota=GroupQuota(quota=1024000))
# print the updated quotas
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: context_names, file_system_ids, names
# See section "Common Fields" for examples

post_quotas_groups

from pypureclient.flashblade import GroupQuota

file_system_name = "quotaFs"

# Add a quota of 1024000 for the file system to apply to the groups with ids 998 and 999
res = client.post_quotas_groups(file_system_names=[file_system_name], gids=[998, 999],
                                quota=GroupQuota(quota=1024000))
# print the created quotas
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Add a quota of 2048000 for the file system to apply to the groups with names group1 and group2
res = client.post_quotas_groups(file_system_names=[file_system_name],
                                group_names=["group1", "group2"],
                                quota=GroupQuota(quota=2048000))
# print the created quotas
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: context_names, file_system_ids
# See section "Common Fields" for examples

get_quotas_settings

# check the contact info being sent to end users and groups regarding their quotas, and
# check if direct notifications to them are enabled
res = client.get_quotas_settings()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: ids, names
# See section "Common Fields" for examples

patch_quotas_settings

from pypureclient.flashblade import QuotaSetting

# set our contact info to a person and their email, and enable direct notification of
# users and groups regarding their quotas
new_contact = 'John Doe - j.doe@mycompany.com'
update_settings = QuotaSetting(contact=new_contact, direct_notifications_enabled=True)
res = client.patch_quotas_settings(quota_setting=update_settings)
# print the result of our update for record keeping
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

delete_quotas_users

# Assume you have a file system named quotaFs
file_system_name = "quotaFs"

# Delete the quotas of users on the file system with ids 123 and 124
client.delete_quotas_users(file_system_names=[file_system_name], uids=[123, 124])

# Delete the quotas of users on the file system with names user1 and user2
client.delete_quotas_users(file_system_names=[file_system_name],
                           user_names=["user1", "user2"])

# Other valid fields: context_names, file_system_ids, names
# See section "Common Fields" for examples

get_quotas_users

# List all user quotas for the file system
res = client.get_quotas_users(file_system_names=["quotaFs"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: allow_errors, context_names, continuation_token, file_system_ids,
#                     filter, limit, names, offset, sort, uids, user_names
# See section "Common Fields" for examples

patch_quotas_users

from pypureclient.flashblade import UserQuota

file_system_name = "quotaFs"
# Update the quota for users with ids 123 and 124 to be 2048 bytes
res = client.patch_quotas_users(file_system_names=[file_system_name],
                                uids=[123, 124],
                                quota=UserQuota(quota=2048))
# print the updated quotas
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Update the quota for users with names user1 and user2 to be 1024 bytes
res = client.patch_quotas_users(file_system_names=[file_system_name],
                                user_names=["user1", "user2"],
                                quota=UserQuota(quota=1024))
# print the updated quotas
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: context_names, file_system_ids, names
# See section "Common Fields" for examples

post_quotas_users

from pypureclient.flashblade import UserQuota

file_system_name = "quotaFs"

# Add a quota of 1024 for the file system to apply to the users with ids 123 and 124
res = client.post_quotas_users(file_system_names=[file_system_name], uids=[123, 124],
                               quota=UserQuota(quota=1024))
# print the created quotas
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Add a quota of 2048 for the file system to apply to the users with names user1 and user2
res = client.post_quotas_users(file_system_names=[file_system_name],
                               user_names=["user1", "user2"],
                               quota=UserQuota(quota=2048))
# print the created quotas
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: context_names, file_system_ids
# See section "Common Fields" for examples

Rdl

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

get_rapid_data_locking

# List Rapid Data Locking configuration
res = client.get_rapid_data_locking()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

patch_rapid_data_locking

from pypureclient.flashblade import RapidDataLocking, Reference

# Enable Rapid Data Locking

kmip_server_name = 'kmip-server-1'
kmip_server_ref = Reference(name=kmip_server_name, resource_type="kmip")

create_body = RapidDataLocking(enabled=True, kmip_server=kmip_server_ref)
res = client.patch_rapid_data_locking(rapid_data_locking=create_body)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

post_rapid_data_locking_rotate

# Rotate the external RDL key
res = client.post_rapid_data_locking_rotate()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

get_rapid_data_locking_test

# Test Rapid Data Locking
res = client.get_rapid_data_locking_test()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

Remote Arrays

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

get_remote_arrays

# list remote arrays
res = client.get_remote_arrays(current_fleet_only=True)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: continuation_token, filter, ids, limit, names, offset, sort, total_only
# See section "Common Fields" for examples

Roles

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

get_roles

# list all roles
res = client.get_roles()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list role for readonly user
res = client.get_roles(names=["readonly"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: continuation_token, ids, filter, limit, offset, sort
# See section "Common Fields" for examples

Saml2 Sso

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

delete_sso_saml2_idps

# Delete an SSO SAML2 configuration by name.
res = client.delete_sso_saml2_idps(names=['test-sso'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Delete an SSO SAML2 configuration by ID.
res = client.delete_sso_saml2_idps(ids=['10314f42-020d-7080-8013-000ddt400012'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

get_sso_saml2_idps

# Get all SSO SAML2 configurations
res = client.get_sso_saml2_idps()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Get an SSO SAML2 configuration by name
res = client.get_sso_saml2_idps(names=['test-sso'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Get an SSO SAML2 configuration by ID
res = client.get_sso_saml2_idps(ids=['10314f42-020d-7080-8013-000ddt400012'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: filter, limit, offset, sort, continuation_token
# See section "Common Fields" for examples

patch_sso_saml2_idps

from pypureclient.flashblade.FB_2_17 import Saml2Sso, Saml2SsoIdp, Reference

# Update an SSO SAML2 configuration
idp = Saml2SsoIdp(entity_id='http://test-entity-id',
                  url='https://test-sso-url',
                  metadata_url='https://test-metadata-url',
                  metadata_url_ca_certificate=Reference(name='metadata-url-ca-cert', resource_type='certificates'),
                  metadata_url_ca_certificate_group=Reference(name='metadata-url-ca-cert-group', resource_type='certificate_groups'),
                  encrypt_assertion_enabled=True)
sso = Saml2Sso(enabled=True, array_url='https://test-array-url', idp=idp, services=['object'], binding='none')
res = client.patch_sso_saml2_idps(names=['test-sso'], idp=sso)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    res_items = (list(res.items))
    print(res_items)

# Other valid fields: ids
# See section "Common Fields" for examples

post_sso_saml2_idps

from pypureclient.flashblade.FB_2_17 import Saml2SsoPost, Saml2SsoIdp, Reference

# create a SSO SAML2 configuration
idp = Saml2SsoIdp(entity_id='http://test-entity-id',
                  url='https://test-sso-url',
                  metadata_url='https://test-metadata-url',
                  metadata_url_ca_certificate=Reference(name='metadata-url-ca-cert', resource_type='certificates'),
                  metadata_url_ca_certificate_group=Reference(name='metadata-url-ca-cert-group', resource_type='certificate_groups'),
                  encrypt_assertion_enabled=True)
sso = Saml2SsoPost(enabled=True, array_url='https://test-array-url', idp=idp, services=['object'], binding='none')
res = client.post_sso_saml2_idps(names=['test-sso'], idp=sso)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    res_items = (list(res.items))
    print(res_items)

get_sso_saml2_idps_test

# Get all SSO SAML2 configurations test results
res = client.get_sso_saml2_idps_test()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Get an SSO SAML2 configuration test results by name
res = client.get_sso_saml2_idps_test(names=['test-sso'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Get an SSO SAML2 configuration test results by ID
res = client.get_sso_saml2_idps_test(ids=['10314f42-020d-7080-8013-000ddt400012'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: filter, limit, sort
# See section "Common Fields" for examples

patch_sso_saml2_idps_test

from pypureclient.flashblade.FB_2_DEV import Saml2Sso, Saml2SsoIdp, Saml2SsoSp, Reference

# Update an SSO SAML2 configuration test
verification_cert = Reference(name='verification-cert', resource_type='certificates')
signing_cert = Reference(name='signing-cert', resource_type='certificates')
decryption_cert = Reference(name='decryption-cert', resource_type='certificates')
idp = Saml2SsoIdp(entity_id='http://test-entity-id',
                  url='https://test-sso-url',
                  metadata_url='https://test-metadata-url',
                  sign_request_enabled=True,
                  encrypt_assertion_enabled=True,
                  verification_certificate=verification_cert)
sp = Saml2SsoSp(signing_credential=signing_cert,
                decryption_credential=decryption_cert)
sso = Saml2Sso(enabled=True, array_url='https://test-array-url', idp=idp, sp=sp)
res = client.patch_sso_saml2_idps_test(names=['test-sso'], idp=sso)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    res_items = (list(res.items))
    print(res_items)

# Other valid fields: ids
# See section "Common Fields" for examples

Servers

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

delete_servers

# Delete servers
# Please note: cascade_delete parameter is required
res = client.delete_servers(names=['myserver'], cascade_delete='directory-services')

# Other valid fields: ids, references
# See section "Common Fields" for examples

get_servers

# List Servers
res = client.get_servers()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: allow_errors, context_names, continuation_token, filter, ids, limit, names, offset, sort, references
# See section "Common Fields" for examples

patch_servers

from pypureclient.flashblade import Server, Reference

# update dns configuration of server with name 'myserver'
dns_list = [Reference(name="mydns")]
res = client.patch_servers(names=["myserver"], server=Server(dns=dns_list))
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: ids, references
# See section "Common Fields" for examples

post_servers

from pypureclient.flashblade import ServerPost

# post the server object myserver on the array
# Please note: create_ds parameter is required and it is value should be <server-name>_nfs
attr = ServerPost()
res = client.post_servers(names=["myserver"], server=attr, create_ds="myserver_nfs")
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

Sessions

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

get_sessions

# list user login events performed in the Purity//FB GUI, CLI, and REST API.
res = client.get_sessions()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: continuation_token, filter, ids, limit, names, offset, sort
# See section "Common Fields" for examples

SMTP

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

get_smtp_servers

res = client.get_smtp_servers() # The SMTP properties are related to alert routing
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Valid fields: continuation_token, filter, ids, limit, names, offset, sort
# See section "Common Fields" for examples

patch_smtp_servers

from pypureclient.flashblade import SmtpServer

# Update the SMTP server settings to use the specified relay host, sender domain and encryption mode
smtp_settings = SmtpServer(relay_host="test-host.com", sender_domain="purestorage.com", encryption_mode="starttls")
res = client.patch_smtp_servers(smtp=smtp_settings)

# print the updated SMTP server settings
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

SNMP Agents

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

get_snmp_agents

# list the array's snmp agents
res = client.get_snmp_agents()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: continuation_token, filter, ids, limit, names, offset, sort
# See section "Common Fields" for examples

get_snmp_agents_mib

# list the array's SNMP agent MIB
res = client.get_snmp_agents_mib()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

patch_snmp_agents

from pypureclient.flashblade import SnmpV3, SnmpAgent, SnmpV2c

# update the snmp agent using snmpv2c to use snmpv3 with v3 attributes
# there is only one snmp agent on the system
new_v3_attrs = SnmpV3(auth_protocol='SHA', auth_passphrase='my-password-1!',
                      privacy_protocol='AES', privacy_passphrase='min8chars',
                      user='service-account-1')
agent_v3_update_attrs = SnmpAgent(version='v3', v3=new_v3_attrs)
# updating the agent to use v3 instead of v2c will automatically clear out v2c
# attributes
res = client.patch_snmp_agents(snmp_agent=agent_v3_update_attrs)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# update an snmp agent using snmpv3 to use snmpv2c with v2c attributes
new_v2_attrs = SnmpV2c(community='community-for-informs-and-traps')
agent_v2c_update_attrs = SnmpAgent(version='v2c', v2c=new_v2_attrs)
# updating the agent to use v2c instead of v3 will automatically clear out v3
# attributes
res = client.patch_snmp_agents(snmp_agent=agent_v2c_update_attrs)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

SNMP Managers

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

delete_snmp_managers

# delete the snmp manager with the name 'my-v3-manager'
manager_name = 'my-v3-manager'
client.delete_snmp_managers(names=[manager_name])

# list all snmp managers using v2c as their snmp version and then delete them, thus cleaning
# up managers on older versions
version_filter_string = '(version="v2c")'
res = client.get_snmp_managers(filter=version_filter_string)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    items = list(res.items)
    print(items)
    for snmp_manager in items:
        name_to_delete = snmp_manager.name
        client.delete_snmp_managers(names=[name_to_delete])

# Other valid fields: ids
# See section "Common Fields" for examples

get_snmp_managers

# list all snmp managers
res = client.get_snmp_managers()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list the snmp manager with the name 'my-v3-manager'
manager_name = 'my-v3-manager'
res = client.get_snmp_managers(names=[manager_name])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list all snmp managers using v3 as their snmp version
version_filter_string = '(version="v3")'
res = client.get_snmp_managers(filter=version_filter_string)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list all snmp managers sorting by host
sort_string = 'host'
res = client.get_snmp_managers(sort=sort_string)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: continuation_token, ids, limit, offset
# See section "Common Fields" for examples

patch_snmp_managers

from pypureclient.flashblade import SnmpV3, SnmpManager, SnmpV2c

# update an snmp trap manager using snmpv2c with the name 'my-manager' to use snmpv3
# with v3 attributes
new_v3_attrs = SnmpV3(auth_protocol='SHA', auth_passphrase='my-password-1!',
                      privacy_protocol='AES', privacy_passphrase='min8chars',
                      user='service-account-1')
manager_v3_update_attrs = SnmpManager(version='v3', v3=new_v3_attrs)
existing_manager_name = 'my-v3-manager'
# updating the manager to use v3 instead of v2c will automatically clear out v2c
# attributes
res = client.patch_snmp_managers(names=[existing_manager_name],
                                 snmp_manager=manager_v3_update_attrs)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# update an snmp trap manager using snmpv3 with the name 'my-manager-2' to use snmpv2c
# with v2c attributes
new_v2_attrs = SnmpV2c(community='community-for-informs-and-traps')
manager_v2c_update_attrs = SnmpManager(version='v2c', v2c=new_v2_attrs)
existing_manager_name = 'my-v2c-manager'
# updating the manager to use v2c instead of v3 will automatically clear out v3
# attributes
res = client.patch_snmp_managers(names=[existing_manager_name],
                                 snmp_manager=manager_v2c_update_attrs)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: ids
# See section "Common Fields" for examples

post_snmp_managers

from pypureclient.flashblade import SnmpV3, SnmpManagerPost, SnmpV2c

snmp_host = 'snmphost1.example.gov'
# create an snmp trap manager using snmpv3 with the name 'my-v3-manager' and appropriate
# v3 attributes
v3_attrs = SnmpV3(auth_protocol='SHA', auth_passphrase='my-password-1!',
                  privacy_protocol='AES', privacy_passphrase='min8chars',
                  user='service-account-1')
new_v3_manager = SnmpManagerPost(host=snmp_host, notification='trap',
                                 version='v3', v3=v3_attrs)
v3_manager_name = 'my-v3-manager'
res = client.post_snmp_managers(names=[v3_manager_name],
                                snmp_manager=new_v3_manager)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# create an snmp inform manager using snmpv2c with the name 'my-v2c-manager' and appropriate
# v2c attributes
v2_attrs = SnmpV2c(community='some-community-for-informs')
new_v2c_manager = SnmpManagerPost(host=snmp_host, notification='inform',
                                  version='v2c', v2c=v2_attrs)
v2c_manager_name = 'my-v2c-manager'
res = client.post_snmp_managers(names=[v2c_manager_name],
                                snmp_manager=new_v2c_manager)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

get_snmp_managers_test

# test the snmp manager with the name 'my-v3-manager'
manager_name = 'my-v3-manager'
res = client.get_snmp_managers_test(names=[manager_name])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# test the snmp manager with the id '10314f42-020d-7080-8013-000ddt400090'
manager_id = '10314f42-020d-7080-8013-000ddt400090'
res = client.get_snmp_managers_test(ids=[manager_id])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: continuation_token, filter, limit, offset, sort
# See section "Common Fields" for examples

Software

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

get_software_check

# Get all software check
res = client.get_software_check()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# get by names
res = client.get_software_check(names=['1'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# get by ids
res = client.get_software_check(ids=['4ed534f8-e47e-cd29-25f0-841811266ba3'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# get by software_versions
res = client.get_software_check(software_versions='5.0.0')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# get by software_names
res = client.get_software_check(software_names="Purity//FB")
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: softwares, filter, limit, offset, sort, total_item_count
# See section "Common Fields" for examples

post_software_check

# post the software check
res = client.post_software_check(software_versions=["10.0.0"], software_names=["Purity//FB"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: softwares
# See section "Common Fields" for examples

Subnets

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

delete_subnets

# delete a subnet with name myobjsubnet
client.delete_subnets(names=["mysubnet"])

# Other valid fields: ids
# See section "Common Fields" for examples

get_subnets

# list all subnets
res = client.get_subnets()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list and sort by name in descendant order
res = client.get_subnets(limit=5, sort="name-")
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list with page size 5
res = client.get_subnets(limit=5)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list all remaining subnets
res = client.get_subnets(continuation_token=res.continuation_token)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list with filter
res = client.get_subnets(filter='(services=\'replication\')')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: ids, names, offset
# See section "Common Fields" for examples

patch_subnets

from pypureclient.flashblade import Subnet

# update a subnet's gateway by name
res = client.patch_subnets(
    names=['mysubnet'], subnet=Subnet(gateway='1.2.3.1'))
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: ids
# See section "Common Fields" for examples

post_subnets

from pypureclient.flashblade import Subnet

# post the subnet object mysubnet on the array
res = client.post_subnets(names=["mysubnet"],
                          subnet=Subnet(prefix='1.2.3.0/24'))
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

Support

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

get_support

res = client.get_support()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Valid fields: ids, names
# See section "Common Fields" for examples

patch_support

from pypureclient.flashblade import Support

# update support settings to enable phonehome and set a proxy
proxy = 'http://proxy.example.com:8080'
phonehome_enabled = True
support_settings_updates = Support(proxy=proxy, phonehome_enabled=phonehome_enabled)
res = client.patch_support(support=support_settings_updates)
# print our response containing our updates
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# open a remote assist session
remote_assist_active = True
remote_assist_duration = 24 * 60 * 60 * 1000  # 24 hours in milliseconds
open_ra_settings = Support(remote_assist_active=remote_assist_active, remote_assist_duration=remote_assist_duration)
res = client.patch_support(support=open_ra_settings)
# print our response, which will now have the time that our remote assist session was opened
# and when it will expire
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

get_support_test

# Test phonehome
res = client.get_support_test(test_type='phonehome')
# print the results
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Test remote assist
res = client.get_support_test(test_type='remote-assist')
# print the results
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Test both
res = client.get_support_test()
# print the results
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: filter, sort
# See section "Common Fields" for examples

Support Diagnostics

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

get_support_diagnostics_details

# Get all support diagnostics details
res = client.get_support_diagnostics_details()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

#get by name
res = client.get_support_diagnostics_details(names=['3'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# get by id
res = client.get_support_diagnostics_details(ids=['4ed534f8-e47e-cd29-25f0-841811266ba3'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: filter, limit, offset, sort, continuation_token
# See section "Common Fields" for examples

get_support_diagnostics

# Get all support diagnostics
res = client.get_support_diagnostics()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

#get by name
res = client.get_support_diagnostics(names=['3'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# get by id
res = client.get_support_diagnostics(ids=['4ed534f8-e47e-cd29-25f0-841811266ba3'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: filter, limit, offset, sort, continuation_token
# See section "Common Fields" for examples

post_support_diagnostics

# post the support diagnostics
res = client.post_support_diagnostics(analysis_period_start_time=0, analysis_period_end_time=0)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# See section "Common Fields" for examples

Syslog

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

delete_syslog_servers

# Delete the syslog server named "syslog_old"
client.delete_syslog_servers(names=["main_syslog"])

# Other valid fields: ids
# See section "Common Fields" for examples

get_syslog_servers

# List all configured syslog servers
res = client.get_syslog_servers()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# List first two syslog servers beginning with 'main_syslog'. Use default sorting.
res = client.get_syslog_servers(limit=2, names=["main_syslog"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))    # List the first syslog server when sorting by name.
res = client.get_syslog_servers(limit=1, sort="name")
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# List all syslog servers using TCP connections
res = client.get_syslog_servers(filter='uri=\'tcp*\'')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: allow_errors, context_names, continuation_token, filter, ids, offset
# See section "Common Fields" for examples

patch_syslog_servers

from pypureclient.flashblade.FB_2_17 import SyslogServerPatch

# Update the uri of the server named "main_syslog" and update the services field
attr = SyslogServerPatch(uri='tcp://new_syslog_host.domain.com:541')
attr.services = ['data-audit','management']
res = client.patch_syslog_servers(syslog_server=attr, names=["main_syslog"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: ids
# See section "Common Fields" for examples

post_syslog_servers

from pypureclient.flashblade.FB_2_17 import SyslogServerPost

# Post a syslog server using a TCP connection
attr = SyslogServerPost(uri='tcp://my_syslog_host.domain.com:541')
attr.services = ['data-audit']
res = client.post_syslog_servers(syslog_server=attr, names=["main_syslog"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Post a syslog server using a UDP connection
udp_attr = SyslogServerPost(uri='udp://my_syslog_host.domain.com:540')
attr.services = ['data-audit']
res = client.post_syslog_servers(syslog_server=udp_attr, names=["my_udp_connection"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

get_syslog_servers_settings

# List the current syslog server settings
res = client.get_syslog_servers_settings()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: continuation_token, filter, ids, limit, names, offset, sort
# See section "Common Fields" for examples

patch_syslog_servers_settings

from pypureclient.flashblade import SyslogServerSettings, Reference

# Assuming a certificate named "syslog_server_cert" has already been uploaded to the array,
# retrieve that certificate by name and configure it to be used to authenticate the
# connection with syslog servers.
cert_name = 'syslog_server_cert'
cert_res = client.get_certificates(names=[cert_name])
cert_item = list(cert_res.items)[0]
# Build a Reference using information from the certificate GET result
cert_reference = Reference(name=cert_item.name, id=cert_item.id, resource_type='certificates')
attr = SyslogServerSettings(ca_certificate=cert_reference)
res = client.patch_syslog_servers_settings(syslog_server_settings=attr)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: names, ids
# See section "Common Fields" for examples

get_syslog_servers_test

# Log two test messages to each configured syslog server.
res = client.get_syslog_servers_test()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: continuation_token
# See section "Common Fields" for examples

Targets

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

delete_targets

# delete the target with the name 'target'
client.delete_targets(names=['target'])

# delete the target with the id '10314f42-020d-7080-8013-000ddt400090'
client.delete_targets(ids=['10314f42-020d-7080-8013-000ddt400090'])

get_targets

# list all targets
res = client.get_targets()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list first three targets using default sort
res = client.get_targets(limit=3)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list first three targets and sort by address
res = client.get_targets(limit=3, sort='address')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list all remaining targets
res = client.get_targets(continuation_token=res.continuation_token)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# list with filter to see only targets that match a specific ip format
res = client.get_targets(filter='name=\'12.56.23.*\'')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: allow_errors, context_names, ids, names, offset
# See section "Common Fields" for examples

patch_targets

from pypureclient.flashblade import Target

# Change the name of an existing target to "remote2"
# Change the address of an existing target to "1.1.1.1"
new_attr = Target(name='remote2',
                  address='1.1.1.1')
# Update the existing target that's named 'remote1' with our new attributes
res = client.patch_targets(names=['remote1'], target=new_attr)
print(res)

# Update the existing target that has the id '10314f42-020d-7080-8013-000ddt400090' with our new attributes
res = client.patch_targets(ids=['10314f42-020d-7080-8013-000ddt400090'], target=new_attr)
print(res)

get_targets_performance_replication

# list instantaneous replication performance for all targets
res = client.get_targets_performance_replication()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list instantaneous replication performance for target with id '10314f42-020d-7080-8013-000ddt400090'
res = client.get_targets_performance_replication(ids=['10314f42-020d-7080-8013-000ddt400090'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list historical performance for all targets between some
# start time and end time
res = client.get_targets_performance_replication(
    start_time=START_TIME,
    end_time=END_TIME,
    resolution=30000)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list historical performance for target 's3target1' between some
# start time and end time
res = client.get_targets_performance_replication(
    start_time=START_TIME,
    end_time=END_TIME,
    resolution=30000,
    names=['s3target1'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# total instantaneous performance across 2 targets
res = client.get_targets_performance_replication(names=['s3target1', 's3target2'],
                                                 total_only=True)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: continuation_token, filter, limit, offset, sort
# See section "Common Fields" for examples

post_targets

from pypureclient.flashblade import TargetPost

# create a target by hostname name
name = "target"
hostname = "my.target.com"
target = TargetPost(address=hostname)
# post the target object on the array
res = client.post_targets(names=[name], target=target)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# create a target by ip address
name = "target2"
address = "1.1.1.1"
target = TargetPost(address=address)
# post the target object on the array
res = client.post_targets(names=[name], target=target)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

Usage

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

get_usage_groups

# List usage for all groups that have space used on usageFs
res = client.get_usage_groups(file_system_names=["usageFs"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: allow_errors, context_names, continuation_token, file_system_ids, filter, gids,
#                     group_names, limit, offset, sort
# See section "Common Fields" for examples

get_usage_users

# List usage for all users who have space used on usageFs
res = client.get_usage_users(file_system_names=["usageFs"])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: allow_errors, context_names, continuation_token, file_system_ids, filter, uids,
#                     user_names, limit, offset, sort
# See section "Common Fields" for examples

Verification Keys

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

get_support_verification_keys

# List the Challenge Response Verification Key for the array
res = client.get_support_verification_keys()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: continuation_token, limit, offset, sort, filter
# See section "Common Fields" for examples

patch_support_verification_keys

from pypureclient.flashblade import VerificationKeyPatch

# Update the signed Verification Key for the array
signed_public_key_text = """-----BEGIN PUBLIC KEY-----
MIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEArSe6chh1JzME9svOKjU0
eKTm8S23Ok3Vr2bWuPri/YHfLrlnRwWoCt+st0/BebKSJ+fQUWOaLlqpZQKpI8oR
gJ9sWmwGibVG8cTuz7XMkskx9bsm/bjIenuB4W+s3g0BCsi9930mfdKgJgFzY69O
nLh7d7hAFcmhSJa945PryQZpvJ/U4Ue5F4d+WXgEJ0SoSRaZ6bbeMPhcbMHTzTum
2ZrPBkK5cqPYitaso6BXeAlqNQPw4Kbu4Ugm0CTogrtImkwoonWDDP34XMOq+u7q
sNTbJSvDKMTM1RPPrTWCaLiuZkdLVEVesZ9/8+XUMIgBTElwQJDCAQer03MJzqRr
1eCZGgLfDuYqwMG2MFaAX7kgqBwwyqRTd6MxaQxt2nkdfwiXSY71llzEQ23g3T+1
64zjwAL5f+dtu8PkGF7IdU2T8P2Qk9bG9pckwZHWYkBK77BAk5jbmSzsKGZgRb2R
1E+TWDKIaveFhQp251j/C5wkZwMXgjOzN+BOPo+OiLBGUl+jRybWA9f7Vq1MEdf6
SEdLiqYrXcZERkYBMieLXAfdtaztAIb96cUu+OKMSLDk+D0GHkUfm7lEbDK3ew1+
D6z+BnxDyH6oqZzz4lS2kPLBLsc+6pdTGuKLf0S9YuLiqJe659AdwU8+X/3KtwNd
FVJSaxdFbWx0nj3hJqFkIO8CAwEAAQ==
-----END PUBLIC KEY-----"""
res = client.patch_support_verification_keys(key=VerificationKeyPatch(signed_verification_key=signed_public_key_text))
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))