FlashBlade Reference

Client

FlashBlade REST Client Factory Method

Importable as

from pypureclient.flashblade import Client

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

Initialize a FlashBlade Client.

Keyword Arguments

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

• version (str, optional) – REST API version to use. Defaults to the most recent version supported by both the client and the target array.

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

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

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

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

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

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

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

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

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

• 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

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[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, local_only: Optional[StrictBool] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE active-directory

Delete an Active Directory account.

Parameters

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

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_admins(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE admins

Delete a local administrator..

Parameters

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

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_admins_api_tokens(admins: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, admin_ids: Optional[ConstrainedListValue[StrictStr]] = None, admin_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE admins/api-tokens

Deletes the API tokens of the specified administrators.

Parameters

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

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_admins_cache(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE admins/cache

Delete cached administrator role information by name or ID.

Parameters

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

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_admins_ssh_certificate_authority_policies(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE admins/ssh-certificate-authority-policies

Remove a SSH Certificate Authority policy from a specific user.

Parameters

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

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

• x_request_id (str) – Supplied by client during request or generated by server.

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

• member_names (List[str]) – A comma-separated list of member names.

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

• policy_names (List[str]) – A comma-separated list of policy names.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_alert_watchers(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE alert-watchers

Delete an alert watcher.

Parameters

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

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_api_clients(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE api-clients

Delete the API client.

Parameters

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

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_array_connections(remotes: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE array-connections

Delete a connection to an array.

Parameters

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

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids keyword argument.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

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

• remote_ids (List[str]) – A comma-separated list of remote array IDs. 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]) – A comma-separated 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) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_arrays_factory_reset_token(x_request_id: Optional[StrictStr] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Delete a factory reset token

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

Parameters

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_arrays_ssh_certificate_authority_policies(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE admins/settings/ssh-certificate-authority-policies

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

Parameters

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

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

• x_request_id (str) – Supplied by client during request or generated by server.

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

• member_names (List[str]) – A comma-separated list of member names.

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

• policy_names (List[str]) – A comma-separated list of policy names.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_audit_file_systems_policies(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE audit-file-systems-policies

Delete one or more audit policies.

Parameters

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

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_audit_file_systems_policies_members(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE audit-file-systems-policies/members

Remove the audit policy mapped to a file system.

Parameters

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

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

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

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

• member_names (List[str]) – A comma-separated list of member names.

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

• policy_names (List[str]) – A comma-separated list of policy names.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_bucket_replica_links(remotes: Optional[Union[ReferenceType, List[ReferenceType]]] = None, remote_buckets: Optional[Union[ReferenceType, List[ReferenceType]]] = None, local_buckets: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, local_bucket_ids: Optional[ConstrainedListValue[StrictStr]] = None, local_bucket_names: Optional[ConstrainedListValue[StrictStr]] = None, remote_bucket_names: Optional[ConstrainedListValue[StrictStr]] = None, remote_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE bucket-replica-links

Delete a bucket replica link.

Parameters

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

• remote_buckets (ReferenceType or List[ReferenceType], optional) – A list of remote_buckets to query for. Overrides remote_bucket_names keyword argument.

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

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids keyword argument.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

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

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

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_buckets(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE buckets

Delete object store buckets.

Parameters

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

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_buckets_bucket_access_policies(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, buckets: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, bucket_ids: Optional[ConstrainedListValue[StrictStr]] = None, bucket_names: Optional[ConstrainedListValue[StrictStr]] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE buckets/bucket-access-policies

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

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

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

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

• context_names (List[str]) – 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]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_buckets_bucket_access_policies_rules(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, buckets: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, bucket_ids: Optional[ConstrainedListValue[StrictStr]] = None, bucket_names: Optional[ConstrainedListValue[StrictStr]] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE buckets/bucket-access-policies/rules

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

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_names keyword argument.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

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

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

• context_names (List[str]) – 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]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• policy_names (List[str]) – A comma-separated list of policy names.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_buckets_cross_origin_resource_sharing_policies(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, buckets: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, bucket_ids: Optional[ConstrainedListValue[StrictStr]] = None, bucket_names: Optional[ConstrainedListValue[StrictStr]] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE buckets/cross-origin-resource-sharing-policies

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

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

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

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

• context_names (List[str]) – 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]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_buckets_cross_origin_resource_sharing_policies_rules(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, buckets: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, bucket_ids: Optional[ConstrainedListValue[StrictStr]] = None, bucket_names: Optional[ConstrainedListValue[StrictStr]] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE buckets/cross-origin-resource-sharing-policies/rules

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

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_names keyword argument.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

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

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

• context_names (List[str]) – 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]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• policy_names (List[str]) – A comma-separated list of policy names.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_certificate_groups(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE certificate-groups

Delete one or more certificate groups from the array.

Parameters

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

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_certificate_groups_certificates(certificates: Optional[Union[ReferenceType, List[ReferenceType]]] = None, certificate_groups: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, certificate_group_ids: Optional[ConstrainedListValue[StrictStr]] = None, certificate_group_names: Optional[ConstrainedListValue[StrictStr]] = None, certificate_ids: Optional[ConstrainedListValue[StrictStr]] = None, certificate_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE certificate-groups/certificates

Delete one or more certificate groups.

Parameters

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

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

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_certificates(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE certificates

Delete a CA certificate from the array.

Parameters

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

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_certificates_certificate_groups(certificates: Optional[Union[ReferenceType, List[ReferenceType]]] = None, certificate_groups: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, certificate_group_ids: Optional[ConstrainedListValue[StrictStr]] = None, certificate_group_names: Optional[ConstrainedListValue[StrictStr]] = None, certificate_ids: Optional[ConstrainedListValue[StrictStr]] = None, certificate_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE certificates/certificate-groups

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

Parameters

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

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

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_directory_services_roles(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE directory-service/roles

Delete an RBAC group configuration setting for manageability.

Parameters

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

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_dns(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE dns

Deletes a DNS configuration.

Parameters

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

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_file_system_exports(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE file-system-exports

Deletes a file system export.

Parameters

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

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_file_system_replica_links(remotes: Optional[Union[ReferenceType, List[ReferenceType]]] = None, remote_file_systems: Optional[Union[ReferenceType, List[ReferenceType]]] = None, local_file_systems: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, cancel_in_progress_transfers: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, local_file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, local_file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, remote_file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, remote_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE file-system-replica-links

Delete a file system replication link.

Parameters

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

• remote_file_systems (ReferenceType or List[ReferenceType], optional) – A list of remote_file_systems to query for. Overrides remote_file_system_ids and remote_file_system_names keyword arguments.

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

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids keyword argument.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

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

• remote_file_system_ids (List[str]) – A comma-separated list of remote file system IDs. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_file_system_names query parameter.

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

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_file_system_replica_links_policies(remotes: Optional[Union[ReferenceType, List[ReferenceType]]] = None, policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, local_file_systems: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, local_file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, local_file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, remote_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE file-system-replica-links/policies

Remove a policy from a file system replication link.

Parameters

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

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

• members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids keyword argument.

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

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

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

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

• policy_names (List[str]) – A comma-separated list of policy names.

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_file_system_snapshots(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE file-system-snapshots

Delete a file system snapshot.

Parameters

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

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_file_system_snapshots_policies(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE file-system-snapshots/policies

Remove snapshot scheduling policies from a file system.

Parameters

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

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

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

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

• member_names (List[str]) – A comma-separated list of member names.

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

• policy_names (List[str]) – A comma-separated list of policy names.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_file_system_snapshots_transfer(remotes: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, remote_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE file-system-snapshots/transfer

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

Parameters

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

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

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_file_systems(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE file-systems

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

Parameters

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

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_file_systems_audit_policies(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE file-systems/audit-policies

Remove the audit policy mapped to a file system.

Parameters

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

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

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

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

• member_names (List[str]) – A comma-separated list of member names.

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

• policy_names (List[str]) – A comma-separated list of policy names.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_file_systems_locks(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, file_systems: Optional[Union[ReferenceType, List[ReferenceType]]] = None, clients: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, client_names: Optional[ConstrainedListValue[StrictStr]] = None, file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, inodes: Optional[ConstrainedListValue[Union[StrictFloat, StrictInt]]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, paths: Optional[ConstrainedListValue[StrictStr]] = None, recursive: Optional[StrictBool] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Invalidate file locks

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

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

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

• clients (ReferenceType or List[ReferenceType], optional) – A list of clients to query for. Overrides client_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

• inodes (List[float]) – A comma-separated 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]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• paths (List[str]) – A comma-separated 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) – 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) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_file_systems_open_files(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE file-systems/open-files

Close open file from given identifiers.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_file_systems_policies(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE file-systems/policies

Remove a snapshot scheduling policy from a file system.

Parameters

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

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

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

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

• member_names (List[str]) – A comma-separated list of member names.

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

• policy_names (List[str]) – A comma-separated list of policy names.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_file_systems_sessions(users: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, clients: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, client_names: Optional[ConstrainedListValue[StrictStr]] = None, disruptive: Optional[StrictBool] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, protocols: Optional[ConstrainedListValue[StrictStr]] = None, user_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Delete sessions

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

• users (ReferenceType or List[ReferenceType], optional) – A list of users to query for. Overrides user_names keyword argument.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• clients (ReferenceType or List[ReferenceType], optional) – A list of clients to query for. Overrides client_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• client_names (List[str]) – A comma-separated 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) – 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]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• protocols (List[str]) – A comma-separated list of file protocols. Valid values include nfs and smb.

• user_names (List[str]) – A comma-separated list of user names.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_fleets(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE Fleets

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

Parameters

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

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Supports exactly one value.

• names (List[str]) – Performs the operation on the unique resource names specified. Supports exactly one value.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_fleets_members(members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, unreachable: Optional[StrictBool] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Remove fleet members

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 (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

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

• member_names (List[str]) – A comma-separated list of member names.

• unreachable (bool) – 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) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_keytabs(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE keytabs

Delete a Kerberos keytab file.

Parameters

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

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_kmip(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Delete a KMIP server configuration

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

Parameters

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

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_legal_holds(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Delete a legal hold

Delete a legal hold instance. Deletion is not allowed if the legal hold is applied to one or more paths.

Parameters

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

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_lifecycle_rules(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, buckets: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, bucket_ids: Optional[ConstrainedListValue[StrictStr]] = None, bucket_names: Optional[ConstrainedListValue[StrictStr]] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE lifecycle-rules

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

Parameters

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

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

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

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_link_aggregation_groups(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE link-aggregation-groups

Remove a link aggregation group to unbind the ports.

Parameters

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

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_maintenance_windows(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Delete maintenance window

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

Parameters

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

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_network_access_policies_rules(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, versions: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE network-access-policies/rules

Delete one or more network access policy rules.

Parameters

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

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_network_interfaces(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE network-interfaces

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 (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_network_interfaces_tls_policies(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE network-interfaces/tls-policies

Remove a TLS policy from a network interface.

Parameters

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

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

• x_request_id (str) – Supplied by client during request or generated by server.

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

• member_names (List[str]) – A comma-separated list of member names.

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

• policy_names (List[str]) – A comma-separated list of policy names.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_nfs_export_policies(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, versions: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE nfs-export-policies

Delete one or more NFS export policies.

Parameters

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

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_nfs_export_policies_rules(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, versions: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE nfs-export-policies/rules

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

Parameters

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

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_object_store_access_keys(names: ConstrainedListValue[StrictStr], contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE object-store-access-keys

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

Parameters

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

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_object_store_access_policies(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE object-store-access-policies

Delete one or more access policies.

Parameters

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

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_object_store_access_policies_object_store_roles(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE object-store-access-policies/object-store-roles

Revoke an object store role’s access policy.

Parameters

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

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

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

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

• member_names (List[str]) – A comma-separated list of member names.

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

• policy_names (List[str]) – A comma-separated list of policy names.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_object_store_access_policies_object_store_users(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE object-store-access-policies/object-store-users

Revokes an object store user’s access policy.

Parameters

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

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

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

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

• member_names (List[str]) – A comma-separated list of member names.

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

• policy_names (List[str]) – A comma-separated list of policy names.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_object_store_access_policies_rules(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE object-store-access-policies-rules

Delete one or more access policy rules.

Parameters

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

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

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

• policy_names (List[str]) – A comma-separated list of policy names.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_object_store_accounts(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE object-store-accounts

Delete an object store account.

Parameters

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

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_object_store_remote_credentials(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE object-store-remote-credentials

Delete object store remote credentials.

Parameters

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

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_object_store_roles(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE object-store-roles

Delete existing object store roles.

Parameters

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

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_object_store_roles_object_store_access_policies(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE object-store-roles/object-store-access-policies

Revoke an object store role’s access policy.

Parameters

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

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

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

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

• member_names (List[str]) – A comma-separated list of member names.

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

• policy_names (List[str]) – A comma-separated list of policy names.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_object_store_roles_object_store_trust_policies_rules(roles: Optional[Union[ReferenceType, List[ReferenceType]]] = None, policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, indices: Optional[ConstrainedListValue[StrictInt]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, role_ids: Optional[ConstrainedListValue[StrictStr]] = None, role_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE object-store-roles/object-store-trust-policies/rules

Delete one or more trust policy rules.

Parameters

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

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_names keyword argument.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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]) – A comma-separated 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]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• policy_names (List[str]) – A comma-separated list of policy names.

• role_ids (List[str]) – A comma-separated 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]) – A comma-separated 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) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_object_store_users(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE object-store-users

Delete an object store user.

Parameters

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

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_object_store_users_object_store_access_policies(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE object-store-users/object-store-access-policies

Revoke an object store user’s access policy.

Parameters

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

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

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

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

• member_names (List[str]) – A comma-separated list of member names.

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

• policy_names (List[str]) – A comma-separated list of policy names.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_object_store_virtual_hosts(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE object-store-virtual-hosts

Delete an object store virtual host.

Parameters

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

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_policies(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE policies

Delete one or more snapshot scheduling policies.

Parameters

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

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_policies_file_system_replica_links(remotes: Optional[Union[ReferenceType, List[ReferenceType]]] = None, policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, local_file_systems: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, local_file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, local_file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, remote_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE policies/file-system-replica-links

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

Parameters

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

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

• members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids keyword argument.

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

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

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

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

• policy_names (List[str]) – A comma-separated list of policy names.

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_policies_file_system_snapshots(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE policies/file-system-snapshots

Remove the snapshot scheduling policy mapped to a file system.

Parameters

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

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

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

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

• member_names (List[str]) – A comma-separated list of member names.

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

• policy_names (List[str]) – A comma-separated list of policy names.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_policies_file_systems(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE policies/file-systems

Remove the snapshot scheduling policy mapped to a file system.

Parameters

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

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

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

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

• member_names (List[str]) – A comma-separated list of member names.

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

• policy_names (List[str]) – A comma-separated list of policy names.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_public_keys(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Delete public key configurations

Deletes public key configurations.

Parameters

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

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_qos_policies(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE qos-policies

Delete a QoS policy.

Parameters

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

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_quotas_groups(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, groups: Optional[Union[ReferenceType, List[ReferenceType]]] = None, file_systems: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, gids: Optional[ConstrainedListValue[StrictInt]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE quotas/groups

Delete a hard limit quota for a group.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• groups (ReferenceType or List[ReferenceType], optional) – A list of groups to query for. Overrides group_names keyword argument.

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

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

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

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_quotas_users(users: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, file_systems: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, uids: Optional[ConstrainedListValue[StrictInt]] = None, user_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE quotas/users

Delete a hard limit file system quota for a user.

Parameters

• users (ReferenceType or List[ReferenceType], optional) – A list of users to query for. Overrides user_names keyword argument.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

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

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

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

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_servers(cascade_delete: ConstrainedListValue[StrictStr], references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE servers

Delete a server.

Parameters

• cascade_delete (List[str]) – 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. (required)

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

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_smb_client_policies(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE smb-client-policies

Delete one or more SMB Client policies.

Parameters

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

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_smb_client_policies_rules(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, versions: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE smb-client-policies/rules

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

Parameters

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

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_smb_share_policies(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE smb-share-policies

Delete one or more SMB Share policies.

Parameters

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

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_smb_share_policies_rules(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE smb-share-policies/rules

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

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

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

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

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

• policy_names (List[str]) – A comma-separated list of policy names.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_snmp_managers(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE snmp-managers

Remove an SNMP manager.

Parameters

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

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_ssh_certificate_authority_policies(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Delete SSH Certificate Authority configurations

Deletes SSH Certificate Authority configurations.

Parameters

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

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_ssh_certificate_authority_policies_admins(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE ssh-certificate-authority-policies/admins

Remove a SSH Certificate Authority policy from a specific user.

Parameters

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

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

• x_request_id (str) – Supplied by client during request or generated by server.

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

• member_names (List[str]) – A comma-separated list of member names.

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

• policy_names (List[str]) – A comma-separated list of policy names.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_ssh_certificate_authority_policies_arrays(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE ssh-certificate-authority-policies/arrays

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

Parameters

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

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

• x_request_id (str) – Supplied by client during request or generated by server.

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

• member_names (List[str]) – A comma-separated list of member names.

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

• policy_names (List[str]) – A comma-separated list of policy names.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_sso_oidc_idps(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Delete OIDC SSO configurations

Delete OIDC SSO configurations.

Parameters

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

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_sso_saml2_idps(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Delete SAML2 SSO configurations

Deletes SAML2 SSO configurations.

Parameters

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

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_subnets(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE subnets

Remove an array subnet.

Parameters

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

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_syslog_servers(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE syslog-servers

Delete a configured syslog server and stop forwarding syslog messages.

Parameters

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

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_targets(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE targets

Delete the connection to the target for replication.

Parameters

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

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_tls_policies(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Delete TLS policies

Deletes TLS policies.

Parameters

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

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_tls_policies_network_interfaces(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE tls-policies/network-interfaces

Remove a TLS policy from a network interface.

Parameters

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

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

• x_request_id (str) – Supplied by client during request or generated by server.

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

• member_names (List[str]) – A comma-separated list of member names.

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

• policy_names (List[str]) – A comma-separated list of policy names.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

delete_worm_data_policies(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

DELETE worm-data-policies

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

Parameters

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

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

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[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET active-directory

List Active Directory accounts and their configuration.

Parameters

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

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

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

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

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

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_active_directory_test(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET active-directory/test

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

Parameters

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

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

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

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_admins(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, expose_api_token: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET admins

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

Parameters

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

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

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

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

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

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

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_admins_api_tokens(admins: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, admin_ids: Optional[ConstrainedListValue[StrictStr]] = None, admin_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, expose_api_token: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET admins/api-tokens

Displays API tokens for the specified administrators.

Parameters

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

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

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

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

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

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

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_admins_cache(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, refresh: Optional[StrictBool] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET admins/cache

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

Parameters

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

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

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

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

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

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

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_admins_settings(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

List global admin settings

Return global admin settings.

Parameters

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

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

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_admins_ssh_certificate_authority_policies(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET admins/ssh-certificate-authority-policies

List SSH Certificate Authority policies mapped to specific users.

Parameters

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

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

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

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

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

• member_names (List[str]) – A comma-separated list of member names.

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

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

• policy_names (List[str]) – A comma-separated list of policy names.

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_alert_watchers(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET alert-watchers

List alert watchers that are configured to receive alert messages.

Parameters

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

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

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

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

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

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_alert_watchers_test(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET alert-watchers/test

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

Parameters

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

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_alerts(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET alerts

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

Parameters

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

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

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

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

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

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_api_clients(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET api-clients

List an API client and its configuration attributes.

Parameters

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

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

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

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

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

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_array_connections(remotes: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, remote_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET array-connections

List connected arrays for replication.

Parameters

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

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids keyword argument.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

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

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

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

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

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

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_array_connections_connection_key(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET array-connections/connection-key

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

Parameters

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

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

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

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

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

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_array_connections_path(remotes: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, remote_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET array-connections/path

List network path details of connected arrays.

Parameters

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

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids keyword argument.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

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

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

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

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

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

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_array_connections_performance_replication(remotes: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, end_time: Optional[ConstrainedIntValue] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, remote_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_names: Optional[ConstrainedListValue[StrictStr]] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[ConstrainedIntValue] = None, total_only: Optional[StrictBool] = None, type: Optional[StrictStr] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET array-connections/performance/replication

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

Parameters

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

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

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

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

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

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

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

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

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

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

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

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_arrays(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET arrays

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

Parameters

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

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

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_arrays_clients_performance(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_only: Optional[StrictBool] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET clients-performance

List NFS client I/O performance metrics.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

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

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_arrays_eula(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET arrays/eula

List the End User Agreement and signature.

Parameters

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

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

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_arrays_factory_reset_token(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

List factory reset tokens

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

Parameters

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

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

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_arrays_http_specific_performance(contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, end_time: Optional[ConstrainedIntValue] = None, resolution: Optional[ConstrainedIntValue] = None, start_time: Optional[ConstrainedIntValue] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET arrays/http-specific-performance

List the HTTP performance metrics of the array.

Parameters

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – When the time window ends (in milliseconds since epoch).

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_arrays_nfs_specific_performance(contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, end_time: Optional[ConstrainedIntValue] = None, resolution: Optional[ConstrainedIntValue] = None, start_time: Optional[ConstrainedIntValue] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET arrays/nfs-specific-performance

List the NFS performance metrics of the array.

Parameters

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – When the time window ends (in milliseconds since epoch).

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_arrays_performance(contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, end_time: Optional[ConstrainedIntValue] = None, protocol: Optional[StrictStr] = None, resolution: Optional[ConstrainedIntValue] = None, start_time: Optional[ConstrainedIntValue] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET arrays/performance

Lists the overall performance metrics of the array.

Parameters

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – When the time window ends (in milliseconds since epoch).

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

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_arrays_performance_replication(contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, end_time: Optional[ConstrainedIntValue] = None, resolution: Optional[ConstrainedIntValue] = None, start_time: Optional[ConstrainedIntValue] = None, type: Optional[StrictStr] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET arrays/performance/replication

List replication performance metrics.

Parameters

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – When the time window ends (in milliseconds since epoch).

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

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_arrays_s3_specific_performance(contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, end_time: Optional[ConstrainedIntValue] = None, resolution: Optional[ConstrainedIntValue] = None, start_time: Optional[ConstrainedIntValue] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET arrays/s3-specific-performance

List the S3 performance metrics of the array.

Parameters

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – When the time window ends (in milliseconds since epoch).

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_arrays_space(contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, end_time: Optional[ConstrainedIntValue] = None, resolution: Optional[ConstrainedIntValue] = None, start_time: Optional[ConstrainedIntValue] = None, type: Optional[StrictStr] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET arrays/space

List available and used storage space on the array.

Parameters

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – When the time window ends (in milliseconds since epoch).

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

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_arrays_space_storage_classes(storage_classes: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, end_time: Optional[ConstrainedIntValue] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[ConstrainedIntValue] = None, storage_class_names: Optional[ConstrainedListValue[StrictStr]] = None, total_only: Optional[StrictBool] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET arrays/space/storage-classes

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

Parameters

• storage_classes (ReferenceType or List[ReferenceType], optional) – A list of storage_classes to query for. Overrides storage_class_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

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

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

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

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

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

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

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_arrays_ssh_certificate_authority_policies(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET admins/settings/ssh-certificate-authority-policies

List SSH Certificate Authority policies mapped as defaults for admins.

Parameters

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

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

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

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

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

• member_names (List[str]) – A comma-separated list of member names.

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

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

• policy_names (List[str]) – A comma-separated list of policy names.

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_arrays_supported_time_zones(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET arrays/supported-time-zones

List supported time zones for the array.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

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

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

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_audit_file_systems_policies(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET audit-file-systems-policies

Displays a list of audit policies for file systems.

Parameters

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

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

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

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

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

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

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_audit_file_systems_policies_members(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET audit-file-systems-policies/members

List file systems mapped to a audit policy.

Parameters

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

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

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

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

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

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

• member_names (List[str]) – A comma-separated list of member names.

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

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

• policy_names (List[str]) – A comma-separated list of policy names.

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_audits(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET audits

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

Parameters

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

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

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

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

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

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_blades(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_only: Optional[StrictBool] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET blades

List array blade information.

Parameters

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

• x_request_id (str) – Supplied by client during request or generated by server.

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

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

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

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

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

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

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

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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_bucket_replica_links(remotes: Optional[Union[ReferenceType, List[ReferenceType]]] = None, remote_buckets: Optional[Union[ReferenceType, List[ReferenceType]]] = None, local_buckets: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, local_bucket_ids: Optional[ConstrainedListValue[StrictStr]] = None, local_bucket_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, remote_bucket_names: Optional[ConstrainedListValue[StrictStr]] = None, remote_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_only: Optional[StrictBool] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET bucket-replica-links

List bucket replica links for object replication.

Parameters

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

• remote_buckets (ReferenceType or List[ReferenceType], optional) – A list of remote_buckets to query for. Overrides remote_bucket_names keyword argument.

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

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids keyword argument.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

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

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

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• local_bucket_ids (List[str]) – A comma-separated list of local bucket IDs. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the local_bucket_names query parameter.

• local_bucket_names (List[str]) – A comma-separated list of local bucket names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with local_bucket_ids query parameter.

• offset (int) – The offset of the first resource to return from a collection.

• remote_bucket_names (List[str]) – A comma-separated list of remote bucket names. If there is not at least one resource that matches each of the elements, then an error is returned.

• remote_ids (List[str]) – A comma-separated list of remote array IDs. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_names query parameter.

• remote_names (List[str]) – A comma-separated list of remote array names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with remote_ids query parameter.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. The items list will be empty.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_buckets(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_only: Optional[StrictBool] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET buckets

List object store bucket attributes such as creation time and space usage.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. If not set, lists both objects that are destroyed and those that are not destroyed. If object name(s) are specified in the names parameter, then each object referenced must exist. If destroyed is set to true, then each object referenced must also be destroyed. If destroyed is set to false, then each object referenced must also not be destroyed. An error is returned if any of these conditions are not met.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. The items list will be empty.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_buckets_bucket_access_policies(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, buckets: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, bucket_ids: Optional[ConstrainedListValue[StrictStr]] = None, bucket_names: Optional[ConstrainedListValue[StrictStr]] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET buckets/bucket-access-policies

List a policy for the specified bucket and its attributes. Either names or bucket_names/bucket_ids query parameters can be used.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• buckets (ReferenceType or List[ReferenceType], optional) – A list of buckets to query for. Overrides bucket_ids and bucket_names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – A comma-separated list of bucket IDs. If after filtering, there is not at least one resource that matches each of the elements of bucket_ids, then an error is returned. This cannot be provided together with the bucket_names query parameter. This can be provided with the ids query parameter but not with names.

• bucket_names (List[str]) – A comma-separated list of bucket names. If there is not at least one resource that matches each of the elements of bucket_names, then an error is returned. This cannot be provided together with the bucket_ids query parameter. This can be provided with the ids query parameter but not with names.

• context_names (List[str]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_buckets_bucket_access_policies_rules(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, buckets: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, bucket_ids: Optional[ConstrainedListValue[StrictStr]] = None, bucket_names: Optional[ConstrainedListValue[StrictStr]] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET buckets/bucket-access-policies/rules

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

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_names keyword argument.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• buckets (ReferenceType or List[ReferenceType], optional) – A list of buckets to query for. Overrides bucket_ids and bucket_names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – A comma-separated list of bucket IDs. If after filtering, there is not at least one resource that matches each of the elements of bucket_ids, then an error is returned. This cannot be provided together with the bucket_names query parameter. This can be provided with the ids query parameter but not with names.

• bucket_names (List[str]) – A comma-separated list of bucket names. If there is not at least one resource that matches each of the elements of bucket_names, then an error is returned. This cannot be provided together with the bucket_ids query parameter. This can be provided with the ids query parameter but not with names.

• context_names (List[str]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• policy_names (List[str]) – A comma-separated list of policy names.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_buckets_cross_origin_resource_sharing_policies(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, buckets: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, bucket_ids: Optional[ConstrainedListValue[StrictStr]] = None, bucket_names: Optional[ConstrainedListValue[StrictStr]] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET buckets/cross-origin-resource-sharing-policies

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

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• buckets (ReferenceType or List[ReferenceType], optional) – A list of buckets to query for. Overrides bucket_ids and bucket_names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – A comma-separated list of bucket IDs. If after filtering, there is not at least one resource that matches each of the elements of bucket_ids, then an error is returned. This cannot be provided together with the bucket_names query parameter. This can be provided with the ids query parameter but not with names.

• bucket_names (List[str]) – A comma-separated list of bucket names. If there is not at least one resource that matches each of the elements of bucket_names, then an error is returned. This cannot be provided together with the bucket_ids query parameter. This can be provided with the ids query parameter but not with names.

• context_names (List[str]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_buckets_cross_origin_resource_sharing_policies_rules(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, buckets: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, bucket_ids: Optional[ConstrainedListValue[StrictStr]] = None, bucket_names: Optional[ConstrainedListValue[StrictStr]] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET buckets/cross-origin-resource-sharing-policies/rules

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

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_names keyword argument.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• buckets (ReferenceType or List[ReferenceType], optional) – A list of buckets to query for. Overrides bucket_ids and bucket_names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – A comma-separated list of bucket IDs. If after filtering, there is not at least one resource that matches each of the elements of bucket_ids, then an error is returned. This cannot be provided together with the bucket_names query parameter. This can be provided with the ids query parameter but not with names.

• bucket_names (List[str]) – A comma-separated list of bucket names. If there is not at least one resource that matches each of the elements of bucket_names, then an error is returned. This cannot be provided together with the bucket_ids query parameter. This can be provided with the ids query parameter but not with names.

• context_names (List[str]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• policy_names (List[str]) – A comma-separated list of policy names.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_buckets_performance(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, end_time: Optional[ConstrainedIntValue] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[ConstrainedIntValue] = None, total_only: Optional[StrictBool] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET buckets/performance

List performance metrics for a bucket.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• end_time (int) – When the time window ends (in milliseconds since epoch).

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• resolution (int) – The desired ms between samples. Available resolutions may depend on data type, start_time and end_time. In general 1000, 30000, 300000, 1800000, 7200000, and 86400000 are possible values.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• start_time (int) – When the time window starts (in milliseconds since epoch).

• total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. The items list will be empty.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_buckets_s3_specific_performance(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, end_time: Optional[ConstrainedIntValue] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[ConstrainedIntValue] = None, total_only: Optional[StrictBool] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET buckets/s3-specific-performance

List performance metrics specific to S3 operations for a bucket.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• end_time (int) – When the time window ends (in milliseconds since epoch).

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• resolution (int) – The desired ms between samples. Available resolutions may depend on data type, start_time and end_time. In general 1000, 30000, 300000, 1800000, 7200000, and 86400000 are possible values.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• start_time (int) – When the time window starts (in milliseconds since epoch).

• total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. The items list will be empty.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_certificate_groups(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET certificate-groups

Display all array certificate groups.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_certificate_groups_certificates(certificates: Optional[Union[ReferenceType, List[ReferenceType]]] = None, certificate_groups: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, certificate_group_ids: Optional[ConstrainedListValue[StrictStr]] = None, certificate_group_names: Optional[ConstrainedListValue[StrictStr]] = None, certificate_ids: Optional[ConstrainedListValue[StrictStr]] = None, certificate_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET certificate-groups/certificates

List membership associations between groups and certificates on the array.

Parameters

• certificates (ReferenceType or List[ReferenceType], optional) – A list of certificates to query for. Overrides certificate_ids and certificate_names keyword arguments.

• certificate_groups (ReferenceType or List[ReferenceType], optional) – A list of certificate_groups to query for. Overrides certificate_group_ids and certificate_group_names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• certificate_group_ids (List[str]) – A comma-separated list of certificate group ids. If there is not at least one resource that matches each of the elements of certificate_group_ids, then an error is returned. This cannot be provided in conjunction with the certificate_group_names parameter.

• certificate_group_names (List[str]) – A comma-separated list of certificate group names. If there is not at least one resource that matches each of the elements of certificate_group_names, then an error is returned. This cannot be provided in conjunction with the certificate_group_ids parameter.

• certificate_ids (List[str]) – A comma-separated list of certificate ids. If there is not at least one resource that matches each of the elements of certificate_ids, then an error is returned. This cannot be provided in conjunction with the certificate_names parameter.

• certificate_names (List[str]) – A comma-separated list of certificate names. If there is not at least one resource that matches each of the elements of certificate_names, then an error is returned. This cannot be provided in conjunction with the certificate_ids parameter.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_certificate_groups_uses(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET certificate-groups/uses

List how certificate groups are being used and by what.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_certificates(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET certificates

List array certificates and their attributes.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_certificates_certificate_groups(certificates: Optional[Union[ReferenceType, List[ReferenceType]]] = None, certificate_groups: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, certificate_group_ids: Optional[ConstrainedListValue[StrictStr]] = None, certificate_group_names: Optional[ConstrainedListValue[StrictStr]] = None, certificate_ids: Optional[ConstrainedListValue[StrictStr]] = None, certificate_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET certificates/certificate-groups

List membership associations between groups and certificates.

Parameters

• certificates (ReferenceType or List[ReferenceType], optional) – A list of certificates to query for. Overrides certificate_ids and certificate_names keyword arguments.

• certificate_groups (ReferenceType or List[ReferenceType], optional) – A list of certificate_groups to query for. Overrides certificate_group_ids and certificate_group_names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• certificate_group_ids (List[str]) – A comma-separated list of certificate group ids. If there is not at least one resource that matches each of the elements of certificate_group_ids, then an error is returned. This cannot be provided in conjunction with the certificate_group_names parameter.

• certificate_group_names (List[str]) – A comma-separated list of certificate group names. If there is not at least one resource that matches each of the elements of certificate_group_names, then an error is returned. This cannot be provided in conjunction with the certificate_group_ids parameter.

• certificate_ids (List[str]) – A comma-separated list of certificate ids. If there is not at least one resource that matches each of the elements of certificate_ids, then an error is returned. This cannot be provided in conjunction with the certificate_names parameter.

• certificate_names (List[str]) – A comma-separated list of certificate names. If there is not at least one resource that matches each of the elements of certificate_names, then an error is returned. This cannot be provided in conjunction with the certificate_ids parameter.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_certificates_uses(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET certificates/uses

List how certificates are being used and by what.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_directory_services(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET directory-services

List directory service configuration information.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_directory_services_roles(roles: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, role_ids: Optional[ConstrainedListValue[StrictStr]] = None, role_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET directory-service/roles

Return array’s RBAC group configuration settings for manageability.

Parameters

• roles (ReferenceType or List[ReferenceType], optional) – A list of roles to query for. Overrides role_ids and role_names keyword arguments.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the names, role_names, or role_ids query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of names, then an error is returned. This cannot be provided together with the ids, role_names, or role_ids query parameters.

• offset (int) – The offset of the first resource to return from a collection.

• role_ids (List[str]) – A comma-separated list of role_ids. If after filtering, there is not at least one resource that matches each of the elements of role_ids, then an error is returned. This cannot be provided together with the ids, 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]) – A comma-separated list of role_names. If there is not at least one resource that matches each of the elements of role_names, then an error is returned. This cannot be provided together with the ids, 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[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_directory_services_test(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET directory-services/test

Test the configured directory services on the array.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_dns(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET dns

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 (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_drives(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_only: Optional[StrictBool] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET drives

List array drive information.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. The items list will be empty.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_file_system_exports(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET file-system-exports

List one or more file system exports.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_file_system_replica_links(remotes: Optional[Union[ReferenceType, List[ReferenceType]]] = None, remote_file_systems: Optional[Union[ReferenceType, List[ReferenceType]]] = None, local_file_systems: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, local_file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, local_file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, remote_file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, remote_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET file-system-replica-links

List file system replication link.

Parameters

• remotes (ReferenceType or List[ReferenceType], optional) – A list of remotes to query for. Overrides remote_ids and remote_names keyword arguments.

• remote_file_systems (ReferenceType or List[ReferenceType], optional) – A list of remote_file_systems to query for. Overrides remote_file_system_ids and remote_file_system_names keyword arguments.

• local_file_systems (ReferenceType or List[ReferenceType], optional) – A list of local_file_systems to query for. Overrides local_file_system_ids and local_file_system_names keyword arguments.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids keyword argument.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• local_file_system_ids (List[str]) – A comma-separated list of local file system IDs. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the local_file_system_names query parameter.

• local_file_system_names (List[str]) – A comma-separated list of local file system names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with local_file_system_ids query parameter.

• offset (int) – The offset of the first resource to return from a collection.

• remote_file_system_ids (List[str]) – A comma-separated list of remote file system IDs. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_file_system_names query parameter.

• remote_file_system_names (List[str]) – A comma-separated list of remote file system names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_file_system_ids query parameter.

• remote_ids (List[str]) – A comma-separated list of remote array IDs. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_names query parameter.

• remote_names (List[str]) – A comma-separated list of remote array names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with remote_ids query parameter.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_file_system_replica_links_policies(remotes: Optional[Union[ReferenceType, List[ReferenceType]]] = None, remote_file_systems: Optional[Union[ReferenceType, List[ReferenceType]]] = None, policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, local_file_systems: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, local_file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, local_file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, remote_file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, remote_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET file-system-replica-links/policies

List file system replication link policies.

Parameters

• remotes (ReferenceType or List[ReferenceType], optional) – A list of remotes to query for. Overrides remote_ids and remote_names keyword arguments.

• remote_file_systems (ReferenceType or List[ReferenceType], optional) – A list of remote_file_systems to query for. Overrides remote_file_system_ids and remote_file_system_names keyword arguments.

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids keyword argument.

• local_file_systems (ReferenceType or List[ReferenceType], optional) – A list of local_file_systems to query for. Overrides local_file_system_ids and local_file_system_names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• local_file_system_ids (List[str]) – A comma-separated list of local file system IDs. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the local_file_system_names query parameter.

• local_file_system_names (List[str]) – A comma-separated list of local file system names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with local_file_system_ids query parameter.

• member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• offset (int) – The offset of the first resource to return from a collection.

• policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (List[str]) – A comma-separated list of policy names.

• remote_file_system_ids (List[str]) – A comma-separated list of remote file system IDs. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_file_system_names query parameter.

• remote_file_system_names (List[str]) – A comma-separated list of remote file system names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_file_system_ids query parameter.

• remote_ids (List[str]) – A comma-separated list of remote array IDs. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_names query parameter.

• remote_names (List[str]) – A comma-separated list of remote array names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with remote_ids query parameter.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_file_system_replica_links_transfer(remotes: Optional[Union[ReferenceType, List[ReferenceType]]] = None, names_or_owners: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names_or_owner_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, remote_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_only: Optional[StrictBool] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET file-system-replica-links/transfer

List the transfer status details for file system replication.

Parameters

• remotes (ReferenceType or List[ReferenceType], optional) – A list of remotes to query for. Overrides remote_ids and remote_names keyword arguments.

• names_or_owners (ReferenceType or List[ReferenceType], optional) – A list of names_or_owners to query for. Overrides names_or_owner_names keyword argument.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids keyword argument.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names_or_owner_names (List[str]) – A comma-separated list of resource names. Either the names of the snapshots or the owning file systems.

• offset (int) – The offset of the first resource to return from a collection.

• remote_ids (List[str]) – A comma-separated list of remote array IDs. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_names query parameter.

• remote_names (List[str]) – A comma-separated list of remote array names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with remote_ids query parameter.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. The items list will be empty.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_file_system_snapshots(owners: Optional[Union[ReferenceType, List[ReferenceType]]] = None, names_or_owners: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names_or_owner_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, owner_ids: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_only: Optional[StrictBool] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET file-system-snapshots

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

• owners (ReferenceType or List[ReferenceType], optional) – A list of owners to query for. Overrides owner_ids keyword argument.

• names_or_owners (ReferenceType or List[ReferenceType], optional) – A list of names_or_owners to query for. Overrides names_or_owner_names keyword argument.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids keyword argument.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. If not set, lists both objects that are destroyed and those that are not destroyed. If object name(s) are specified in the names parameter, then each object referenced must exist. If destroyed is set to true, then each object referenced must also be destroyed. If destroyed is set to false, then each object referenced must also not be destroyed. An error is returned if any of these conditions are not met.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names_or_owner_names (List[str]) – A comma-separated list of resource names. Either the names of the snapshots or the owning file systems.

• offset (int) – The offset of the first resource to return from a collection.

• owner_ids (List[str]) – A comma-separated list of owning file system IDs. If after filtering, there is not at least one resource that matches each of the elements of owner IDs, then an error is returned. This cannot be provided together with the ids, names_or_owner_names, or names_or_sources query parameters.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. The items list will be empty.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_file_system_snapshots_policies(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET file-system-snapshots/policies

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

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• member_names (List[str]) – A comma-separated list of member names.

• offset (int) – The offset of the first resource to return from a collection.

• policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (List[str]) – A comma-separated list of policy names.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_file_system_snapshots_transfer(names_or_owners: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names_or_owner_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_only: Optional[StrictBool] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET file-system-snapshots/transfer

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

• names_or_owners (ReferenceType or List[ReferenceType], optional) – A list of names_or_owners to query for. Overrides names_or_owner_names keyword argument.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids keyword argument.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names_or_owner_names (List[str]) – A comma-separated list of resource names. Either the names of the snapshots or the owning file systems.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. The items list will be empty.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_file_systems(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_only: Optional[StrictBool] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET file-systems

List one or more file systems on the array.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. If not set, lists both objects that are destroyed and those that are not destroyed. If object name(s) are specified in the names parameter, then each object referenced must exist. If destroyed is set to true, then each object referenced must also be destroyed. If destroyed is set to false, then each object referenced must also not be destroyed. An error is returned if any of these conditions are not met.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. The items list will be empty.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_file_systems_audit_policies(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET file-systems/audit-policies

List file systems mapped to a audit policy.

Parameters

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• member_names (List[str]) – A comma-separated list of member names.

• offset (int) – The offset of the first resource to return from a collection.

• policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (List[str]) – A comma-separated list of policy names.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_file_systems_groups_performance(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, groups: Optional[Union[ReferenceType, List[ReferenceType]]] = None, file_systems: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, filter: Optional[StrictStr] = None, gids: Optional[ConstrainedListValue[StrictStr]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_only: Optional[StrictBool] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET file-systems/groups/performance

List a group’s I/O performance metrics on a file system.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• groups (ReferenceType or List[ReferenceType], optional) – A list of groups to query for. Overrides group_names keyword argument.

• file_systems (ReferenceType or List[ReferenceType], optional) – A list of file_systems to query for. Overrides file_system_ids and file_system_names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• file_system_ids (List[str]) – A comma-separated list of file system IDs. If after filtering, there is not at least one resource that matches each of the elements of file_system_ids, then an error is returned. This cannot be provided together with the file_system_names query parameter.

• file_system_names (List[str]) – A comma-separated list of file system names. If there is not at least one resource that matches each of the elements of file_system_names, then an error is returned.

• filter (str) – Exclude resources that don’t match the specified criteria.

• gids (List[str]) – A comma-separated list of group IDs. This cannot be provided together with group_names query parameter.

• group_names (List[str]) – A comma-separated list of group names. This cannot be provided together with gids query parameter.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. The items list will be empty.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_file_systems_locks(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, file_systems: Optional[Union[ReferenceType, List[ReferenceType]]] = None, clients: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, client_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, filter: Optional[StrictStr] = None, inodes: Optional[ConstrainedListValue[Union[StrictFloat, StrictInt]]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, paths: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Get a list of active file locks

Lists all active file locks that satisfy the conditions specified by the parameters.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• file_systems (ReferenceType or List[ReferenceType], optional) – A list of file_systems to query for. Overrides file_system_ids and file_system_names keyword arguments.

• clients (ReferenceType or List[ReferenceType], optional) – A list of clients to query for. Overrides client_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• client_names (List[str]) – A comma-separated 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• file_system_ids (List[str]) – A comma-separated list of file system IDs. If after filtering, there is not at least one resource that matches each of the elements of file_system_ids, then an error is returned. This cannot be provided together with the file_system_names query parameter.

• file_system_names (List[str]) – A comma-separated list of file system names. If there is not at least one resource that matches each of the elements of file_system_names, then an error is returned.

• filter (str) – Exclude resources that don’t match the specified criteria.

• inodes (List[float]) – A comma-separated 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) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• paths (List[str]) – A comma-separated 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) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_file_systems_locks_clients(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Get a list of clients that hold active file locks

Lists all clients that hold active file locks.

Parameters

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_file_systems_open_files(protocols: ConstrainedListValue[StrictStr], users: Optional[Union[ReferenceType, List[ReferenceType]]] = None, sessions: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, file_systems: Optional[Union[ReferenceType, List[ReferenceType]]] = None, clients: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, client_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, paths: Optional[ConstrainedListValue[StrictStr]] = None, session_names: Optional[ConstrainedListValue[StrictStr]] = None, user_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET file-systems/open-files

List open files.

Parameters

• protocols (List[str]) – A comma-separated list of file protocols. Valid values include nfs and smb. (required)

• users (ReferenceType or List[ReferenceType], optional) – A list of users to query for. Overrides user_names keyword argument.

• sessions (ReferenceType or List[ReferenceType], optional) – A list of sessions to query for. Overrides session_names keyword argument.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids keyword argument.

• file_systems (ReferenceType or List[ReferenceType], optional) – A list of file_systems to query for. Overrides file_system_ids and file_system_names keyword arguments.

• clients (ReferenceType or List[ReferenceType], optional) – A list of clients to query for. Overrides client_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• client_names (List[str]) – A comma-separated 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• file_system_ids (List[str]) – A comma-separated list of file system IDs. If after filtering, there is not at least one resource that matches each of the elements of file_system_ids, then an error is returned. This cannot be provided together with the file_system_names query parameter.

• file_system_names (List[str]) – A comma-separated list of file system names. If there is not at least one resource that matches each of the elements of file_system_names, then an error is returned.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• paths (List[str]) – A comma-separated list of paths used for filtering open files query.

• session_names (List[str]) – A comma-separated 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]) – A comma-separated 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) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_file_systems_performance(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, end_time: Optional[ConstrainedIntValue] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, protocol: Optional[StrictStr] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[ConstrainedIntValue] = None, total_only: Optional[StrictBool] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET file-systems/performance

Displays the performance metrics for a file system.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• end_time (int) – When the time window ends (in milliseconds since epoch).

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• protocol (str) – Display the performance of a specified protocol. Valid values are all, HTTP, SMB, NFS, and S3. If not specified, defaults to all, which will provide the combined performance of all available protocols.

• resolution (int) – The desired ms between samples. Available resolutions may depend on data type, start_time and end_time. In general 1000, 30000, 300000, 1800000, 7200000, and 86400000 are possible values.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• start_time (int) – When the time window starts (in milliseconds since epoch).

• total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. The items list will be empty.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_file_systems_policies(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET file-systems/policies

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

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• member_names (List[str]) – A comma-separated list of member names.

• offset (int) – The offset of the first resource to return from a collection.

• policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (List[str]) – A comma-separated list of policy names.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_file_systems_policies_all(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET file-systems/policies-all

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

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• member_names (List[str]) – A comma-separated list of member names.

• offset (int) – The offset of the first resource to return from a collection.

• policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (List[str]) – A comma-separated list of policy names.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_file_systems_sessions(users: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, clients: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, client_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, protocols: Optional[ConstrainedListValue[StrictStr]] = None, user_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Get a list of active sessions

Lists all active sessions that satisfy the conditions specified by the parameters.

Parameters

• users (ReferenceType or List[ReferenceType], optional) – A list of users to query for. Overrides user_names keyword argument.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• clients (ReferenceType or List[ReferenceType], optional) – A list of clients to query for. Overrides client_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• client_names (List[str]) – A comma-separated 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• protocols (List[str]) – A comma-separated list of file protocols. Valid values include nfs and smb.

• user_names (List[str]) – A comma-separated list of user names.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_file_systems_users_performance(users: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, file_systems: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_only: Optional[StrictBool] = None, uids: Optional[ConstrainedListValue[StrictInt]] = None, user_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET file-systems/users/performance

List a user’s I/O performance metrics on a file system.

Parameters

• users (ReferenceType or List[ReferenceType], optional) – A list of users to query for. Overrides user_names keyword argument.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• file_systems (ReferenceType or List[ReferenceType], optional) – A list of file_systems to query for. Overrides file_system_ids and file_system_names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• file_system_ids (List[str]) – A comma-separated list of file system IDs. If after filtering, there is not at least one resource that matches each of the elements of file_system_ids, then an error is returned. This cannot be provided together with the file_system_names query parameter.

• file_system_names (List[str]) – A comma-separated list of file system names. If there is not at least one resource that matches each of the elements of file_system_names, then an error is returned.

• filter (str) – Exclude resources that don’t match the specified criteria.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. The items list will be empty.

• uids (List[int]) – A comma-separated list of user IDs. This cannot be provided together with user_names query parameter.

• user_names (List[str]) – A comma-separated list of user names. This cannot be provided together with uids query parameter.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_file_systems_worm_data_policies(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET file-systems/worm-data-policies

List file systems mapped to a WORM data policy.

Parameters

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• member_names (List[str]) – A comma-separated list of member names.

• offset (int) – The offset of the first resource to return from a collection.

• policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (List[str]) – A comma-separated list of policy names.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_fleets(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_only: Optional[StrictBool] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET fleets

Displays information about the fleets known to the array.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Supports exactly one value.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – Performs the operation on the unique resource names specified. Supports exactly one value.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. The items list will be empty.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_fleets_fleet_key(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_only: Optional[StrictBool] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET fleet-key

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) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. The items list will be empty.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_fleets_members(members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, fleets: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, fleet_ids: Optional[ConstrainedListValue[StrictStr]] = None, fleet_names: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_only: Optional[StrictBool] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET fleet members

Displays the members in the current fleet.

Parameters

• members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

• fleets (ReferenceType or List[ReferenceType], optional) – A list of fleets to query for. Overrides fleet_ids and fleet_names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• fleet_ids (List[str]) – Performs the operation on the unique Fleet IDs specified. This query currently accepts only 1 ID.

• fleet_names (List[str]) – 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) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• member_names (List[str]) – A comma-separated list of member names.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. The items list will be empty.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_hardware(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET hardware

List hardware slots and bays and the status of installed components.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_hardware_connectors(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET hardware-connectors

The endpoint is deprecated. Use the /network-interfaces/connectors endpoint instead. List array connection information.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_hardware_connectors_performance(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, end_time: Optional[ConstrainedIntValue] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[ConstrainedIntValue] = None, total_only: Optional[StrictBool] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET hardware-connectors/performance

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 (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• end_time (int) – When the time window ends (in milliseconds since epoch).

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• resolution (int) – The desired ms between samples. Available resolutions may depend on data type, start_time and end_time. In general 1000, 30000, 300000, 1800000, 7200000, and 86400000 are possible values.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• start_time (int) – When the time window starts (in milliseconds since epoch).

• total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. The items list will be empty.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_keytabs(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET keytabs

List a Kerberos keytab file and its configuration information.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_keytabs_download(keytabs: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, keytab_ids: Optional[ConstrainedListValue[StrictStr]] = None, keytab_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET keytabs/download

Download a Kerberos keytab file. The file can be downloaded in the native binary format or a base64 encoded format. If not specified, defaults to binary.

Parameters

• keytabs (ReferenceType or List[ReferenceType], optional) – A list of keytabs to query for. Overrides keytab_ids and keytab_names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• keytab_ids (List[str]) – A comma-separated list of keytab IDs. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the keytab_names query parameter.

• keytab_names (List[str]) – A comma-separated list of keytab names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with keytab_ids query parameter.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_kmip(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

List KMIP server configurations

Displays a list of KMIP server configurations.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_kmip_test(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Displays KMIP server test results

Displays a detailed result of of KMIP server test.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_legal_holds(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

List legal holds

List legal holds.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_legal_holds_held_entities(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, file_systems: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, paths: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

List held entities

List entities to which a legal hold has been applied.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• file_systems (ReferenceType or List[ReferenceType], optional) – A list of file_systems to query for. Overrides file_system_ids and file_system_names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• file_system_ids (List[str]) – A comma-separated list of file system IDs. If after filtering, there is not at least one resource that matches each of the elements of file_system_ids, then an error is returned. This cannot be provided together with the file_system_names query parameter.

• file_system_names (List[str]) – A comma-separated list of file system names. If there is not at least one resource that matches each of the elements of file_system_names, then an error is returned.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• paths (List[str]) – A comma-separated 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) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_lifecycle_rules(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, buckets: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, bucket_ids: Optional[ConstrainedListValue[StrictStr]] = None, bucket_names: Optional[ConstrainedListValue[StrictStr]] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET lifecycle-rules

Returns a list of lifecycle rules. If names is specified, list the individual rules. If ids is specified, bucket_names or bucket_ids is also required. If bucket_names or bucket_ids are specified without ids, list all the rules for the bucket.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• buckets (ReferenceType or List[ReferenceType], optional) – A list of buckets to query for. Overrides bucket_ids and bucket_names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – A comma-separated list of bucket IDs. If after filtering, there is not at least one resource that matches each of the elements of bucket_ids, then an error is returned. This cannot be provided together with the bucket_names query parameter. This can be provided with the ids query parameter but not with names.

• bucket_names (List[str]) – A comma-separated list of bucket names. If there is not at least one resource that matches each of the elements of bucket_names, then an error is returned. This cannot be provided together with the bucket_ids query parameter. This can be provided with the ids query parameter but not with names.

• context_names (List[str]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_link_aggregation_groups(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET link-aggregation-groups

List the status and attributes of the Ethernet ports in the configured link aggregation groups.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_logs(x_request_id: Optional[StrictStr] = None, end_time: Optional[ConstrainedIntValue] = None, start_time: Optional[ConstrainedIntValue] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET logs

Download a history of log events from the array to provide to Pure Technical Services for analysis.

Parameters

• x_request_id (str) – Supplied by client during request or generated by server.

• end_time (int) – When the time window ends (in milliseconds since epoch).

• start_time (int) – When the time window starts (in milliseconds since epoch).

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_logs_async(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET logs-async

List the attributes and status of preparation for a history of log events from the array to provide to Pure Technical Services for analysis.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_logs_async_download(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET logs-async/download

Download the files which contain a history of log events from the array to provide to Pure Technical Services for analysis.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_maintenance_windows(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

List maintenance window details

Displays maintenance window details, including start time, end time, and maintenance type.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_network_access_policies(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET network-access-policies

Displays a list of network access policies.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_network_access_policies_members(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET network-access-policies/members

List network access policies mapped to different configurations on the array.

Parameters

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• member_names (List[str]) – A comma-separated list of member names.

• offset (int) – The offset of the first resource to return from a collection.

• policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (List[str]) – A comma-separated list of policy names.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_network_access_policies_rules(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET network-access-policies/rules

Displays a list of network access policy rules.

Parameters

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (List[str]) – A comma-separated list of policy names.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_network_interfaces(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET network-interfaces

List network interfaces and their attributes.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_network_interfaces_connectors(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET network-interfaces/connectors

List network connector information

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_network_interfaces_connectors_performance(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, end_time: Optional[ConstrainedIntValue] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[ConstrainedIntValue] = None, total_only: Optional[StrictBool] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET network connectors performance statistics

Displays network statistics, historical bandwidth, and error reporting for all specified network connectors.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• end_time (int) – When the time window ends (in milliseconds since epoch).

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• resolution (int) – The desired ms between samples. Available resolutions may depend on data type, start_time and end_time. In general 1000, 30000, 300000, 1800000, 7200000, and 86400000 are possible values.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• start_time (int) – When the time window starts (in milliseconds since epoch).

• total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. The items list will be empty.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_network_interfaces_connectors_settings(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET global network settings for network connectors

Display the global network settings for network connectors.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_network_interfaces_ping(destination: StrictStr, x_request_id: Optional[StrictStr] = None, component_name: Optional[StrictStr] = None, count: Optional[StrictInt] = None, packet_size: Optional[StrictInt] = None, print_latency: Optional[StrictBool] = None, resolve_hostname: Optional[StrictBool] = None, source: Optional[StrictStr] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET network-interfaces/ping

Display network interface ping result.

Parameters

• destination (str) – A destination specified by user to run the network diagnosis against. Can be a hostname or an IP. (required)

• x_request_id (str) – Supplied by client during request or generated by server.

• component_name (str) – Used by ping and trace to specify where to run the operation. Valid values are controllers and blades from hardware list. If not specified, defaults to all available controllers and selected blades.

• count (int) – Used by ping to specify the number of packets to send. If not specified, defaults to 1.

• packet_size (int) – Used by ping to specify the number of data bytes to be sent per packet. If not specified, defaults to 56.

• print_latency (bool) – Used by ping to specify whether or not to print the full user-to-user latency. If not specified, defaults to false.

• resolve_hostname (bool) – Used by ping and trace to specify whether or not to map IP addresses to host names. If not specified, defaults to true.

• source (str) – Used by ping and trace to specify the property where to start to run the specified operation. The property can be subnet or IP.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_network_interfaces_tls_policies(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET network-interfaces/tls-policies

List network interface TLS policies.

Parameters

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• member_names (List[str]) – A comma-separated list of member names.

• offset (int) – The offset of the first resource to return from a collection.

• policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (List[str]) – A comma-separated list of policy names.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_network_interfaces_trace(destination: StrictStr, x_request_id: Optional[StrictStr] = None, component_name: Optional[StrictStr] = None, discover_mtu: Optional[StrictBool] = None, fragment_packet: Optional[StrictBool] = None, method: Optional[StrictStr] = None, port: Optional[StrictStr] = None, resolve_hostname: Optional[StrictBool] = None, source: Optional[StrictStr] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET network-interfaces/trace

Display network interface trace result.

Parameters

• destination (str) – A destination specified by user to run the network diagnosis against. Can be a hostname or an IP. (required)

• x_request_id (str) – Supplied by client during request or generated by server.

• component_name (str) – Used by ping and trace to specify where to run the operation. Valid values are controllers and blades from hardware list. If not specified, defaults to all available controllers and selected blades.

• discover_mtu (bool) – Used by trace to specify whether or not to discover the MTU along the path being traced. If not specified, defaults to false.

• fragment_packet (bool) – Used by trace to specify whether or not to fragment packets. If not specified, defaults to true.

• method (str) – Used by trace to specify which method to use for trace operations. Valid values are icmp, tcp, and udp. If not specified, defaults to ‘udp’.

• port (str) – Used by trace to specify a destination port.

• resolve_hostname (bool) – Used by ping and trace to specify whether or not to map IP addresses to host names. If not specified, defaults to true.

• source (str) – Used by ping and trace to specify the property where to start to run the specified operation. The property can be subnet or IP.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_nfs_export_policies(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET nfs-export-policies

Displays a list of NFS export policies.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_nfs_export_policies_rules(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET nfs-export-policies/rules

Displays a list of NFS export policy rules. The default sort is by policy name, then index.

Parameters

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (List[str]) – A comma-separated list of policy names.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_object_store_access_keys(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET object-store-access-keys

List object store access keys.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_object_store_access_policies(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, exclude_rules: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET object-store-access-policies

List access policies and their attributes.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• exclude_rules (bool) – If true, the rules field in each policy will be null. If false, each returned policy will include its list of rules in the response. If not specified, defaults to false.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_object_store_access_policies_object_store_roles(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET object-store-access-policies/object-store-roles

List object store roles and their access policies.

Parameters

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• member_names (List[str]) – A comma-separated list of member names.

• offset (int) – The offset of the first resource to return from a collection.

• policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (List[str]) – A comma-separated list of policy names.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_object_store_access_policies_object_store_users(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET object-store-access-policies/object-store-users

List object store users and their access policies.

Parameters

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• member_names (List[str]) – A comma-separated list of member names.

• offset (int) – The offset of the first resource to return from a collection.

• policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (List[str]) – A comma-separated list of policy names.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_object_store_access_policies_rules(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET object-store-access-policies-rules

List access policy rules and their attributes.

Parameters

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (List[str]) – A comma-separated list of policy names.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_object_store_access_policy_actions(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET object-store-access-policy-actions

List valid actions for access policy rules. Each action is either a valid AWS S3 action (prefixed by s3:) or our special wildcard action (s3:*). Each action, when included in a rule, may restrict which other properties may be set for that rule.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_object_store_accounts(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_only: Optional[StrictBool] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET object-store-accounts

List object store accounts and their attributes.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. The items list will be empty.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_object_store_remote_credentials(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET object-store-remote-credentials

List object store remote credentials used by bucket replica links to access buckets on remote arrays or targets.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_object_store_roles(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET object-store-roles

List object store roles and their attributes.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_object_store_roles_object_store_access_policies(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET object-store-roles/object-store-access-policies

List object store roles and their access policies.

Parameters

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• member_names (List[str]) – A comma-separated list of member names.

• offset (int) – The offset of the first resource to return from a collection.

• policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (List[str]) – A comma-separated list of policy names.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_object_store_roles_object_store_trust_policies(roles: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, role_ids: Optional[ConstrainedListValue[StrictStr]] = None, role_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET object-store-roles/object-store-trust-policies

List object store roles and their trust policies.

Parameters

• roles (ReferenceType or List[ReferenceType], optional) – A list of roles to query for. Overrides role_ids and role_names keyword arguments.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• role_ids (List[str]) – A comma-separated 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]) – A comma-separated 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[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_object_store_roles_object_store_trust_policies_download(roles: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, role_ids: Optional[ConstrainedListValue[StrictStr]] = None, role_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET object-store-roles/object-store-trust-policies/download

Download object store roles and their trust policies in native AWS format.

Parameters

• roles (ReferenceType or List[ReferenceType], optional) – A list of roles to query for. Overrides role_ids and role_names keyword arguments.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• role_ids (List[str]) – A comma-separated 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]) – A comma-separated 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) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_object_store_roles_object_store_trust_policies_rules(roles: Optional[Union[ReferenceType, List[ReferenceType]]] = None, policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, indices: Optional[ConstrainedListValue[StrictInt]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, role_ids: Optional[ConstrainedListValue[StrictStr]] = None, role_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET object-store-roles/object-store-trust-policies/rules

List trust policy rules and their attributes.

Parameters

• roles (ReferenceType or List[ReferenceType], optional) – A list of roles to query for. Overrides role_ids and role_names keyword arguments.

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_names keyword argument.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• indices (List[int]) – A comma-separated 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) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• policy_names (List[str]) – A comma-separated list of policy names.

• role_ids (List[str]) – A comma-separated 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]) – A comma-separated 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[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_object_store_users(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET object-store-users

List object store users and their attributes.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_object_store_users_object_store_access_policies(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET object-store-users/object-store-access-policies

List object store users and their access policies.

Parameters

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• member_names (List[str]) – A comma-separated list of member names.

• offset (int) – The offset of the first resource to return from a collection.

• policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (List[str]) – A comma-separated list of policy names.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_object_store_virtual_hosts(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET object-store-virtual-hosts

List object store virtual hosts.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_password_policies(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

List password policies

Displays a list of password policies.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_policies(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET policies

Display snapshot scheduling policies and their attributes.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_policies_all(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET policies-all

List all policies of all types.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_policies_all_members(remotes: Optional[Union[ReferenceType, List[ReferenceType]]] = None, remote_file_systems: Optional[Union[ReferenceType, List[ReferenceType]]] = None, policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, local_file_systems: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, local_file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, local_file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, member_types: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, remote_file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, remote_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET policies-all/members

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

• remotes (ReferenceType or List[ReferenceType], optional) – A list of remotes to query for. Overrides remote_ids and remote_names keyword arguments.

• remote_file_systems (ReferenceType or List[ReferenceType], optional) – A list of remote_file_systems to query for. Overrides remote_file_system_ids and remote_file_system_names keyword arguments.

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

• local_file_systems (ReferenceType or List[ReferenceType], optional) – A list of local_file_systems to query for. Overrides local_file_system_ids and local_file_system_names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• local_file_system_ids (List[str]) – A comma-separated list of local file system IDs. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the local_file_system_names query parameter.

• local_file_system_names (List[str]) – A comma-separated list of local file system names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with local_file_system_ids query parameter.

• member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• member_names (List[str]) – A comma-separated list of member names.

• member_types (List[str]) – A comma-separated list of member types. Valid values are file-systems, file- system-snapshots, file-system-replica-links, and object-store-users. Different endpoints may accept different subsets of these values.

• offset (int) – The offset of the first resource to return from a collection.

• policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (List[str]) – A comma-separated list of policy names.

• remote_file_system_ids (List[str]) – A comma-separated list of remote file system IDs. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_file_system_names query parameter.

• remote_file_system_names (List[str]) – A comma-separated list of remote file system names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_file_system_ids query parameter.

• remote_ids (List[str]) – A comma-separated list of remote array IDs. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_names query parameter.

• remote_names (List[str]) – A comma-separated list of remote array names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with remote_ids query parameter.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_policies_file_system_replica_links(remotes: Optional[Union[ReferenceType, List[ReferenceType]]] = None, remote_file_systems: Optional[Union[ReferenceType, List[ReferenceType]]] = None, policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, local_file_systems: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, local_file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, local_file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, remote_file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, remote_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET policies/file-system-replica-links

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

• remotes (ReferenceType or List[ReferenceType], optional) – A list of remotes to query for. Overrides remote_ids and remote_names keyword arguments.

• remote_file_systems (ReferenceType or List[ReferenceType], optional) – A list of remote_file_systems to query for. Overrides remote_file_system_ids and remote_file_system_names keyword arguments.

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids keyword argument.

• local_file_systems (ReferenceType or List[ReferenceType], optional) – A list of local_file_systems to query for. Overrides local_file_system_ids and local_file_system_names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• local_file_system_ids (List[str]) – A comma-separated list of local file system IDs. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the local_file_system_names query parameter.

• local_file_system_names (List[str]) – A comma-separated list of local file system names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with local_file_system_ids query parameter.

• member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• offset (int) – The offset of the first resource to return from a collection.

• policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (List[str]) – A comma-separated list of policy names.

• remote_file_system_ids (List[str]) – A comma-separated list of remote file system IDs. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_file_system_names query parameter.

• remote_file_system_names (List[str]) – A comma-separated list of remote file system names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_file_system_ids query parameter.

• remote_ids (List[str]) – A comma-separated list of remote array IDs. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_names query parameter.

• remote_names (List[str]) – A comma-separated list of remote array names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with remote_ids query parameter.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_policies_file_system_snapshots(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET policies/file-system-snapshots

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

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• member_names (List[str]) – A comma-separated list of member names.

• offset (int) – The offset of the first resource to return from a collection.

• policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (List[str]) – A comma-separated list of policy names.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_policies_file_systems(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET policies/file-systems

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

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• member_names (List[str]) – A comma-separated list of member names.

• offset (int) – The offset of the first resource to return from a collection.

• policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (List[str]) – A comma-separated list of policy names.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_policies_members(remotes: Optional[Union[ReferenceType, List[ReferenceType]]] = None, remote_file_systems: Optional[Union[ReferenceType, List[ReferenceType]]] = None, policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, local_file_systems: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, local_file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, local_file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, member_types: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, remote_file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, remote_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET policies/members

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

• remotes (ReferenceType or List[ReferenceType], optional) – A list of remotes to query for. Overrides remote_ids and remote_names keyword arguments.

• remote_file_systems (ReferenceType or List[ReferenceType], optional) – A list of remote_file_systems to query for. Overrides remote_file_system_ids and remote_file_system_names keyword arguments.

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

• local_file_systems (ReferenceType or List[ReferenceType], optional) – A list of local_file_systems to query for. Overrides local_file_system_ids and local_file_system_names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• local_file_system_ids (List[str]) – A comma-separated list of local file system IDs. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the local_file_system_names query parameter.

• local_file_system_names (List[str]) – A comma-separated list of local file system names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with local_file_system_ids query parameter.

• member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• member_names (List[str]) – A comma-separated list of member names.

• member_types (List[str]) – A comma-separated list of member types. Valid values are file-systems, file- system-snapshots, file-system-replica-links, and object-store-users. Different endpoints may accept different subsets of these values.

• offset (int) – The offset of the first resource to return from a collection.

• policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (List[str]) – A comma-separated list of policy names.

• remote_file_system_ids (List[str]) – A comma-separated list of remote file system IDs. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_file_system_names query parameter.

• remote_file_system_names (List[str]) – A comma-separated list of remote file system names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_file_system_ids query parameter.

• remote_ids (List[str]) – A comma-separated list of remote array IDs. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_names query parameter.

• remote_names (List[str]) – A comma-separated list of remote array names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with remote_ids query parameter.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_public_keys(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

List public key configurations

List public key configurations.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_public_keys_uses(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET public-keys/uses

List how public keys are being used and by what.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_qos_policies(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET qos-policies

List QoS policies.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_qos_policies_file_systems(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET qos-policies/file-systems

List qos policies and their file system members.

Parameters

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• member_names (List[str]) – A comma-separated list of member names.

• offset (int) – The offset of the first resource to return from a collection.

• policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (List[str]) – A comma-separated list of policy names.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_qos_policies_members(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET qos-policies/members

List qos policies and their managed object members.

Parameters

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• member_names (List[str]) – A comma-separated list of member names.

• offset (int) – The offset of the first resource to return from a collection.

• policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (List[str]) – A comma-separated list of policy names.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_quotas_groups(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, groups: Optional[Union[ReferenceType, List[ReferenceType]]] = None, file_systems: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, filter: Optional[StrictStr] = None, gids: Optional[ConstrainedListValue[StrictInt]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET quotas/groups

List groups with hard limit quotas.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• groups (ReferenceType or List[ReferenceType], optional) – A list of groups to query for. Overrides group_names keyword argument.

• file_systems (ReferenceType or List[ReferenceType], optional) – A list of file_systems to query for. Overrides file_system_ids and file_system_names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• file_system_ids (List[str]) – A comma-separated list of file system IDs. If after filtering, there is not at least one resource that matches each of the elements of file_system_ids, then an error is returned. This cannot be provided together with the file_system_names query parameter.

• file_system_names (List[str]) – A comma-separated list of file system names. If there is not at least one resource that matches each of the elements of file_system_names, then an error is returned.

• filter (str) – Exclude resources that don’t match the specified criteria.

• gids (List[int]) – A comma-separated list of group IDs. If there is not at least one resource that matches each of the elements of gids, then an error is returned. This cannot be provided together with group_names query parameter.

• group_names (List[str]) – A comma-separated list of group names. If there is not at least one resource that matches each of the elements of group_names, then an error is returned. This cannot be provided together with gids query parameter.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_quotas_settings(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET quotas-settings

List notification attributes of a group or user quota.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_quotas_users(users: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, file_systems: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, uids: Optional[ConstrainedListValue[StrictInt]] = None, user_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET quotas/users

List users with hard limit file system quotas.

Parameters

• users (ReferenceType or List[ReferenceType], optional) – A list of users to query for. Overrides user_names keyword argument.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• file_systems (ReferenceType or List[ReferenceType], optional) – A list of file_systems to query for. Overrides file_system_ids and file_system_names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• file_system_ids (List[str]) – A comma-separated list of file system IDs. If after filtering, there is not at least one resource that matches each of the elements of file_system_ids, then an error is returned. This cannot be provided together with the file_system_names query parameter.

• file_system_names (List[str]) – A comma-separated list of file system names. If there is not at least one resource that matches each of the elements of file_system_names, then an error is returned.

• filter (str) – Exclude resources that don’t match the specified criteria.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• uids (List[int]) – A comma-separated list of user IDs. If there is not at least one resource that matches each of the elements of uids, then an error is returned. This cannot be provided together with user_names query parameter.

• user_names (List[str]) – A comma-separated list of user names. If there is not at least one resource that matches each of the elements of user_names, then an error is returned. This cannot be provided together with uids query parameter.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_rapid_data_locking(x_request_id: Optional[StrictStr] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Get the status of the Rapid Data Locking feature.

Displays the status of the Rapid Data Locking feature.

Parameters

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_rapid_data_locking_test(x_request_id: Optional[StrictStr] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Displays Rapid Data Locking test results.

Displays a detailed result of a Rapid Data Locking test.

Parameters

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_remote_arrays(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, current_fleet_only: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_only: Optional[StrictBool] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

List remote arrays

Lists arrays in the current fleet, as well as arrays that the current array has existing replication connections to.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• current_fleet_only (bool) – 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 (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. The items list will be empty.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_roles(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET roles

List roles and permission attributes for role-based access control (RBAC).

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_servers(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET servers

List servers.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_sessions(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

List session data

Displays session data for user login events performed in the Purity//FB GUI, CLI, and REST API.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_smb_client_policies(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET smb-client-policies

Display SMB Client policies and their attributes.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_smb_client_policies_rules(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET smb-client-policies/rules

Displays a list of SMB Client policy rules. The default sort is by policy name, then index.

Parameters

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (List[str]) – A comma-separated list of policy names.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_smb_share_policies(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET smb-share-policies

Display SMB Share policies and their attributes.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_smb_share_policies_rules(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET smb-share-policies/rules

Displays a list of SMB Share policy rules.

Parameters

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (List[str]) – A comma-separated list of policy names.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_smtp_servers(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET smtp-servers

List SMTP server attributes for the array network.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_snmp_agents(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET snmp-agents

List SNMP agent attributes.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_snmp_agents_mib(x_request_id: Optional[StrictStr] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET snmp-agents-mib

List the SNMP MIB text.

Parameters

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_snmp_managers(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET snmp-managers

List SNMP managers and their attributes.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_snmp_managers_test(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET snmp-managers/test

Test if the configuration of an SNMP manager is valid.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_software_check(softwares: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, software_names: Optional[ConstrainedListValue[StrictStr]] = None, software_versions: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

List software check tasks

Displays a list of software check tasks.

Parameters

• softwares (ReferenceType or List[ReferenceType], optional) – A list of softwares to query for. Overrides software_names keyword argument.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• software_names (List[str]) – A comma-separated list of software names.

• software_versions (List[str]) – A comma-separated list of target software versions.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• total_item_count (bool) – 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) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_ssh_certificate_authority_policies(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

List SSH Certificate Authority configurations

List SSH Certificate Authority configurations

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_ssh_certificate_authority_policies_admins(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET ssh-certificate-authority-policies/admins

List SSH Certificate Authority policies mapped to specific users.

Parameters

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• member_names (List[str]) – A comma-separated list of member names.

• offset (int) – The offset of the first resource to return from a collection.

• policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (List[str]) – A comma-separated list of policy names.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_ssh_certificate_authority_policies_arrays(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET ssh-certificate-authority-policies/arrays

List SSH Certificate Authority policies mapped as defaults for admins.

Parameters

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• member_names (List[str]) – A comma-separated list of member names.

• offset (int) – The offset of the first resource to return from a collection.

• policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (List[str]) – A comma-separated list of policy names.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_ssh_certificate_authority_policies_members(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET ssh-certificate-authority-policies/members

List SSH Certificate Authority policies mapped to the admin default settings, or to one or more specific users.

Parameters

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• member_names (List[str]) – A comma-separated list of member names.

• offset (int) – The offset of the first resource to return from a collection.

• policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (List[str]) – A comma-separated list of policy names.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_sso_oidc_idps(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

List OIDC SSO configurations

Displays the OIDC SSO configuration settings in the array.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_sso_saml2_idps(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

List SAML2 SSO configurations

Displays the SAML2 SSO service provider and identity provider configuration settings in the array.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_sso_saml2_idps_test(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET sso/saml2/idps/test

Test the existing SAML2 SSO configurations in the array.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_subnets(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET subnets

List the array’s subnets.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_support(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET support

List Phone Home and Remote Assistance settings.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_support_diagnostics(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET diagnostics list

Lists the support diagnostics tasks.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_support_diagnostics_details(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET diagnostics details

Lists the diagnostics tasks details.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_support_test(x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, test_type: Optional[StrictStr] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET support-test

Test if the Phone Home and Remote Assistance settings are functioning properly.

Parameters

• x_request_id (str) – Supplied by client during request or generated by server.

• filter (str) – Exclude resources that don’t match the specified criteria.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• test_type (str) – Specify the type of test. Valid values are all, phonehome and remote- assist. If not specified, defaults to all.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_support_verification_keys(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET verification-keys

List the key used to verify the signed challenges that are used by Pure Support to access the FlashBlade.

Parameters

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_syslog_servers(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET syslog-servers

Return a list of configured syslog servers.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_syslog_servers_settings(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET syslog-servers/settings

List the certificate or certificate group associated with the syslog servers.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_syslog_servers_test(x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET syslog-servers/test

Send test messages to conifgured remote syslog servers.

Parameters

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_targets(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET targets

List targets used for replication.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_targets_performance_replication(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, end_time: Optional[ConstrainedIntValue] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[ConstrainedIntValue] = None, total_only: Optional[StrictBool] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET targets/performance/replication

List replication performance metrics for targets.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• end_time (int) – When the time window ends (in milliseconds since epoch).

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• resolution (int) – The desired ms between samples. Available resolutions may depend on data type, start_time and end_time. In general 1000, 30000, 300000, 1800000, 7200000, and 86400000 are possible values.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• start_time (int) – When the time window starts (in milliseconds since epoch).

• total_only (bool) – Only return the total record for the specified items. The total record will be the total of all items after filtering. The items list will be empty.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_tls_policies(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, effective: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, purity_defined: Optional[StrictBool] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

List TLS policies

List TLS policies

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• effective (bool) – 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 (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• purity_defined (bool) – 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[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_tls_policies_members(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET tls-policies/members

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

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• member_names (List[str]) – A comma-separated list of member names.

• offset (int) – The offset of the first resource to return from a collection.

• policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (List[str]) – A comma-separated list of policy names.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_tls_policies_network_interfaces(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET tls-policies/network-interfaces

List network interface TLS policies.

Parameters

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• member_names (List[str]) – A comma-separated list of member names.

• offset (int) – The offset of the first resource to return from a collection.

• policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (List[str]) – A comma-separated list of policy names.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_usage_groups(groups: Optional[Union[ReferenceType, List[ReferenceType]]] = None, file_systems: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, filter: Optional[StrictStr] = None, gids: Optional[ConstrainedListValue[StrictInt]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET usage/groups

List groups with hard limit quotas and their file system usage.

Parameters

• groups (ReferenceType or List[ReferenceType], optional) – A list of groups to query for. Overrides group_names keyword argument.

• file_systems (ReferenceType or List[ReferenceType], optional) – A list of file_systems to query for. Overrides file_system_ids and file_system_names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• file_system_ids (List[str]) – A comma-separated list of file system IDs. If after filtering, there is not at least one resource that matches each of the elements of file_system_ids, then an error is returned. This cannot be provided together with the file_system_names query parameter.

• file_system_names (List[str]) – A comma-separated list of file system names. If there is not at least one resource that matches each of the elements of file_system_names, then an error is returned.

• filter (str) – Exclude resources that don’t match the specified criteria.

• gids (List[int]) – A comma-separated list of group IDs. If there is not at least one resource that matches each of the elements of gids, then an error is returned. This cannot be provided together with group_names query parameter.

• group_names (List[str]) – A comma-separated list of group names. If there is not at least one resource that matches each of the elements of group_names, then an error is returned. This cannot be provided together with gids query parameter.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_usage_users(users: Optional[Union[ReferenceType, List[ReferenceType]]] = None, file_systems: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, uids: Optional[ConstrainedListValue[StrictInt]] = None, user_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET usage/users

List users with hard limit quotas and their file system usage.

Parameters

• users (ReferenceType or List[ReferenceType], optional) – A list of users to query for. Overrides user_names keyword argument.

• file_systems (ReferenceType or List[ReferenceType], optional) – A list of file_systems to query for. Overrides file_system_ids and file_system_names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• file_system_ids (List[str]) – A comma-separated list of file system IDs. If after filtering, there is not at least one resource that matches each of the elements of file_system_ids, then an error is returned. This cannot be provided together with the file_system_names query parameter.

• file_system_names (List[str]) – A comma-separated list of file system names. If there is not at least one resource that matches each of the elements of file_system_names, then an error is returned.

• filter (str) – Exclude resources that don’t match the specified criteria.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• uids (List[int]) – A comma-separated list of user IDs. If there is not at least one resource that matches each of the elements of uids, then an error is returned. This cannot be provided together with user_names query parameter.

• user_names (List[str]) – A comma-separated list of user names. If there is not at least one resource that matches each of the elements of user_names, then an error is returned. This cannot be provided together with uids query parameter.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

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(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET worm-data-policies

List WORM data policies.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• offset (int) – The offset of the first resource to return from a collection.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_worm_data_policies_members(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

GET worm-data-policies/members

List members mapped to a WORM data policy.

Parameters

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_errors (bool) – 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]) – 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) – An opaque token used to iterate over a collection. The token to use on the next request is returned in the continuation_token field of the result.

• filter (str) – Exclude resources that don’t match the specified criteria.

• limit (int) – Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the available number, the request is still valid. In that case the server just returns the available number of items, disregarding the client’s page size request.

• member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• member_names (List[str]) – A comma-separated list of member names.

• offset (int) – The offset of the first resource to return from a collection.

• policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (List[str]) – A comma-separated list of policy names.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

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(active_directory: ActiveDirectoryPatch, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH active-directory

Modify the configuration of an Active Directory account.

Parameters

• active_directory (ActiveDirectoryPatch) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_admins(admin: AdminPatch, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH admins

Modify the attributes of an administrator.

Parameters

• admin (AdminPatch) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_admins_settings(admin_setting: AdminSetting, x_request_id: Optional[StrictStr] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Update global admin settings

Update properties for global admin settings.

Parameters

• admin_setting (AdminSetting) – (required)

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_alert_watchers(alert_watcher: AlertWatcher, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH alert-watchers

Modify an alert watcher’s configuration. Enable or disable an alert watcher privilege and select the level of alert notification of an alert watcher. Alert notification levels are info, warning, or critical.

Parameters

• alert_watcher (AlertWatcher) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_alerts(alerts_settings: Alert, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH alerts

Make changes to an alert. This is currently limited to the alert’s flagged property.

Parameters

• alerts_settings (Alert) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_api_clients(api_clients: ApiClient, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH api-clients

Modify an API client. Newly created API clients can be enabled by setting the enabled parameter to true.

Parameters

• api_clients (ApiClient) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_array_connections(array_connection: ArrayConnection, remotes: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH array-connections

Modify the configuration of a connected array.

Parameters

• array_connection (ArrayConnection) – (required)

• remotes (ReferenceType or List[ReferenceType], optional) – A list of remotes to query for. Overrides remote_ids and remote_names keyword arguments.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids keyword argument.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• remote_ids (List[str]) – A comma-separated list of remote array IDs. 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]) – A comma-separated 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) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_arrays(array: Array, x_request_id: Optional[StrictStr] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH arrays

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) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_arrays_eula(x_request_id: Optional[StrictStr] = None, eula: Optional[Eula] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH arrays/eula

Modifies the signature on the End User Agreement.

Parameters

• x_request_id (str) – Supplied by client during request or generated by server.

• eula (Eula) –

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_audit_file_systems_policies(policy: AuditFileSystemsPoliciesPatch, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH audit-file-systems-policies

Modify an existing audit policy’s attributes.

Parameters

• policy (AuditFileSystemsPoliciesPatch) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_bucket_replica_links(bucket_replica_link: BucketReplicaLink, remotes: Optional[Union[ReferenceType, List[ReferenceType]]] = None, remote_buckets: Optional[Union[ReferenceType, List[ReferenceType]]] = None, local_buckets: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, local_bucket_ids: Optional[ConstrainedListValue[StrictStr]] = None, local_bucket_names: Optional[ConstrainedListValue[StrictStr]] = None, remote_bucket_names: Optional[ConstrainedListValue[StrictStr]] = None, remote_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH bucket-replica-links

Modify the configuration of a bucket replica link including whether the link is paused and the object store remote credentials used.

Parameters

• bucket_replica_link (BucketReplicaLink) – (required)

• remotes (ReferenceType or List[ReferenceType], optional) – A list of remotes to query for. Overrides remote_ids and remote_names keyword arguments.

• remote_buckets (ReferenceType or List[ReferenceType], optional) – A list of remote_buckets to query for. Overrides remote_bucket_names keyword argument.

• local_buckets (ReferenceType or List[ReferenceType], optional) – A list of local_buckets to query for. Overrides local_bucket_ids and local_bucket_names keyword arguments.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids keyword argument.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• local_bucket_ids (List[str]) – A comma-separated list of local bucket IDs. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the local_bucket_names query parameter.

• local_bucket_names (List[str]) – A comma-separated list of local bucket names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with local_bucket_ids query parameter.

• remote_bucket_names (List[str]) – A comma-separated list of remote bucket names. If there is not at least one resource that matches each of the elements, then an error is returned.

• remote_ids (List[str]) – A comma-separated list of remote array IDs. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_names query parameter.

• remote_names (List[str]) – A comma-separated list of remote array names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with remote_ids query parameter.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_buckets(bucket: BucketPatch, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, ignore_usage: Optional[StrictBool] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH buckets

Modify object store bucket attributes such as destroyed and versioning.

Parameters

• bucket (BucketPatch) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• ignore_usage (bool) – Allow update operations that lead to a hard_limit_enabled object store account, bucket, or file system with usage over its limiting value. For object store accounts and buckets, the limiting value is that of quota_limit, and for file systems it is that of provisioned. The operation can be 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]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_certificates(certificate: CertificatePatch, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH certificates

Modify SSL certificate attributes such as passphrases and intermediate certificates.

Parameters

• certificate (CertificatePatch) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_directory_services(directory_service: DirectoryService, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH directory-services

Modifies and tests the directory service configuration.

Parameters

• directory_service (DirectoryService) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_directory_services_roles(directory_service_roles: DirectoryServiceRole, roles: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, role_ids: Optional[ConstrainedListValue[StrictStr]] = None, role_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH directory-service/roles

Update an RBAC group configuration setting for manageability.

Parameters

• directory_service_roles (DirectoryServiceRole) – (required)

• roles (ReferenceType or List[ReferenceType], optional) – A list of roles to query for. Overrides role_ids and role_names keyword arguments.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the names, role_names, or role_ids query parameters.

• names (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of 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]) – A comma-separated list of role_ids. If after filtering, there is not at least one resource that matches each of the elements of role_ids, then an error is returned. This cannot be provided together with the ids, 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]) – A comma-separated list of role_names. If there is not at least one resource that matches each of the elements of role_names, then an error is returned. This cannot be provided together with the ids, 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) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_directory_services_test(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, directory_service: Optional[DirectoryService] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH directory-service/test

Test the configured directory services on the array. Optionally, provide modifications which will be used to perform the tests, but will not be applied to the current configuration.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• filter (str) – Exclude resources that don’t match the specified criteria.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• sort (List[str]) – Sort the response by the specified fields (in descending order if ‘-’ is appended to the field name). NOTE: If you provide a sort you will not get a continuation_token in the response.

• directory_service (DirectoryService) – An optional directory service configuration that, if provided, will be used to overwrite aspects of the existing directory service objects when performing tests.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_dns(dns: Dns, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH dns

Modify a DNS configuration.

Parameters

• dns (Dns) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_file_system_exports(file_system_export: FileSystemExport, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH file-system-exports

Modify a file system export’s attributes.

Parameters

• file_system_export (FileSystemExport) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_file_system_replica_links(remotes: Optional[Union[ReferenceType, List[ReferenceType]]] = None, local_file_systems: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, local_file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, local_file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, remote_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_names: Optional[ConstrainedListValue[StrictStr]] = None, replicate_now: Optional[StrictBool] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH file-system-replica-links

Update a file system replication link.

Parameters

• remotes (ReferenceType or List[ReferenceType], optional) – A list of remotes to query for. Overrides remote_ids and remote_names keyword arguments.

• local_file_systems (ReferenceType or List[ReferenceType], optional) – A list of local_file_systems to query for. Overrides local_file_system_ids and local_file_system_names keyword arguments.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids keyword argument.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• local_file_system_ids (List[str]) – A comma-separated list of local file system IDs. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the local_file_system_names query parameter.

• local_file_system_names (List[str]) – A comma-separated list of local file system names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with local_file_system_ids query parameter.

• remote_ids (List[str]) – A comma-separated list of remote array IDs. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_names query parameter.

• remote_names (List[str]) – A comma-separated list of remote array names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with remote_ids query parameter.

• replicate_now (bool) – 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) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_file_system_snapshots(file_system_snapshot: FileSystemSnapshot, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, latest_replica: Optional[StrictBool] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH file-system-snapshots

Modify file system snapshot attributes.

Parameters

• file_system_snapshot (FileSystemSnapshot) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• latest_replica (bool) – Used when destroying a snapshot. If not present or false, and the snapshot is the latest replicated snapshot, then destroy will fail. If true or the snapshot is not the latest replicated snapshot, then destroy will be successful.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_file_systems(file_system: FileSystemPatch, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, cancel_in_progress_storage_class_transition: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, delete_link_on_eradication: Optional[StrictBool] = None, discard_detailed_permissions: Optional[StrictBool] = None, discard_non_snapshotted_data: Optional[StrictBool] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, ignore_usage: Optional[StrictBool] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH file-systems

Modify a file system’s attributes including its export protocols and limits.

Parameters

• file_system (FileSystemPatch) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• cancel_in_progress_storage_class_transition (bool) – 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]) – 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) – If set to true, the file system can be destroyed, even if it has a replica link. If set to false, the file system cannot be destroyed if it has a replica link. Defaults to false.

• discard_detailed_permissions (bool) – This parameter must be set to true in order to change a file system’s access_control_style from a style that supports more detailed access control lists to a style that only supports less detailed mode bits as a form of permission control. This parameter may not be set to true any other time. Setting this parameter to true is acknowledgement that any more detailed access control lists currently set within the file system will be lost, and NFS permission controls will only be enforced at the granularity level of NFS mode bits.

• discard_non_snapshotted_data (bool) – This parameter must be set to true in order to restore a file system from a snapshot or to demote a file system (which restores the file system from the common baseline snapshot). Setting this parameter to true is acknowledgement that any non-snapshotted data currently in the file system will be irretrievably lost.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• ignore_usage (bool) – Allow update operations that lead to a hard_limit_enabled object store account, bucket, or file system with usage over its limiting value. For object store accounts and buckets, the limiting value is that of quota_limit, and for file systems it is that of provisioned. The operation can be 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]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_fleets(fleet: FleetPatch, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH fleets

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

• fleet (FleetPatch) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Supports exactly one value.

• names (List[str]) – Performs the operation on the unique resource names specified. Supports exactly one value.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_hardware(hardware: Hardware, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH hardware

Controls the visual identification light of the specified hardware component.

Parameters

• hardware (Hardware) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_hardware_connectors(hardware_connector: HardwareConnector, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH hardware-connectors

The endpoint is deprecated. Use the /network-interfaces/connectors endpoint instead. Modify array connection information.

Parameters

• hardware_connector (HardwareConnector) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_kmip(kmip_server: KmipServer, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Modify a KMIP server configuration

Modifies KMIP server properties - URI, certificate, certificate group.

Parameters

• kmip_server (KmipServer) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_legal_holds(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, hold: Optional[LegalHold] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Update a legal hold

Update a legal hold instance.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• hold (LegalHold) –

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_legal_holds_held_entities(released: StrictBool, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, file_systems: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, paths: Optional[ConstrainedListValue[StrictStr]] = None, recursive: Optional[StrictBool] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Release this legal hold from the given entity

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

• released (bool) – This is a flag to set when releasing an attached legal hold from a path. (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• file_systems (ReferenceType or List[ReferenceType], optional) – A list of file_systems to query for. Overrides file_system_ids and file_system_names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• file_system_ids (List[str]) – A comma-separated list of file system IDs. If after filtering, there is not at least one resource that matches each of the elements of file_system_ids, then an error is returned. This cannot be provided together with the file_system_names query parameter.

• file_system_names (List[str]) – A comma-separated list of file system names. If there is not at least one resource that matches each of the elements of file_system_names, then an error is returned.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• paths (List[str]) – A comma-separated 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) – 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) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_lifecycle_rules(lifecycle: LifecycleRulePatch, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, buckets: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, bucket_ids: Optional[ConstrainedListValue[StrictStr]] = None, bucket_names: Optional[ConstrainedListValue[StrictStr]] = None, confirm_date: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH lifecycle-rules

Modify an existing lifecycle rule by name or id. If ids is specified, bucket_names or bucket_ids is also required.

Parameters

• lifecycle (LifecycleRulePatch) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• buckets (ReferenceType or List[ReferenceType], optional) – A list of buckets to query for. Overrides bucket_ids and bucket_names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• bucket_ids (List[str]) – A comma-separated list of bucket IDs. If after filtering, there is not at least one resource that matches each of the elements of bucket_ids, then an error is returned. This cannot be provided together with the bucket_names query parameter. This can be provided with the ids query parameter but not with names.

• bucket_names (List[str]) – A comma-separated list of bucket names. If there is not at least one resource that matches each of the elements of bucket_names, then an error is returned. This cannot be provided together with the bucket_ids query parameter. This can be provided with the ids query parameter but not with names.

• confirm_date (bool) – If set to true, then confirm the date of keep_current_version_until is correct.

• context_names (List[str]) – 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]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_link_aggregation_groups(link_aggregation_group: Api217LinkAggregationGroupsPatchRequest, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH link-aggregation-groups

Modify link aggregation groups by adding and removing Ethernet ports.

Parameters

• link_aggregation_group (Api217LinkAggregationGroupsPatchRequest) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_logs_async(logs_async: LogsAsync, x_request_id: Optional[StrictStr] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH logs-async

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) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_network_access_policies(policy: NetworkAccessPolicy, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, versions: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH network-access-policies

Modify an existing network access policy’s attributes.

Parameters

• policy (NetworkAccessPolicy) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• versions (List[str]) – A comma-separated list of versions. This is an optional query param used for concurrency control. The ordering should match the names or ids query param. This will fail with a 412 Precondition failed if the resource was changed and the current version of the resource doesn’t match the value in the query param.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_network_access_policies_rules(rule: NetworkAccessPolicyRule, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, before_rule_id: Optional[StrictStr] = None, before_rule_name: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, versions: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH network-access-policies/rules

Modify an existing network access policy rule.

Parameters

• rule (NetworkAccessPolicyRule) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• before_rule_id (str) – The id of the rule to insert or move a rule before. This cannot be provided together with the before_rule_name query parameter.

• before_rule_name (str) – The name of the rule to insert or move a rule before. This cannot be provided together with the before_rule_id query parameter.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• versions (List[str]) – A comma-separated list of versions. This is an optional query param used for concurrency control. The ordering should match the names or ids query param. This will fail with a 412 Precondition failed if the resource was changed and the current version of the resource doesn’t match the value in the query param.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_network_interfaces(network_interface: NetworkInterfacePatch, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH network-interfaces

Modify the attributes of a VIP.

Parameters

• network_interface (NetworkInterfacePatch) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_network_interfaces_connectors(network_connector: HardwareConnector, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH network-interfaces/connectors

Modify network connector information.

Parameters

• network_connector (HardwareConnector) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_nfs_export_policies(policy: NfsExportPolicy, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, versions: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH nfs-export-policies

Modify an existing NFS export policy’s attributes.

Parameters

• policy (NfsExportPolicy) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• versions (List[str]) – A comma-separated list of versions. This is an optional query param used for concurrency control. The ordering should match the names or ids query param. This will fail with a 412 Precondition failed if the resource was changed and the current version of the resource doesn’t match the value in the query param.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_nfs_export_policies_rules(rule: NfsExportPolicyRule, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, before_rule_id: Optional[StrictStr] = None, before_rule_name: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, versions: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH nfs-export-policies/rules

Modify an existing NFS export policy rule. If before_rule_id or before_rule_name are specified, the rule will be moved before that rule. Rules are ordered in three groups; ip addresses, other and * and can only be moved within the appropriate group. One of the following is required: ids or names.

Parameters

• rule (NfsExportPolicyRule) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• before_rule_id (str) – The id of the rule to insert or move a rule before. This cannot be provided together with the before_rule_name query parameter.

• before_rule_name (str) – The name of the rule to insert or move a rule before. This cannot be provided together with the before_rule_id query parameter.

• context_names (List[str]) – 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]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• versions (List[str]) – A comma-separated list of versions. This is an optional query param used for concurrency control. The ordering should match the names or ids query param. This will fail with a 412 Precondition failed if the resource was changed and the current version of the resource doesn’t match the value in the query param.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_object_store_access_keys(names: ConstrainedListValue[StrictStr], object_store_access_key: ObjectStoreAccessKey, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH object-store-access-keys

Enable or disable object store access keys.

Parameters

• names (List[str]) – A comma-separated list of resource names. (required)

• object_store_access_key (ObjectStoreAccessKey) – (required)

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_object_store_access_policies(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, enforce_action_restrictions: Optional[StrictBool] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, policy: Optional[ObjectStoreAccessPolicyPatch] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH object-store-access-policies

Modify the rules of an object store access policy.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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) – Certain combinations of actions and other rule elements are inherently ignored if specified together in a rule. If set to true, operations which attempt to set these combinations will fail. If set to false, such operations will instead be allowed. Defaults to true.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• policy (ObjectStoreAccessPolicyPatch) –

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_object_store_access_policies_rules(rule: PolicyRuleObjectAccessPost, policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, enforce_action_restrictions: Optional[StrictBool] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH object-store-access-policies-rules

Modify an access policy rule’s attributes.

Parameters

• rule (PolicyRuleObjectAccessPost) – (required)

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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) – Certain combinations of actions and other rule elements are inherently ignored if specified together in a rule. If set to true, operations which attempt to set these combinations will fail. If set to false, such operations will instead be allowed. Defaults to true.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (List[str]) – A comma-separated list of policy names.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_object_store_accounts(object_store_account: ObjectStoreAccountPatch, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, ignore_usage: Optional[StrictBool] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH object-store-accounts

Modify object store account attributes such as quota limit and bucket defaults.

Parameters

• object_store_account (ObjectStoreAccountPatch) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• ignore_usage (bool) – Allow update operations that lead to a hard_limit_enabled object store account, bucket, or file system with usage over its limiting value. For object store accounts and buckets, the limiting value is that of quota_limit, and for file systems it is that of provisioned. The operation can be 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]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_object_store_remote_credentials(remote_credentials: ObjectStoreRemoteCredentials, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH object-store-remote-credentials

Rename and/or change the access key/secret key pair for object store remote credentials.

Parameters

• remote_credentials (ObjectStoreRemoteCredentials) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_object_store_roles(object_store_role: ObjectStoreRole, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH object-store-roles

Modify existing object store roles.

Parameters

• object_store_role (ObjectStoreRole) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_object_store_roles_object_store_trust_policies_rules(rule: TrustPolicyRulePost, roles: Optional[Union[ReferenceType, List[ReferenceType]]] = None, policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, indices: Optional[ConstrainedListValue[StrictInt]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, role_ids: Optional[ConstrainedListValue[StrictStr]] = None, role_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH object-store-roles/object-store-trust-policies/rules

Modify a trust policy rule’s attributes.

Parameters

• rule (TrustPolicyRulePost) – (required)

• roles (ReferenceType or List[ReferenceType], optional) – A list of roles to query for. Overrides role_ids and role_names keyword arguments.

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_names keyword argument.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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]) – A comma-separated 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]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• policy_names (List[str]) – A comma-separated list of policy names.

• role_ids (List[str]) – A comma-separated 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]) – A comma-separated 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) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_object_store_roles_object_store_trust_policies_upload(policy_document: StrictStr, roles: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, role_ids: Optional[ConstrainedListValue[StrictStr]] = None, role_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH object-store-roles/object-store-trust-policies/upload

Upload object store roles and their trust policies in native AWS format.

Parameters

• policy_document (str) – The trust policy document to upload. (required)

• roles (ReferenceType or List[ReferenceType], optional) – A list of roles to query for. Overrides role_ids and role_names keyword arguments.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• role_ids (List[str]) – A comma-separated 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]) – A comma-separated 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) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_password_policies(policy: PasswordPolicy, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Modify password policies

Modifies one or more password policies. To enable a policy, set enabled=true. To disable a policy, set enabled=false.

Parameters

• policy (PasswordPolicy) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_policies(policy: PolicyPatch, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, destroy_snapshots: Optional[StrictBool] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH policies

Modify a snapshot scheduling policy’s attributes for when and how often snapshots are created and how long they are retained.

Parameters

• policy (PolicyPatch) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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) – 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]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_qos_policies(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, policy: Optional[QosPolicy] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH qos-policies

Modify a QoS policy.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• policy (QosPolicy) –

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_quotas_groups(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, groups: Optional[Union[ReferenceType, List[ReferenceType]]] = None, file_systems: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, gids: Optional[ConstrainedListValue[StrictInt]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, quota: Optional[GroupQuotaPatch] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH quotas/groups

Modify a quota for a group. Note that if you modify a group’s quota to a lower value and that group’s usage has already exceeded the new value, writes will automatically halt until usage decreases below the new quota setting.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• groups (ReferenceType or List[ReferenceType], optional) – A list of groups to query for. Overrides group_names keyword argument.

• file_systems (ReferenceType or List[ReferenceType], optional) – A list of file_systems to query for. Overrides file_system_ids and file_system_names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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]) – A comma-separated list of file system IDs. If after filtering, there is not at least one resource that matches each of the elements of file_system_ids, then an error is returned. This cannot be provided together with the file_system_names query parameter.

• file_system_names (List[str]) – A comma-separated list of file system names. If there is not at least one resource that matches each of the elements of file_system_names, then an error is returned.

• gids (List[int]) – A comma-separated list of group IDs. If there is not at least one resource that matches each of the elements of gids, then an error is returned. This cannot be provided together with group_names query parameter.

• group_names (List[str]) – A comma-separated list of group names. If there is not at least one resource that matches each of the elements of group_names, then an error is returned. This cannot be provided together with gids query parameter.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• quota (GroupQuotaPatch) –

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_quotas_settings(quota_setting: QuotaSetting, x_request_id: Optional[StrictStr] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH quotas-settings

Modify the notification attributes of a group or user quota.

Parameters

• quota_setting (QuotaSetting) – (required)

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_quotas_users(users: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, file_systems: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, uids: Optional[ConstrainedListValue[StrictInt]] = None, user_names: Optional[ConstrainedListValue[StrictStr]] = None, quota: Optional[UserQuotaPatch] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH quotas/users

Modify the attributes of a hard limit file system quota. Note that if you modify a user’s quota to a lower value and that user’s usage has already exceeded the new value, writes will automatically halt until usage decreases below the new quota setting.

Parameters

• users (ReferenceType or List[ReferenceType], optional) – A list of users to query for. Overrides user_names keyword argument.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• file_systems (ReferenceType or List[ReferenceType], optional) – A list of file_systems to query for. Overrides file_system_ids and file_system_names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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]) – A comma-separated list of file system IDs. If after filtering, there is not at least one resource that matches each of the elements of file_system_ids, then an error is returned. This cannot be provided together with the file_system_names query parameter.

• file_system_names (List[str]) – A comma-separated list of file system names. If there is not at least one resource that matches each of the elements of file_system_names, then an error is returned.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• uids (List[int]) – A comma-separated list of user IDs. If there is not at least one resource that matches each of the elements of uids, then an error is returned. This cannot be provided together with user_names query parameter.

• user_names (List[str]) – A comma-separated list of user names. If there is not at least one resource that matches each of the elements of user_names, then an error is returned. This cannot be provided together with uids query parameter.

• quota (UserQuotaPatch) –

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_rapid_data_locking(rapid_data_locking: RapidDataLocking, x_request_id: Optional[StrictStr] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Modifies the Rapid Data Locking feature.

Modifies the Rapid Data Locking feature. Note that the feature can only be enabled if there are no file systems nor buckets created on the array. Once enabled, the feature cannot be modified.

Parameters

• rapid_data_locking (RapidDataLocking) – (required)

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_servers(server: ServerPost, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH servers

Modify the server attributes.

Parameters

• server (ServerPost) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_smb_client_policies(policy: SmbClientPolicy, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH smb-client-policies

Modify an existing SMB Client policy’s attributes.

Parameters

• policy (SmbClientPolicy) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_smb_client_policies_rules(rule: SmbClientPolicyRule, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, before_rule_id: Optional[StrictStr] = None, before_rule_name: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, versions: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH smb-client-policies/rules

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

• rule (SmbClientPolicyRule) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• before_rule_id (str) – The id of the rule to insert or move a rule before. This cannot be provided together with the before_rule_name query parameter.

• before_rule_name (str) – The name of the rule to insert or move a rule before. This cannot be provided together with the before_rule_id query parameter.

• context_names (List[str]) – 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]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• versions (List[str]) – A comma-separated list of versions. This is an optional query param used for concurrency control. The ordering should match the names or ids query param. This will fail with a 412 Precondition failed if the resource was changed and the current version of the resource doesn’t match the value in the query param.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_smb_share_policies(policy: SmbSharePolicy, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH smb-share-policies

Modify an existing SMB Share policy’s attributes.

Parameters

• policy (SmbSharePolicy) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_smb_share_policies_rules(rule: SmbSharePolicyRule, policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH smb-share-policies/rules

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

• rule (SmbSharePolicyRule) – (required)

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (List[str]) – A comma-separated list of policy names.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_smtp_servers(smtp: SmtpServer, x_request_id: Optional[StrictStr] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH smtp-servers

Modify SMTP server attributes such as the relay host and sender domain.

Parameters

• smtp (SmtpServer) – (required)

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_snmp_agents(snmp_agent: SnmpAgent, x_request_id: Optional[StrictStr] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH snmp-agents

Modify SNMP agent attributes.

Parameters

• snmp_agent (SnmpAgent) – (required)

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_snmp_managers(snmp_manager: SnmpManager, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH snmp-managers

Modify SNMP manager attributes such as versions.

Parameters

• snmp_manager (SnmpManager) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_ssh_certificate_authority_policies(policy: SshCertificateAuthorityPolicy, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Modify SSH Certificate Authority configurations

Modifies one or more attributes of SSH Certificate Authority configurations.

Parameters

• policy (SshCertificateAuthorityPolicy) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_sso_oidc_idps(idp: OidcSsoPatch, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Modify OIDC SSO configuration

Modify one or more attributes of OIDC SSO configuration.

Parameters

• idp (OidcSsoPatch) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_sso_saml2_idps(idp: Saml2Sso, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Modify SAML2 SSO configurations

Modifies one or more attributes of SAML2 SSO configurations.

Parameters

• idp (Saml2Sso) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_sso_saml2_idps_test(idp: Saml2Sso, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH sso/saml2/idps/test

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

• idp (Saml2Sso) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_subnets(subnet: Subnet, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH subnets

Modify array subnet attributes.

Parameters

• subnet (Subnet) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_support(support: Support, x_request_id: Optional[StrictStr] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH support

Modify Phone Home and Remote Assistance settings.

Parameters

• support (Support) – (required)

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_support_verification_keys(key: VerificationKeyPatch, x_request_id: Optional[StrictStr] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH verification-keys

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) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_syslog_servers(syslog_server: SyslogServerPatch, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH syslog-servers

Modify the URI or services of a configured syslog server.

Parameters

• syslog_server (SyslogServerPatch) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_syslog_servers_settings(syslog_server_settings: SyslogServerSettings, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH syslog-servers/settings

Modify the certificate or certificate group associated with the syslog servers.

Parameters

• syslog_server_settings (SyslogServerSettings) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_targets(target: Target, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH targets

Modify the target attributes for replication.

Parameters

• target (Target) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_tls_policies(policy: TlsPolicy, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Modify TLS policies

Modifies one or more attributes of TLS policies.

Parameters

• policy (TlsPolicy) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_worm_data_policies(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, policy: Optional[WormDataPolicy] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

PATCH worm-data-policies

Modify a WORM data policy.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• policy (WormDataPolicy) –

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_active_directory(active_directory: ActiveDirectoryPost, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, join_existing_account: Optional[StrictBool] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST active-directory

Join an Active Directory domain and generate keytabs for the registered SPNs and supported encryption types.

Parameters

• active_directory (ActiveDirectoryPost) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• join_existing_account (bool) – If specified as true, the domain is searched for a pre-existing computer account to join to, and no new account will be created within the domain. The user specified when joining to a pre-existing account must have permissions to ‘read attributes from’ and ‘reset the password of’ the pre-existing account. service_principal_names, encryption_types, and join_ou will be read from the pre-existing account and cannot be specified when joining to an existing account. If not specified, defaults to false.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_admins(admin: AdminPost, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST admins

Create a new local administrator.

Parameters

• admin (AdminPost) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_admins_api_tokens(admins: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, admin_ids: Optional[ConstrainedListValue[StrictStr]] = None, admin_names: Optional[ConstrainedListValue[StrictStr]] = None, timeout: Optional[StrictInt] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST admins/api-tokens

Creates API tokens for the specified administrators.

Parameters

• admins (ReferenceType or List[ReferenceType], optional) – A list of admins to query for. Overrides admin_ids and admin_names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• admin_ids (List[str]) – A comma-separated list of admin IDs. If after filtering, there is not at least one admin resource that matches each of the elements, then an error is returned. This cannot be provided together with the admin_names query parameter.

• admin_names (List[str]) – A comma-separated list of admin names. If there is not at least one admin resource that matches each of the elements, then an error is returned. This cannot be provided together with admin_ids query parameter.

• timeout (int) – The duration of API token validity, in milliseconds.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_admins_ssh_certificate_authority_policies(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST admins/ssh-certificate-authority-policies

Map a SSH Certificate Authority policy to a specific user.

Parameters

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• member_names (List[str]) – A comma-separated list of member names.

• policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (List[str]) – A comma-separated list of policy names.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_alert_watchers(names: ConstrainedListValue[StrictStr], references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, alert_watcher: Optional[AlertWatcherPost] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST alert-watchers

Create an alert watcher to receive array alert messages.

Parameters

• names (List[str]) – A comma-separated list of resource names. (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• alert_watcher (AlertWatcherPost) –

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_api_clients(api_client: ApiClientsPost, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST api-clients

Create an API client to authorize Access Token or Bearer Tokens for use on the array. Required fields include issuer, public_key, and access_token_ttl_in_ms. After creating an API client, it can only be enabled by an authorized user.

Parameters

• api_client (ApiClientsPost) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_array_connections(array_connection: ArrayConnectionPost, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST array-connections

Create a connection to an array for replication and configure network settings.

Parameters

• array_connection (ArrayConnectionPost) – (required)

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_array_connections_connection_key(x_request_id: Optional[StrictStr] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST array-connections/connection-key

Create an array connection key allowing one array to connect to another for replication.

Parameters

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_arrays_factory_reset_token(x_request_id: Optional[StrictStr] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Create a factory reset token

Creates a token that can be used to perform a factory reset on the array. Factory reset tokens can only be created after the array has been prepared for reset (e.g., all file systems, buckets, and snapshots must first be eradicated). After a token has been created, operations that would take the array out of the prepared state (e.g., creating file systems) are disabled until all tokens have been deleted.

Parameters

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_arrays_ssh_certificate_authority_policies(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST admins/settings/ssh-certificate-authority-policies

Map a SSH Certificate Authority policy as a default for admins.

Parameters

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• member_names (List[str]) – A comma-separated list of member names.

• policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (List[str]) – A comma-separated list of policy names.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_audit_file_systems_policies(names: ConstrainedListValue[StrictStr], contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, policy: Optional[AuditFileSystemsPoliciesPost] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST audit-file-systems-policies

Create a new audit policy for file systems.

Parameters

• names (List[str]) – A comma-separated list of resource names. (required)

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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 (AuditFileSystemsPoliciesPost) –

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_audit_file_systems_policies_members(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST audit-file-systems-policies/members

Map a file system to a audit policy.

Parameters

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• member_names (List[str]) – A comma-separated list of member names.

• policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (List[str]) – A comma-separated list of policy names.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_bucket_replica_links(bucket_replica_link: BucketReplicaLinkPost, remote_credential: Optional[Union[ReferenceType, List[ReferenceType]]] = None, remote_buckets: Optional[Union[ReferenceType, List[ReferenceType]]] = None, local_buckets: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, local_bucket_ids: Optional[ConstrainedListValue[StrictStr]] = None, local_bucket_names: Optional[ConstrainedListValue[StrictStr]] = None, remote_bucket_names: Optional[ConstrainedListValue[StrictStr]] = None, remote_credentials_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_credentials_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST bucket-replica-links

Create a bucket replica link for object replication.

Parameters

• bucket_replica_link (BucketReplicaLinkPost) – (required)

• remote_credential (ReferenceType or List[ReferenceType], optional) – A list of remote_credential to query for. Overrides remote_credentials_ids and remote_credentials_names keyword arguments.

• remote_buckets (ReferenceType or List[ReferenceType], optional) – A list of remote_buckets to query for. Overrides remote_bucket_names keyword argument.

• local_buckets (ReferenceType or List[ReferenceType], optional) – A list of local_buckets to query for. Overrides local_bucket_ids and local_bucket_names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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]) – A comma-separated list of local bucket IDs. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the local_bucket_names query parameter.

• local_bucket_names (List[str]) – A comma-separated list of local bucket names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with local_bucket_ids query parameter.

• remote_bucket_names (List[str]) – A comma-separated list of remote bucket names. If there is not at least one resource that matches each of the elements, then an error is returned.

• remote_credentials_ids (List[str]) – A comma-separated list of remote credentials IDs. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_credentials_names query parameter.

• remote_credentials_names (List[str]) – A comma-separated list of remote credentials names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_credentials_ids query parameter.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_buckets(names: ConstrainedListValue[StrictStr], bucket: BucketPost, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST buckets

Create a new object store bucket.

Parameters

• names (List[str]) – A comma-separated list of resource names. (required)

• bucket (BucketPost) – (required)

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_buckets_bucket_access_policies(contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, buckets: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, bucket_ids: Optional[ConstrainedListValue[StrictStr]] = None, bucket_names: Optional[ConstrainedListValue[StrictStr]] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, policy: Optional[BucketAccessPolicyPost] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST buckets/bucket-access-policies

Create a new policy for the specified bucket. Policy’s name will be autogenerated by the system.

Parameters

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• buckets (ReferenceType or List[ReferenceType], optional) – A list of buckets to query for. Overrides bucket_ids and bucket_names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• bucket_ids (List[str]) – A comma-separated list of bucket IDs. If after filtering, there is not at least one resource that matches each of the elements of bucket_ids, then an error is returned. This cannot be provided together with the bucket_names query parameter. This can be provided with the ids query parameter but not with names.

• bucket_names (List[str]) – A comma-separated list of bucket names. If there is not at least one resource that matches each of the elements of bucket_names, then an error is returned. This cannot be provided together with the bucket_ids query parameter. This can be provided with the ids query parameter but not with names.

• context_names (List[str]) – 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 (BucketAccessPolicyPost) –

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_buckets_bucket_access_policies_rules(names: ConstrainedListValue[StrictStr], rule: BucketAccessPolicyRulePost, policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, buckets: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, bucket_ids: Optional[ConstrainedListValue[StrictStr]] = None, bucket_names: Optional[ConstrainedListValue[StrictStr]] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST buckets/bucket-access-policies/rules

Create a new bucket policy rule for the specified bucket. Either policy_names or bucket_names/bucket_ids query parameters can be used.

Parameters

• names (List[str]) – A comma-separated list of resource names. (required)

• rule (BucketAccessPolicyRulePost) – (required)

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_names keyword argument.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• buckets (ReferenceType or List[ReferenceType], optional) – A list of buckets to query for. Overrides bucket_ids and bucket_names keyword arguments.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• bucket_ids (List[str]) – A comma-separated list of bucket IDs. If after filtering, there is not at least one resource that matches each of the elements of bucket_ids, then an error is returned. This cannot be provided together with the bucket_names query parameter. This can be provided with the ids query parameter but not with names.

• bucket_names (List[str]) – A comma-separated list of bucket names. If there is not at least one resource that matches each of the elements of bucket_names, then an error is returned. This cannot be provided together with the bucket_ids query parameter. This can be provided with the ids query parameter but not with names.

• context_names (List[str]) – 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]) – A comma-separated list of policy names.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_buckets_cross_origin_resource_sharing_policies(contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, buckets: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, bucket_ids: Optional[ConstrainedListValue[StrictStr]] = None, bucket_names: Optional[ConstrainedListValue[StrictStr]] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, policy: Optional[CrossOriginResourceSharingPolicyPatch] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST buckets/cross-origin-resource-sharing-policies

Create a new cross origin resource sharing policy for the specified bucket. Policy’s name will be autogenerated by the system.

Parameters

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• buckets (ReferenceType or List[ReferenceType], optional) – A list of buckets to query for. Overrides bucket_ids and bucket_names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• bucket_ids (List[str]) – A comma-separated list of bucket IDs. If after filtering, there is not at least one resource that matches each of the elements of bucket_ids, then an error is returned. This cannot be provided together with the bucket_names query parameter. This can be provided with the ids query parameter but not with names.

• bucket_names (List[str]) – A comma-separated list of bucket names. If there is not at least one resource that matches each of the elements of bucket_names, then an error is returned. This cannot be provided together with the bucket_ids query parameter. This can be provided with the ids query parameter but not with names.

• context_names (List[str]) – 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 (CrossOriginResourceSharingPolicyPatch) –

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_buckets_cross_origin_resource_sharing_policies_rules(names: ConstrainedListValue[StrictStr], rule: CrossOriginResourceSharingPolicyRulePost, policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, buckets: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, bucket_ids: Optional[ConstrainedListValue[StrictStr]] = None, bucket_names: Optional[ConstrainedListValue[StrictStr]] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST buckets/cross-origin-resource-sharing-policies/rules

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

• names (List[str]) – A comma-separated list of resource names. (required)

• rule (CrossOriginResourceSharingPolicyRulePost) – (required)

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_names keyword argument.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• buckets (ReferenceType or List[ReferenceType], optional) – A list of buckets to query for. Overrides bucket_ids and bucket_names keyword arguments.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• bucket_ids (List[str]) – A comma-separated list of bucket IDs. If after filtering, there is not at least one resource that matches each of the elements of bucket_ids, then an error is returned. This cannot be provided together with the bucket_names query parameter. This can be provided with the ids query parameter but not with names.

• bucket_names (List[str]) – A comma-separated list of bucket names. If there is not at least one resource that matches each of the elements of bucket_names, then an error is returned. This cannot be provided together with the bucket_ids query parameter. This can be provided with the ids query parameter but not with names.

• context_names (List[str]) – 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]) – A comma-separated list of policy names.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_certificate_groups(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST certificate-groups

Create one or more certificate groups on the array.

Parameters

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_certificate_groups_certificates(certificates: Optional[Union[ReferenceType, List[ReferenceType]]] = None, certificate_groups: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, certificate_group_ids: Optional[ConstrainedListValue[StrictStr]] = None, certificate_group_names: Optional[ConstrainedListValue[StrictStr]] = None, certificate_ids: Optional[ConstrainedListValue[StrictStr]] = None, certificate_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST certificate-groups/certificates

Add one or more certificates to one or more certificate groups on the array.

Parameters

• certificates (ReferenceType or List[ReferenceType], optional) – A list of certificates to query for. Overrides certificate_ids and certificate_names keyword arguments.

• certificate_groups (ReferenceType or List[ReferenceType], optional) – A list of certificate_groups to query for. Overrides certificate_group_ids and certificate_group_names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• certificate_group_ids (List[str]) – A comma-separated list of certificate group ids. If there is not at least one resource that matches each of the elements of certificate_group_ids, then an error is returned. This cannot be provided in conjunction with the certificate_group_names parameter.

• certificate_group_names (List[str]) – A comma-separated list of certificate group names. If there is not at least one resource that matches each of the elements of certificate_group_names, then an error is returned. This cannot be provided in conjunction with the certificate_group_ids parameter.

• certificate_ids (List[str]) – A comma-separated list of certificate ids. If there is not at least one resource that matches each of the elements of certificate_ids, then an error is returned. This cannot be provided in conjunction with the certificate_names parameter.

• certificate_names (List[str]) – A comma-separated list of certificate names. If there is not at least one resource that matches each of the elements of certificate_names, then an error is returned. This cannot be provided in conjunction with the certificate_ids parameter.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_certificates(certificate: CertificatePost, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST certificates

Upload a CA certificate to the array.

Parameters

• certificate (CertificatePost) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_certificates_certificate_groups(certificates: Optional[Union[ReferenceType, List[ReferenceType]]] = None, certificate_groups: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, certificate_group_ids: Optional[ConstrainedListValue[StrictStr]] = None, certificate_group_names: Optional[ConstrainedListValue[StrictStr]] = None, certificate_ids: Optional[ConstrainedListValue[StrictStr]] = None, certificate_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST certificates/certificate-groups

Add one or more certificates to one or more certificate groups.

Parameters

• certificates (ReferenceType or List[ReferenceType], optional) – A list of certificates to query for. Overrides certificate_ids and certificate_names keyword arguments.

• certificate_groups (ReferenceType or List[ReferenceType], optional) – A list of certificate_groups to query for. Overrides certificate_group_ids and certificate_group_names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• certificate_group_ids (List[str]) – A comma-separated list of certificate group ids. If there is not at least one resource that matches each of the elements of certificate_group_ids, then an error is returned. This cannot be provided in conjunction with the certificate_group_names parameter.

• certificate_group_names (List[str]) – A comma-separated list of certificate group names. If there is not at least one resource that matches each of the elements of certificate_group_names, then an error is returned. This cannot be provided in conjunction with the certificate_group_ids parameter.

• certificate_ids (List[str]) – A comma-separated list of certificate ids. If there is not at least one resource that matches each of the elements of certificate_ids, then an error is returned. This cannot be provided in conjunction with the certificate_names parameter.

• certificate_names (List[str]) – A comma-separated list of certificate names. If there is not at least one resource that matches each of the elements of certificate_names, then an error is returned. This cannot be provided in conjunction with the certificate_ids parameter.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_directory_services_roles(directory_service_roles: DirectoryServiceRole, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST directory-service/roles

Create an RBAC group configuration setting for manageability.

Parameters

• directory_service_roles (DirectoryServiceRole) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_dns(names: ConstrainedListValue[StrictStr], dns: DnsPost, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST dns

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

• names (List[str]) – A comma-separated list of resource names. (required)

• dns (DnsPost) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_file_system_exports(file_system_export: FileSystemExportPost, policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST file-system-exports

Create a file system export.

Parameters

• file_system_export (FileSystemExportPost) – (required)

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• member_names (List[str]) – A comma-separated list of member names.

• policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (List[str]) – A comma-separated list of policy names.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_file_system_replica_links(file_system_replica_link: FileSystemReplicaLink, remotes: Optional[Union[ReferenceType, List[ReferenceType]]] = None, remote_file_systems: Optional[Union[ReferenceType, List[ReferenceType]]] = None, local_file_systems: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, local_file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, local_file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, remote_file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, remote_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST file-system-replica-links

Create a file system replication link.

Parameters

• file_system_replica_link (FileSystemReplicaLink) – (required)

• remotes (ReferenceType or List[ReferenceType], optional) – A list of remotes to query for. Overrides remote_ids and remote_names keyword arguments.

• remote_file_systems (ReferenceType or List[ReferenceType], optional) – A list of remote_file_systems to query for. Overrides remote_file_system_names keyword argument.

• local_file_systems (ReferenceType or List[ReferenceType], optional) – A list of local_file_systems to query for. Overrides local_file_system_ids and local_file_system_names keyword arguments.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids keyword argument.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• local_file_system_ids (List[str]) – A comma-separated list of local file system IDs. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the local_file_system_names query parameter.

• local_file_system_names (List[str]) – A comma-separated list of local file system names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with local_file_system_ids query parameter.

• remote_file_system_names (List[str]) – A comma-separated list of remote file system names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_file_system_ids query parameter.

• remote_ids (List[str]) – A comma-separated list of remote array IDs. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_names query parameter.

• remote_names (List[str]) – A comma-separated list of remote array names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with remote_ids query parameter.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_file_system_replica_links_policies(remotes: Optional[Union[ReferenceType, List[ReferenceType]]] = None, policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, local_file_systems: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, local_file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, local_file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, remote_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST file-system-replica-links/policies

Add a policy to a file system replication link.

Parameters

• remotes (ReferenceType or List[ReferenceType], optional) – A list of remotes to query for. Overrides remote_ids and remote_names keyword arguments.

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids keyword argument.

• local_file_systems (ReferenceType or List[ReferenceType], optional) – A list of local_file_systems to query for. Overrides local_file_system_ids and local_file_system_names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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]) – A comma-separated list of local file system IDs. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the local_file_system_names query parameter.

• local_file_system_names (List[str]) – A comma-separated list of local file system names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with local_file_system_ids query parameter.

• member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (List[str]) – A comma-separated list of policy names.

• remote_ids (List[str]) – A comma-separated list of remote array IDs. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_names query parameter.

• remote_names (List[str]) – A comma-separated list of remote array names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with remote_ids query parameter.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_file_system_snapshots(sources: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, send: Optional[StrictBool] = None, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = None, targets: Optional[ConstrainedListValue[StrictStr]] = None, file_system_snapshot: Optional[FileSystemSnapshotPost] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST file-system-snapshots

Create a snapshot for a specified source file system. If a source file system is not specified, creates snapshots for all file systems on the array.

Parameters

• sources (ReferenceType or List[ReferenceType], optional) – A list of sources to query for. Overrides source_ids and source_names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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) – 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]) – A comma-separated list of source file system IDs. If after filtering, there is not at least one resource that matches each of the elements of source_ids, then an error is returned. This cannot be provided together with the names_or_sources or sources query parameters.

• source_names (List[str]) – A comma-separated list of names for the source of the object. If there is not at least one resource that matches each of the elements of source_names, an error is returned.

• targets (List[str]) – The target arrays to replicate created snapshots to. Only valid when send is true.

• file_system_snapshot (FileSystemSnapshotPost) –

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_file_systems(names: ConstrainedListValue[StrictStr], file_system: FileSystemPost, policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, default_exports: Optional[ConstrainedListValue[StrictStr]] = None, discard_non_snapshotted_data: Optional[StrictBool] = None, overwrite: Optional[StrictBool] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST file-systems

Create a file system on the current array.

Parameters

• names (List[str]) – A comma-separated list of resource names. (required)

• file_system (FileSystemPost) – (required)

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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]) – A comma-separated 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) – This parameter must be set to true in order to restore a file system from a snapshot or to demote a file system (which restores the file system from the common baseline snapshot). Setting this parameter to true is acknowledgement that any non-snapshotted data currently in the file system will be irretrievably lost.

• overwrite (bool) – When used for snapshot restore, overwrites (true) an existing file system.

• policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (List[str]) – A comma-separated list of policy names.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_file_systems_audit_policies(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST file-systems/audit-policies

Map a audit policy to a file system.

Parameters

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• member_names (List[str]) – A comma-separated list of member names.

• policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (List[str]) – A comma-separated list of policy names.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_file_systems_locks_nlm_reclamations(x_request_id: Optional[StrictStr] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Initiate NLM reclamation.

NLM reclamation is a system-wide operation, affecting all clients, and so only one may be in progress at a time. Attempting to initiate reclamation while one is in progress will result in an error. When NLM reclamation is initiated, all NLM locks are deleted and client applications are notified that they can reacquire their locks within a grace period.

Parameters

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_file_systems_policies(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST file-systems/policies

Apply a snapshot scheduling policy to a file system. Only one file system can be mapped to a policy at a time.

Parameters

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• member_names (List[str]) – A comma-separated list of member names.

• policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (List[str]) – A comma-separated list of policy names.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_fleets(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST fleets

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 (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique resource names specified. Supports exactly one value.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_fleets_fleet_key(x_request_id: Optional[StrictStr] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST fleet-key

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) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_fleets_members(fleets: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, fleet_ids: Optional[ConstrainedListValue[StrictStr]] = None, fleet_names: Optional[ConstrainedListValue[StrictStr]] = None, members: Optional[FleetMemberPost] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST fleets

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 (ReferenceType or List[ReferenceType], optional) – A list of fleets to query for. Overrides fleet_ids and fleet_names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• fleet_ids (List[str]) – Performs the operation on the unique Fleet IDs specified. This query currently accepts only 1 ID.

• fleet_names (List[str]) – 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.

• members (FleetMemberPost) – Info about the members being added to fleet.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_keytabs(keytab: KeytabPost, x_request_id: Optional[StrictStr] = None, name_prefixes: Optional[StrictStr] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST keytabs

Import a Kerberos keytab file from a Key Distribution Center.

Parameters

• keytab (KeytabPost) – (required)

• x_request_id (str) – Supplied by client during request or generated by server.

• name_prefixes (str) – The prefix to use for the names of all Kerberos keytab objects that are being created.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_keytabs_upload(keytab_file: StrictStr, x_request_id: Optional[StrictStr] = None, name_prefixes: Optional[StrictStr] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST keytabs/upload

Upload a Kerberos keytab file to the array. The file can be uploaded in the native binary format or a base64 encoded format. If not specified, defaults to binary. The procedure to upload a file may vary depending on the type of REST client.

Parameters

• keytab_file (str) – The keytab file to upload. (required)

• x_request_id (str) – Supplied by client during request or generated by server.

• name_prefixes (str) – The prefix to use for the names of all Kerberos keytab objects that are being created.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_kmip(kmip_server: KmipServer, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Create a KMIP server configuration

Creates a KMIP server configuration.

Parameters

• kmip_server (KmipServer) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_legal_holds(names: ConstrainedListValue[StrictStr], references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, hold: Optional[LegalHold] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Create a legal hold

Create a legal hold instance.

Parameters

• names (List[str]) – A comma-separated list of resource names. (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• hold (LegalHold) –

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_legal_holds_held_entities(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, file_systems: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, paths: Optional[ConstrainedListValue[StrictStr]] = None, recursive: Optional[StrictBool] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Apply this legal hold to a new entity

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

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

• file_systems (ReferenceType or List[ReferenceType], optional) – A list of file_systems to query for. Overrides file_system_ids and file_system_names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• file_system_ids (List[str]) – A comma-separated list of file system IDs. If after filtering, there is not at least one resource that matches each of the elements of file_system_ids, then an error is returned. This cannot be provided together with the file_system_names query parameter.

• file_system_names (List[str]) – A comma-separated list of file system names. If there is not at least one resource that matches each of the elements of file_system_names, then an error is returned.

• ids (List[str]) – A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of ids, then an error is returned. This cannot be provided together with the name or names query parameters.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• paths (List[str]) – A comma-separated 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) – 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) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_lifecycle_rules(rule: LifecycleRulePost, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, confirm_date: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST lifecycle-rules

Creates a lifecycle rule. bucket and keep_previous_version_for are required. If rule_id is not specified, it will be automatically generated in the format “fbRuleIdX”.

Parameters

• rule (LifecycleRulePost) – (required)

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• confirm_date (bool) – If set to true, then confirm the date of keep_current_version_until is correct.

• context_names (List[str]) – 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) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_link_aggregation_groups(names: ConstrainedListValue[StrictStr], link_aggregation_group: LinkAggregationGroup, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST link-aggregation-groups

Create a link aggregation group of Ethernet ports on the array.

Parameters

• names (List[str]) – A comma-separated list of resource names. (required)

• link_aggregation_group (LinkAggregationGroup) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_maintenance_windows(names: ConstrainedListValue[StrictStr], maintenance_window: MaintenanceWindowPost, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Create a maintenance window

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

• names (List[str]) – A comma-separated list of resource names. (required)

• maintenance_window (MaintenanceWindowPost) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_network_access_policies_rules(rule: NetworkAccessPolicyRulePost, policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, before_rule_id: Optional[StrictStr] = None, before_rule_name: Optional[StrictStr] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, versions: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST network-access-policies/rules

Create a new network access policy rule. Either policy_ids or policy_names parameter is required.

Parameters

• rule (NetworkAccessPolicyRulePost) – (required)

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• before_rule_id (str) – The id of the rule to insert or move a rule before. This cannot be provided together with the before_rule_name query parameter.

• before_rule_name (str) – The name of the rule to insert or move a rule before. This cannot be provided together with the before_rule_id query parameter.

• policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (List[str]) – A comma-separated list of policy names.

• versions (List[str]) – A comma-separated list of versions. This is an optional query param used for concurrency control. The ordering should match the names or ids query param. This will fail with a 412 Precondition failed if the resource was changed and the current version of the resource doesn’t match the value in the query param.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_network_interfaces(names: ConstrainedListValue[StrictStr], network_interface: NetworkInterface, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST network-interfaces

Create a VIP to export data or perform replication.

Parameters

• names (List[str]) – A comma-separated list of resource names. (required)

• network_interface (NetworkInterface) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_network_interfaces_tls_policies(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST network-interfaces/tls-policies

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

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• member_names (List[str]) – A comma-separated list of member names.

• policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (List[str]) – A comma-separated list of policy names.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_nfs_export_policies(names: ConstrainedListValue[StrictStr], contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, policy: Optional[NfsExportPolicyPost] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST nfs-export-policies

Create a new NFS export policy.

Parameters

• names (List[str]) – A comma-separated list of resource names. (required)

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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 (NfsExportPolicyPost) –

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_nfs_export_policies_rules(rule: NfsExportPolicyRule, policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, before_rule_id: Optional[StrictStr] = None, before_rule_name: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, versions: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST nfs-export-policies/rules

Add a NFS export policy rule. Rules are ordered in three groups; ip addresses, other and *. The new rule will be added at the end of the appropriate group if neither before_rule_id and before_rule_name are specified. Rules can only be inserted into the appropriate group. Either policy_ids or policy_names parameter is required.

Parameters

• rule (NfsExportPolicyRule) – (required)

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• before_rule_id (str) – The id of the rule to insert or move a rule before. This cannot be provided together with the before_rule_name query parameter.

• before_rule_name (str) – The name of the rule to insert or move a rule before. This cannot be provided together with the before_rule_id query parameter.

• context_names (List[str]) – 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]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (List[str]) – A comma-separated list of policy names.

• versions (List[str]) – A comma-separated list of versions. This is an optional query param used for concurrency control. The ordering should match the names or ids query param. This will fail with a 412 Precondition failed if the resource was changed and the current version of the resource doesn’t match the value in the query param.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_object_store_access_keys(object_store_access_key: ObjectStoreAccessKeyPost, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST object-store-access-keys

Create or import object store access keys.

Parameters

• object_store_access_key (ObjectStoreAccessKeyPost) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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]) – A comma-separated list of resource names to import. To import a set of credentials, this field must be specified with the secret_access_key body parameter. If both of these are not specified, the system will generate a new set of credentials.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_object_store_access_policies(names: ConstrainedListValue[StrictStr], contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, enforce_action_restrictions: Optional[StrictBool] = None, policy: Optional[ObjectStoreAccessPolicyPost] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST object-store-access-policies

Create a new access policy.

Parameters

• names (List[str]) – A comma-separated list of resource names. (required)

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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) – Certain combinations of actions and other rule elements are inherently ignored if specified together in a rule. If set to true, operations which attempt to set these combinations will fail. If set to false, such operations will instead be allowed. Defaults to true.

• policy (ObjectStoreAccessPolicyPost) –

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_object_store_access_policies_object_store_roles(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST object-store-access-policies/object-store-roles

Grant access policies to an object store role.

Parameters

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• member_names (List[str]) – A comma-separated list of member names.

• policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (List[str]) – A comma-separated list of policy names.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_object_store_access_policies_object_store_users(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST object-store-access-policies/object-store-users

Grant access policies to an object store user.

Parameters

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• member_names (List[str]) – A comma-separated list of member names.

• policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (List[str]) – A comma-separated list of policy names.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_object_store_access_policies_rules(names: ConstrainedListValue[StrictStr], rule: PolicyRuleObjectAccessPost, policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, enforce_action_restrictions: Optional[StrictBool] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST object-store-access-policies-rules

Create a new access policy rule.

Parameters

• names (List[str]) – A comma-separated list of resource names. (required)

• rule (PolicyRuleObjectAccessPost) – (required)

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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) – Certain combinations of actions and other rule elements are inherently ignored if specified together in a rule. If set to true, operations which attempt to set these combinations will fail. If set to false, such operations will instead be allowed. Defaults to true.

• policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (List[str]) – A comma-separated list of policy names.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_object_store_accounts(names: ConstrainedListValue[StrictStr], contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, object_store_account: Optional[ObjectStoreAccountPost] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST object-store-accounts

Create an object store account.

Parameters

• names (List[str]) – A comma-separated list of resource names. (required)

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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.

• object_store_account (ObjectStoreAccountPost) –

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_object_store_remote_credentials(names: ConstrainedListValue[StrictStr], remote_credentials: ObjectStoreRemoteCredentialsPost, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST object-store-remote-credentials

Create object store remote credentials to set up bucket replicat links to a remote array or target.

Parameters

• names (List[str]) – A comma-separated list of resource names. (required)

• remote_credentials (ObjectStoreRemoteCredentialsPost) – (required)

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_object_store_roles(names: ConstrainedListValue[StrictStr], object_store_role: ObjectStoreRolePost, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST object-store-roles

Create new object store roles.

Parameters

• names (List[str]) – A comma-separated list of resource names. (required)

• object_store_role (ObjectStoreRolePost) – (required)

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_object_store_roles_object_store_access_policies(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST object-store-roles/object-store-access-policies

Grant access policies to an object store role.

Parameters

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• member_names (List[str]) – A comma-separated list of member names.

• policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (List[str]) – A comma-separated list of policy names.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_object_store_roles_object_store_trust_policies_rules(rule: TrustPolicyRulePost, roles: Optional[Union[ReferenceType, List[ReferenceType]]] = None, policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, role_ids: Optional[ConstrainedListValue[StrictStr]] = None, role_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST object-store-roles/object-store-trust-policies/rules

Create a new trust policy rule.

Parameters

• rule (TrustPolicyRulePost) – (required)

• roles (ReferenceType or List[ReferenceType], optional) – A list of roles to query for. Overrides role_ids and role_names keyword arguments.

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_names keyword argument.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• policy_names (List[str]) – A comma-separated list of policy names.

• role_ids (List[str]) – A comma-separated 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]) – A comma-separated 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) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_object_store_users(names: ConstrainedListValue[StrictStr], contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, full_access: Optional[StrictBool] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST object-store-users

Create object store users to administer object storage for an object store account.

Parameters

• names (List[str]) – A comma-separated list of resource names. (required)

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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) – 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) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_object_store_users_object_store_access_policies(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST object-store-users/object-store-access-policies

Grant access policies to an object store user.

Parameters

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• member_names (List[str]) – A comma-separated list of member names.

• policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (List[str]) – A comma-separated list of policy names.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_object_store_virtual_hosts(names: ConstrainedListValue[StrictStr], contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST object-store-virtual-hosts

Create an object store virtual host. An example of a hostname is buckethost.example.com. A hostname cannot exceed 255 characters in length, it cannot be an IP address, only 10 hostnames are supported, supersets or subsets of existing hostnames with the same root are not allowed. The default hostname is s3.amazonaws.com and it cannot be deleted.

Parameters

• names (List[str]) – A comma-separated list of resource names. (required)

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_policies(names: ConstrainedListValue[StrictStr], contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, policy: Optional[Policy] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST policies

Create a new snapshot scheduling policy with rule attributes to capture file system snapshots for a set period of time and frequency, as well as how long snapshots are retained before being destroyed and eradicated.

Parameters

• names (List[str]) – A comma-separated list of resource names. (required)

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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 (Policy) –

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_policies_file_system_replica_links(remotes: Optional[Union[ReferenceType, List[ReferenceType]]] = None, policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, local_file_systems: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, local_file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, local_file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, remote_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST policies/file-system-replica-links

Add a snapshot scheduling policy to a file system replica link.

Parameters

• remotes (ReferenceType or List[ReferenceType], optional) – A list of remotes to query for. Overrides remote_ids and remote_names keyword arguments.

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids keyword argument.

• local_file_systems (ReferenceType or List[ReferenceType], optional) – A list of local_file_systems to query for. Overrides local_file_system_ids and local_file_system_names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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]) – A comma-separated list of local file system IDs. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the local_file_system_names query parameter.

• local_file_system_names (List[str]) – A comma-separated list of local file system names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with local_file_system_ids query parameter.

• member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (List[str]) – A comma-separated list of policy names.

• remote_ids (List[str]) – A comma-separated list of remote array IDs. If after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_names query parameter.

• remote_names (List[str]) – A comma-separated list of remote array names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with remote_ids query parameter.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_policies_file_systems(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST policies/file-systems

Map a file system to a snapshot scheduling policy.

Parameters

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• member_names (List[str]) – A comma-separated list of member names.

• policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (List[str]) – A comma-separated list of policy names.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_public_keys(names: ConstrainedListValue[StrictStr], public_key: PublicKeyPost, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Create public key configurations

Creates public key configurations.

Parameters

• names (List[str]) – A comma-separated list of resource names. (required)

• public_key (PublicKeyPost) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_qos_policies(names: ConstrainedListValue[StrictStr], policy: QosPolicy, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST qos-policies

Create a QoS policy.

Parameters

• names (List[str]) – A comma-separated list of resource names. (required)

• policy (QosPolicy) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_quotas_groups(groups: Optional[Union[ReferenceType, List[ReferenceType]]] = None, file_systems: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, gids: Optional[ConstrainedListValue[StrictInt]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, quota: Optional[GroupQuotaPost] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST quotas/groups

Create a hard limit quota for a group.

Parameters

• groups (ReferenceType or List[ReferenceType], optional) – A list of groups to query for. Overrides group_names keyword argument.

• file_systems (ReferenceType or List[ReferenceType], optional) – A list of file_systems to query for. Overrides file_system_ids and file_system_names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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]) – A comma-separated list of file system IDs. If after filtering, there is not at least one resource that matches each of the elements of file_system_ids, then an error is returned. This cannot be provided together with the file_system_names query parameter.

• file_system_names (List[str]) – A comma-separated list of file system names. If there is not at least one resource that matches each of the elements of file_system_names, then an error is returned.

• gids (List[int]) – A comma-separated list of group IDs. If there is not at least one resource that matches each of the elements of gids, then an error is returned. This cannot be provided together with group_names query parameter.

• group_names (List[str]) – A comma-separated list of group names. If there is not at least one resource that matches each of the elements of group_names, then an error is returned. This cannot be provided together with gids query parameter.

• quota (GroupQuotaPost) –

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_quotas_users(users: Optional[Union[ReferenceType, List[ReferenceType]]] = None, file_systems: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, uids: Optional[ConstrainedListValue[StrictInt]] = None, user_names: Optional[ConstrainedListValue[StrictStr]] = None, quota: Optional[UserQuotaPost] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST quotas/users

Create a hard limit file system quota for a user.

Parameters

• users (ReferenceType or List[ReferenceType], optional) – A list of users to query for. Overrides user_names keyword argument.

• file_systems (ReferenceType or List[ReferenceType], optional) – A list of file_systems to query for. Overrides file_system_ids and file_system_names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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]) – A comma-separated list of file system IDs. If after filtering, there is not at least one resource that matches each of the elements of file_system_ids, then an error is returned. This cannot be provided together with the file_system_names query parameter.

• file_system_names (List[str]) – A comma-separated list of file system names. If there is not at least one resource that matches each of the elements of file_system_names, then an error is returned.

• uids (List[int]) – A comma-separated list of user IDs. If there is not at least one resource that matches each of the elements of uids, then an error is returned. This cannot be provided together with user_names query parameter.

• user_names (List[str]) – A comma-separated list of user names. If there is not at least one resource that matches each of the elements of user_names, then an error is returned. This cannot be provided together with uids query parameter.

• quota (UserQuotaPost) –

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_rapid_data_locking_rotate(x_request_id: Optional[StrictStr] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Rotates the external keys on the associated EKM appliance.

Rotates the external keys on the associated EKM appliance.

Parameters

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_servers(create_ds: StrictStr, names: ConstrainedListValue[StrictStr], server: ServerPost, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST servers

Add a server.

Parameters

• create_ds (str) – 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. (required)

• names (List[str]) – A comma-separated list of resource names. (required)

• server (ServerPost) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_smb_client_policies(names: ConstrainedListValue[StrictStr], contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, policy: Optional[SmbClientPolicyPost] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST smb-client-policies

Create a new SMB Client policy.

Parameters

• names (List[str]) – A comma-separated list of resource names. (required)

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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 (SmbClientPolicyPost) –

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_smb_client_policies_rules(rule: SmbClientPolicyRulePost, policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, before_rule_id: Optional[StrictStr] = None, before_rule_name: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, versions: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST smb-client-policies/rules

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

• rule (SmbClientPolicyRulePost) – (required)

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• before_rule_id (str) – The id of the rule to insert or move a rule before. This cannot be provided together with the before_rule_name query parameter.

• before_rule_name (str) – The name of the rule to insert or move a rule before. This cannot be provided together with the before_rule_id query parameter.

• context_names (List[str]) – 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]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (List[str]) – A comma-separated list of policy names.

• versions (List[str]) – A comma-separated list of versions. This is an optional query param used for concurrency control. The ordering should match the names or ids query param. This will fail with a 412 Precondition failed if the resource was changed and the current version of the resource doesn’t match the value in the query param.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_smb_share_policies(names: ConstrainedListValue[StrictStr], contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, policy: Optional[SmbSharePolicyPost] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST smb-share-policies

Create a new SMB Share policy.

Parameters

• names (List[str]) – A comma-separated list of resource names. (required)

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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 (SmbSharePolicyPost) –

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_smb_share_policies_rules(rule: SmbSharePolicyRulePost, policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST smb-share-policies/rules

Add an SMB Share policy rule. The policy_ids or policy_names parameter is required, but they cannot be set together.

Parameters

• rule (SmbSharePolicyRulePost) – (required)

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (List[str]) – A comma-separated list of policy names.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_snmp_managers(names: ConstrainedListValue[StrictStr], snmp_manager: SnmpManagerPost, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST snmp-managers

Create an SNMP manager.

Parameters

• names (List[str]) – A comma-separated list of resource names. (required)

• snmp_manager (SnmpManagerPost) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_software_check(softwares: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, software_names: Optional[ConstrainedListValue[StrictStr]] = None, software_versions: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Create a software check task

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 (ReferenceType or List[ReferenceType], optional) – A list of softwares to query for. Overrides software_names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• software_names (List[str]) – A comma-separated list of software names.

• software_versions (List[str]) – A comma-separated list of target software versions.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_ssh_certificate_authority_policies(names: ConstrainedListValue[StrictStr], policy: SshCertificateAuthorityPolicyPost, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Create SSH Certificate Authority configurations

Creates SSH Certificate Authority configurations.

Parameters

• names (List[str]) – A comma-separated list of resource names. (required)

• policy (SshCertificateAuthorityPolicyPost) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_ssh_certificate_authority_policies_admins(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST ssh-certificate-authority-policies/admins

Map a SSH Certificate Authority policy to a specific user.

Parameters

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• member_names (List[str]) – A comma-separated list of member names.

• policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (List[str]) – A comma-separated list of policy names.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_ssh_certificate_authority_policies_arrays(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST ssh-certificate-authority-policies/arrays

Map a SSH Certificate Authority policy as a default for admins.

Parameters

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• member_names (List[str]) – A comma-separated list of member names.

• policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (List[str]) – A comma-separated list of policy names.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_sso_oidc_idps(idp: OidcSsoPost, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Create OIDC SSO configuration

Create OIDC SSO configuration.

Parameters

• idp (OidcSsoPost) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – A comma-separated list of resource names. If there is not at least one resource that matches each of the elements of names, then an error is returned.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_sso_saml2_idps(names: ConstrainedListValue[StrictStr], idp: Saml2SsoPost, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Create SAML2 SSO configurations

Creates SAML2 SSO configurations.

Parameters

• names (List[str]) – A comma-separated list of resource names. (required)

• idp (Saml2SsoPost) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_subnets(names: ConstrainedListValue[StrictStr], subnet: Subnet, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST subnets

Create an array subnet.

Parameters

• names (List[str]) – A comma-separated list of resource names. (required)

• subnet (Subnet) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_support_diagnostics(x_request_id: Optional[StrictStr] = None, analysis_period_end_time: Optional[ConstrainedIntValue] = None, analysis_period_start_time: Optional[ConstrainedIntValue] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Start a diagnostic task

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) – Supplied by client during request or generated by server.

• analysis_period_end_time (int) – When the analysis time window ends (in milliseconds since epoch).

• analysis_period_start_time (int) – When the analysis time window starts (in milliseconds since epoch).

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_syslog_servers(syslog_server: SyslogServerPost, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST syslog-servers

Configure a new syslog server.

Parameters

• syslog_server (SyslogServerPost) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_targets(names: ConstrainedListValue[StrictStr], target: TargetPost, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST targets

Add a target for replication.

Parameters

• names (List[str]) – A comma-separated list of resource names. (required)

• target (TargetPost) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_tls_policies(names: ConstrainedListValue[StrictStr], policy: TlsPolicyPost, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Create TLS policies

Creates TLS policies.

Parameters

• names (List[str]) – A comma-separated list of resource names. (required)

• policy (TlsPolicyPost) – (required)

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_tls_policies_network_interfaces(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST tls-policies/network-interfaces

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

• policies (ReferenceType or List[ReferenceType], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

• members (ReferenceType or List[ReferenceType], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

• x_request_id (str) – Supplied by client during request or generated by server.

• member_ids (List[str]) – A comma-separated list of member IDs. If after filtering, there is not at least one resource that matches each of the elements of member_ids, then an error is returned. This cannot be provided together with the member_names query parameter.

• member_names (List[str]) – A comma-separated list of member names.

• policy_ids (List[str]) – A comma-separated list of policy IDs. If after filtering, there is not at least one resource that matches each of the elements of policy_ids, then an error is returned. This cannot be provided together with the policy_names query parameter.

• policy_names (List[str]) – A comma-separated list of policy names.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_worm_data_policies(names: ConstrainedListValue[StrictStr], contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, policy: Optional[WormDataPolicy] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

POST worm-data-policies

Create a WORM data policy.

Parameters

• names (List[str]) – A comma-separated list of resource names. (required)

• contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

• references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

• x_request_id (str) – Supplied by client during request or generated by server.

• context_names (List[str]) – 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 (WormDataPolicy) –

• async_req (bool, optional) – Whether to execute the request asynchronously.

• async_req – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

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

ReferenceType

pydantic model pypureclient.flashblade.ReferenceType(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None)

It’s used for reference arg on api function. This allows user to pass collections of Model objects to the method without transforming them to ids or names.

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified.

field name: Optional[StrictStr] = None

The resource name, such as volume name, pod name, snapshot name, and so on.

ActiveDirectory

pydantic model pypureclient.flashblade.ActiveDirectory(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, computer_name: Optional[StrictStr] = None, directory_servers: Optional[ConstrainedListValue[StrictStr]] = None, domain: Optional[StrictStr] = None, encryption_types: Optional[ConstrainedListValue[StrictStr]] = None, global_catalog_servers: Optional[ConstrainedListValue[StrictStr]] = None, join_ou: Optional[StrictStr] = None, kerberos_servers: Optional[ConstrainedListValue[StrictStr]] = None, server: Optional[FixedReference] = None, service_principal_names: Optional[ConstrainedListValue[ConstrainedStrValue]] = None)

field computer_name: Optional[StrictStr] = None

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.

field directory_servers: Optional[ConstrainedListValue[StrictStr]] = None

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.

field domain: Optional[StrictStr] = None

The Active Directory domain to join.

field encryption_types: Optional[ConstrainedListValue[StrictStr]] = None

The encryption types that are supported for use by clients for Kerberos authentication.

field global_catalog_servers: Optional[ConstrainedListValue[StrictStr]] = None

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.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field join_ou: Optional[StrictStr] = None

The relative distinguished name of the organizational unit in which the computer account was created when joining the domain.

field kerberos_servers: Optional[ConstrainedListValue[StrictStr]] = None

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.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field server: Optional[FixedReference] = None

The server containing this active directory account.

field service_principal_names: Optional[ConstrainedListValue[ConstrainedStrValue]] = None

A list of service principal names registered for the machine account, which can be used for the creation of keys for Kerberos authentication.

ActiveDirectoryDirectoryServers

pydantic model pypureclient.flashblade.ActiveDirectoryDirectoryServers(*, directory_servers: Optional[ConstrainedListValue[StrictStr]] = None, global_catalog_servers: Optional[ConstrainedListValue[StrictStr]] = None)

field directory_servers: Optional[ConstrainedListValue[StrictStr]] = None

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.

Constraints

• maxItems = 50

field global_catalog_servers: Optional[ConstrainedListValue[StrictStr]] = None

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.

Constraints

• maxItems = 50

ActiveDirectoryGetResponse

pydantic model pypureclient.flashblade.ActiveDirectoryGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[ActiveDirectory]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[ActiveDirectory]] = None

A list of Active Directory computer account configuration objects.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

ActiveDirectoryPatch

pydantic model pypureclient.flashblade.ActiveDirectoryPatch(*, directory_servers: Optional[ConstrainedListValue[StrictStr]] = None, global_catalog_servers: Optional[ConstrainedListValue[StrictStr]] = None, encryption_types: Optional[ConstrainedListValue[StrictStr]] = None, fqdns: Optional[ConstrainedListValue[StrictStr]] = None, join_ou: Optional[StrictStr] = None, kerberos_servers: Optional[ConstrainedListValue[StrictStr]] = None, service_principal_names: Optional[ConstrainedListValue[ConstrainedStrValue]] = None)

field directory_servers: Optional[ConstrainedListValue[StrictStr]] = None

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.

Constraints

• maxItems = 5

field encryption_types: Optional[ConstrainedListValue[StrictStr]] = None

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.

field fqdns: Optional[ConstrainedListValue[StrictStr]] = None

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.

Constraints

• maxItems = 32

field global_catalog_servers: Optional[ConstrainedListValue[StrictStr]] = None

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.

Constraints

• maxItems = 50

field join_ou: Optional[StrictStr] = None

The relative distinguished name of the organizational unit in which the computer account should be created when joining the domain.

field kerberos_servers: Optional[ConstrainedListValue[StrictStr]] = None

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.

Constraints

• maxItems = 5

field service_principal_names: Optional[ConstrainedListValue[ConstrainedStrValue]] = None

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.

Constraints

• maxItems = 32

ActiveDirectoryPost

pydantic model pypureclient.flashblade.ActiveDirectoryPost(*, directory_servers: Optional[ConstrainedListValue[StrictStr]] = None, global_catalog_servers: Optional[ConstrainedListValue[StrictStr]] = None, computer_name: Optional[StrictStr] = None, domain: StrictStr, encryption_types: Optional[ConstrainedListValue[StrictStr]] = None, fqdns: Optional[ConstrainedListValue[StrictStr]] = None, join_ou: Optional[StrictStr] = None, kerberos_servers: Optional[ConstrainedListValue[StrictStr]] = None, password: StrictStr, service_principal_names: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, user: StrictStr)

field computer_name: Optional[StrictStr] = None

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.

field directory_servers: Optional[ConstrainedListValue[StrictStr]] = None

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.

Constraints

• maxItems = 5

field domain: StrictStr [Required]

The Active Directory domain to join.

field encryption_types: Optional[ConstrainedListValue[StrictStr]] = None

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.

field fqdns: Optional[ConstrainedListValue[StrictStr]] = None

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.

Constraints

• maxItems = 32

field global_catalog_servers: Optional[ConstrainedListValue[StrictStr]] = None

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.

Constraints

• maxItems = 50

field join_ou: Optional[StrictStr] = None

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.

field kerberos_servers: Optional[ConstrainedListValue[StrictStr]] = None

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.

Constraints

• maxItems = 5

field password: StrictStr [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.

field service_principal_names: Optional[ConstrainedListValue[ConstrainedStrValue]] = None

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.

Constraints

• maxItems = 32

field user: StrictStr [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.

ActiveDirectoryResponse

pydantic model pypureclient.flashblade.ActiveDirectoryResponse(*, items: Optional[ConstrainedListValue[ActiveDirectory]] = None)

field items: Optional[ConstrainedListValue[ActiveDirectory]] = None

A list of Active Directory computer account configuration objects.

Admin

pydantic model pypureclient.flashblade.Admin(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, api_token: Optional[ApiToken] = None, is_local: Optional[StrictBool] = None, locked: Optional[StrictBool] = None, lockout_remaining: Optional[StrictInt] = None, public_key: Optional[StrictStr] = None, role: Optional[Reference] = None)

field api_token: Optional[ApiToken] = None

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field is_local: Optional[StrictBool] = None

Returns a value of true if the user is local to the machine, otherwise false.

Constraints

• type = boolean

field locked: Optional[StrictBool] = None

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.

Constraints

• type = boolean

field lockout_remaining: Optional[StrictInt] = None

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.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field public_key: Optional[StrictStr] = None

Public key for SSH access. Supported key types are Ed25519 and RSA.

field role: Optional[Reference] = None

A reference to this administrator’s management role.

AdminApiToken

pydantic model pypureclient.flashblade.AdminApiToken(*, admin: Optional[Reference] = None, api_token: Optional[ApiToken] = None)

field admin: Optional[Reference] = None

A reference to the admin to whom this token belongs.

field api_token: Optional[ApiToken] = None

AdminApiTokenGetResponse

pydantic model pypureclient.flashblade.AdminApiTokenGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[AdminApiToken]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[AdminApiToken]] = None

A list of administrator API tokens.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

AdminApiTokenResponse

pydantic model pypureclient.flashblade.AdminApiTokenResponse(*, items: Optional[ConstrainedListValue[AdminApiToken]] = None)

field items: Optional[ConstrainedListValue[AdminApiToken]] = None

A list of administrator API tokens.

AdminCache

pydantic model pypureclient.flashblade.AdminCache(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, role: Optional[FixedReference] = None, time: Optional[StrictInt] = None)

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field role: Optional[FixedReference] = None

A reference to the role of this user.

field time: Optional[StrictInt] = None

Time the role was cached in milliseconds since UNIX epoch.

AdminCacheGetResponse

pydantic model pypureclient.flashblade.AdminCacheGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[AdminCache]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[AdminCache]] = None

A list of admin cache entries.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

AdminGetResponse

pydantic model pypureclient.flashblade.AdminGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Admin]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[Admin]] = None

A list of administrative account objects.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

AdminPatch

pydantic model pypureclient.flashblade.AdminPatch(*, locked: Optional[StrictBool] = None, old_password: Optional[StrictStr] = None, password: Optional[StrictStr] = None, public_key: Optional[StrictStr] = None, role: Optional[ReferenceWritable] = None)

field locked: Optional[StrictBool] = None

If set to false, the specified user is unlocked. Setting to true is not allowed.

Constraints

• type = boolean

field old_password: Optional[StrictStr] = None

Old user password.

field password: Optional[StrictStr] = None

New user password.

field public_key: Optional[StrictStr] = None

Public key for SSH access. Supported key types are Ed25519 and RSA.

field role: Optional[ReferenceWritable] = None

A reference to this administrator’s management role. This may only be modified for non-built-in users for whom is_local is true.

AdminPost

pydantic model pypureclient.flashblade.AdminPost(*, password: Optional[StrictStr] = None, public_key: Optional[StrictStr] = None, role: Optional[ReferenceWritable] = None)

An administrative user, who has rights to login and manage the array in some capacity.

field password: Optional[StrictStr] = None

New user password.

field public_key: Optional[StrictStr] = None

Public key for SSH access. Supported key types include Ed25519 and RSA.

field role: Optional[ReferenceWritable] = None

A reference to this administrator’s management role.

AdminResponse

pydantic model pypureclient.flashblade.AdminResponse(*, items: Optional[ConstrainedListValue[Admin]] = None)

field items: Optional[ConstrainedListValue[Admin]] = None

A list of administrative account objects.

AdminSetting

pydantic model pypureclient.flashblade.AdminSetting(*, lockout_duration: Optional[ConstrainedIntValue] = None, max_login_attempts: Optional[ConstrainedIntValue] = None, min_password_length: Optional[ConstrainedIntValue] = None)

field lockout_duration: Optional[ConstrainedIntValue] = None

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.

Constraints

• minimum = 0

• maximum = 7776000000

field max_login_attempts: Optional[ConstrainedIntValue] = None

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.

Constraints

• minimum = 0

• maximum = 100

field min_password_length: Optional[ConstrainedIntValue] = None

The minimum password length. If not specified, defaults to 1 character.

Constraints

• minimum = 1

• maximum = 100

AdminSettingsGetResponse

pydantic model pypureclient.flashblade.AdminSettingsGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[AdminSetting]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[AdminSetting]] = None

Returns global admin settings.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

AdminSettingsResponse

pydantic model pypureclient.flashblade.AdminSettingsResponse(*, items: Optional[ConstrainedListValue[AdminSetting]] = None)

field items: Optional[ConstrainedListValue[AdminSetting]] = None

Returns global admin settings.

Alert

pydantic model pypureclient.flashblade.Alert(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, action: Optional[StrictStr] = None, code: Optional[StrictInt] = None, component_name: Optional[StrictStr] = None, component_type: Optional[StrictStr] = None, created: Optional[StrictInt] = None, description: Optional[StrictStr] = None, flagged: Optional[StrictBool] = None, index: Optional[StrictInt] = None, knowledge_base_url: Optional[StrictStr] = None, notified: Optional[StrictInt] = None, severity: Optional[StrictStr] = None, state: Optional[StrictStr] = None, summary: Optional[StrictStr] = None, updated: Optional[StrictInt] = None, variables: Optional[Dict[str, StrictStr]] = None)

field action: Optional[StrictStr] = None

The action of the alert.

field code: Optional[StrictInt] = None

Alert code.

field component_name: Optional[StrictStr] = None

The component name of the alert.

field component_type: Optional[StrictStr] = None

The component type of the alert.

field created: Optional[StrictInt] = None

The creation timestamp of the alert.

field description: Optional[StrictStr] = None

The description of the alert.

field flagged: Optional[StrictBool] = None

Flagged state of the alert.

Constraints

• type = boolean

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field index: Optional[StrictInt] = None

The unique index of the alert.

field knowledge_base_url: Optional[StrictStr] = None

URL of the relevant Knowledge Base page.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field notified: Optional[StrictInt] = None

The last notification timestamp of the alert.

field severity: Optional[StrictStr] = None

Severity of the alert. Valid values are info, warning, and critical.

field state: Optional[StrictStr] = None

The current state of the alert. Valid values are open, closing, closed, and waiting to downgrade.

field summary: Optional[StrictStr] = None

The summary of the alert.

field updated: Optional[StrictInt] = None

The last updated timestamp of the alert.

field variables: Optional[Dict[str, StrictStr]] = None

Key-value pairs of additional information of the alert.

AlertGetResponse

pydantic model pypureclient.flashblade.AlertGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Alert]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[Alert]] = None

A list of alert objects.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

AlertResponse

pydantic model pypureclient.flashblade.AlertResponse(*, items: Optional[ConstrainedListValue[Alert]] = None)

field items: Optional[ConstrainedListValue[Alert]] = None

A list of alert objects.

AlertWatcher

pydantic model pypureclient.flashblade.AlertWatcher(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, enabled: Optional[StrictBool] = None, minimum_notification_severity: Optional[StrictStr] = None)

field enabled: Optional[StrictBool] = None

Is email notification enabled? If not specified, defaults to true.

Constraints

• type = boolean

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field minimum_notification_severity: Optional[StrictStr] = None

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.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

AlertWatcherGetResponse

pydantic model pypureclient.flashblade.AlertWatcherGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[AlertWatcher]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[AlertWatcher]] = None

A list of alert watcher objects.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

AlertWatcherPost

pydantic model pypureclient.flashblade.AlertWatcherPost(*, minimum_notification_severity: Optional[StrictStr] = None)

field minimum_notification_severity: Optional[StrictStr] = None

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.

AlertWatcherResponse

pydantic model pypureclient.flashblade.AlertWatcherResponse(*, items: Optional[ConstrainedListValue[AlertWatcher]] = None)

field items: Optional[ConstrainedListValue[AlertWatcher]] = None

A list of alert watcher objects.

Api217LinkAggregationGroupsPatchRequest

pydantic model pypureclient.flashblade.Api217LinkAggregationGroupsPatchRequest(*, ports: Optional[ConstrainedListValue[FixedReference]] = None, add_ports: Optional[ConstrainedListValue[FixedReference]] = None, remove_ports: Optional[ConstrainedListValue[FixedReference]] = None)

field add_ports: Optional[ConstrainedListValue[FixedReference]] = None

field ports: Optional[ConstrainedListValue[FixedReference]] = None

field remove_ports: Optional[ConstrainedListValue[FixedReference]] = None

ApiClient

pydantic model pypureclient.flashblade.ApiClient(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, access_token_ttl_in_ms: Optional[StrictInt] = None, enabled: Optional[StrictBool] = None, issuer: Optional[StrictStr] = None, key_id: Optional[StrictStr] = None, max_role: Optional[FixedReference] = None, public_key: Optional[StrictStr] = None)

field access_token_ttl_in_ms: Optional[StrictInt] = None

The TTL (Time To Live) duration for which the exchanged access token is valid. Measured in milliseconds.

field enabled: Optional[StrictBool] = None

If true, the API client is permitted to exchange ID Tokens for access tokens. API clients are disabled by default.

Constraints

• type = boolean

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field issuer: Optional[StrictStr] = None

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.

field key_id: Optional[StrictStr] = None

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.

field max_role: Optional[FixedReference] = None

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.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field public_key: Optional[StrictStr] = None

The API client’s PEM formatted (Base64 encoded) RSA public key.

ApiClientsPost

pydantic model pypureclient.flashblade.ApiClientsPost(*, access_token_ttl_in_ms: Optional[StrictInt] = None, issuer: Optional[StrictStr] = None, max_role: ReferenceWritable, public_key: StrictStr)

field access_token_ttl_in_ms: Optional[StrictInt] = None

The TTL (Time To Live) duration for which the exchanged access token is valid. Measured in milliseconds. If not specified, defaults to 86400000.

field issuer: Optional[StrictStr] = None

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.

field 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.

field public_key: StrictStr [Required]

The API client’s PEM formatted (Base64 encoded) RSA public key. It must include the —–BEGIN PUBLIC KEY—– and —–END PUBLIC KEY—– lines.

ApiClientsResponse

pydantic model pypureclient.flashblade.ApiClientsResponse(*, items: Optional[ConstrainedListValue[ApiClient]] = None)

field items: Optional[ConstrainedListValue[ApiClient]] = None

ApiToken

pydantic model pypureclient.flashblade.ApiToken(*, created_at: Optional[StrictInt] = None, expires_at: Optional[StrictInt] = None, token: Optional[StrictStr] = None)

API token

field created_at: Optional[StrictInt] = None

Creation time in milliseconds since the UNIX epoch.

field expires_at: Optional[StrictInt] = None

Expiration time in milliseconds since the UNIX epoch.

field token: Optional[StrictStr] = None

An Admin API token. A newly-created token is visible as the result of the POST operation which created it. An existing token is visible when expose_api_token is true and it is being requested by the user to whom it belongs. In all other cases, the token will be masked.

ApiVersion

pydantic model pypureclient.flashblade.ApiVersion(*, versions: Optional[ConstrainedListValue[StrictStr]] = None)

field versions: Optional[ConstrainedListValue[StrictStr]] = None

A list of supported API versions.

Array

pydantic model pypureclient.flashblade.Array(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, _as_of: Optional[StrictInt] = None, banner: Optional[StrictStr] = None, default_inbound_tls_policy: Optional[ReferenceWritable] = None, encryption: Optional[ArrayEncryption] = None, eradication_config: Optional[ArrayEradicationConfig] = None, idle_timeout: Optional[StrictInt] = None, network_access_policy: Optional[FixedReference] = None, ntp_servers: Optional[ConstrainedListValue[StrictStr]] = None, os: Optional[StrictStr] = None, product_type: Optional[StrictStr] = None, revision: Optional[StrictStr] = None, security_update: Optional[StrictStr] = None, smb_mode: Optional[StrictStr] = None, time_zone: Optional[StrictStr] = None, version: Optional[StrictStr] = None)

field as_of: Optional[StrictInt] = None (alias '_as_of')

Array time in milliseconds since UNIX epoch.

field banner: Optional[StrictStr] = None

A string to be shown when logging in to the array.

field default_inbound_tls_policy: Optional[ReferenceWritable] = None

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.

field encryption: Optional[ArrayEncryption] = None

field eradication_config: Optional[ArrayEradicationConfig] = None

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field idle_timeout: Optional[StrictInt] = None

Idle timeout in milliseconds. Valid values are in the range of 300000 and 10800000. Setting this value to 0 disables timeouts.

field name: Optional[StrictStr] = None

A name chosen by the user. Can be changed. Must be locally unique.

field network_access_policy: Optional[FixedReference] = None

The network access policy governing which clients are allowed or denied access to different array interfaces.

field ntp_servers: Optional[ConstrainedListValue[StrictStr]] = None

field os: Optional[StrictStr] = None

Valid values are Purity//FA and Purity//FB.

field product_type: Optional[StrictStr] = None

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.

field revision: Optional[StrictStr] = None

field security_update: Optional[StrictStr] = None

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.

field smb_mode: Optional[StrictStr] = None

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.

field time_zone: Optional[StrictStr] = None

The time zone to use for the array. In particular this affects the CLI formatting and the default snapshot policy time zone.

field version: Optional[StrictStr] = None

ArrayConnection

pydantic model pypureclient.flashblade.ArrayConnection(*, id: Optional[StrictStr] = None, context: Optional[Reference] = None, ca_certificate_group: Optional[FixedReference] = None, encrypted: Optional[StrictBool] = None, management_address: Optional[StrictStr] = None, os: Optional[StrictStr] = None, remote: Optional[FixedReference] = None, replication_addresses: Optional[ConstrainedListValue[StrictStr]] = None, status: Optional[StrictStr] = None, throttle: Optional[Throttle] = None, type: Optional[StrictStr] = None, version: Optional[StrictStr] = None)

field ca_certificate_group: Optional[FixedReference] = None

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.

field context: Optional[Reference] = None

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.

field encrypted: Optional[StrictBool] = None

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.

Constraints

• type = boolean

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field management_address: Optional[StrictStr] = None

Management address of the target array. Settable on POST only.

field os: Optional[StrictStr] = None

The operating system of the connected array.

field remote: Optional[FixedReference] = None

The remote array.

field replication_addresses: Optional[ConstrainedListValue[StrictStr]] = None

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.

field status: Optional[StrictStr] = None

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.

field throttle: Optional[Throttle] = None

field type: Optional[StrictStr] = None

The type of connection. Valid values include async-replication and fleet-management.

field version: Optional[StrictStr] = None

The version of the target array.

ArrayConnectionGetResponse

pydantic model pypureclient.flashblade.ArrayConnectionGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[ArrayConnection]] = None, errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[ArrayConnection]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

ArrayConnectionKey

pydantic model pypureclient.flashblade.ArrayConnectionKey(*, connection_key: Optional[StrictStr] = None, created: Optional[StrictInt] = None, expires: Optional[StrictInt] = None)

field connection_key: Optional[StrictStr] = None

Connection-key, used on another array to connect to this array. After creation, listing will only show ****.

field created: Optional[StrictInt] = None

Creation time in milliseconds since UNIX epoch.

field expires: Optional[StrictInt] = None

Expiration time in milliseconds since UNIX epoch.

ArrayConnectionKeyGetResponse

pydantic model pypureclient.flashblade.ArrayConnectionKeyGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[ArrayConnectionKey]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[ArrayConnectionKey]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

ArrayConnectionKeyResponse

pydantic model pypureclient.flashblade.ArrayConnectionKeyResponse(*, items: Optional[ConstrainedListValue[ArrayConnectionKey]] = None)

field items: Optional[ConstrainedListValue[ArrayConnectionKey]] = None

ArrayConnectionPath

pydantic model pypureclient.flashblade.ArrayConnectionPath(*, id: Optional[StrictStr] = None, context: Optional[Reference] = None, destination: Optional[StrictStr] = None, remote: Optional[FixedReference] = None, source: Optional[StrictStr] = None, status: Optional[StrictStr] = None, status_details: Optional[StrictStr] = None, type: Optional[StrictStr] = None)

field context: Optional[Reference] = None

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.

field destination: Optional[StrictStr] = None

IP address with the port of the target array.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field remote: Optional[FixedReference] = None

The remote array.

field source: Optional[StrictStr] = None

IP address of the source array.

field status: Optional[StrictStr] = None

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.

field status_details: Optional[StrictStr] = None

Additional information describing any issues encountered when connecting, or null if the status is connected.

field type: Optional[StrictStr] = None

The type of path. Valid values include async-replication and fleet-management.

ArrayConnectionPathGetResponse

pydantic model pypureclient.flashblade.ArrayConnectionPathGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None, items: Optional[ConstrainedListValue[ArrayConnectionPath]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[ArrayConnectionPath]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

ArrayConnectionPost

pydantic model pypureclient.flashblade.ArrayConnectionPost(*, id: Optional[StrictStr] = None, context: Optional[Reference] = None, ca_certificate_group: Optional[FixedReference] = None, encrypted: Optional[StrictBool] = None, management_address: Optional[StrictStr] = None, os: Optional[StrictStr] = None, remote: Optional[FixedReference] = None, replication_addresses: Optional[ConstrainedListValue[StrictStr]] = None, status: Optional[StrictStr] = None, throttle: Optional[Throttle] = None, type: Optional[StrictStr] = None, version: Optional[StrictStr] = None, connection_key: Optional[StrictStr] = None)

field ca_certificate_group: Optional[FixedReference] = None

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.

field connection_key: Optional[StrictStr] = None

The connection key of the target array. Settable on POST only.

field context: Optional[Reference] = None

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.

field encrypted: Optional[StrictBool] = None

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.

Constraints

• type = boolean

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field management_address: Optional[StrictStr] = None

Management address of the target array. Settable on POST only.

field os: Optional[StrictStr] = None

The operating system of the connected array.

field remote: Optional[FixedReference] = None

The remote array.

field replication_addresses: Optional[ConstrainedListValue[StrictStr]] = None

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.

field status: Optional[StrictStr] = None

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.

field throttle: Optional[Throttle] = None

field type: Optional[StrictStr] = None

The type of connection. Valid values include async-replication and fleet-management.

field version: Optional[StrictStr] = None

The version of the target array.

ArrayConnectionResponse

pydantic model pypureclient.flashblade.ArrayConnectionResponse(*, items: Optional[ConstrainedListValue[ArrayConnection]] = None)

field items: Optional[ConstrainedListValue[ArrayConnection]] = None

ArrayEncryption

pydantic model pypureclient.flashblade.ArrayEncryption(*, data_at_rest: Optional[ArrayEncryptionDataAtRest] = None)

field data_at_rest: Optional[ArrayEncryptionDataAtRest] = None

ArrayEncryptionDataAtRest

pydantic model pypureclient.flashblade.ArrayEncryptionDataAtRest(*, algorithms: Optional[ConstrainedListValue[StrictStr]] = None, enabled: Optional[StrictBool] = None, entropy_source: Optional[StrictStr] = None)

Data at Rest Encryption properties.

field algorithms: Optional[ConstrainedListValue[StrictStr]] = None

The algorithms used to encrypt data at rest on the array.

field enabled: Optional[StrictBool] = None

Returns a value of true if Data at Rest Encryption is enabled.

Constraints

• type = boolean

field entropy_source: Optional[StrictStr] = None

The entropy source used to generate the Data at Rest Encryption key on the array.

ArrayEradicationConfig

pydantic model pypureclient.flashblade.ArrayEradicationConfig(*, eradication_delay: Optional[StrictInt] = None, manual_eradication: Optional[StrictStr] = None)

field eradication_delay: Optional[StrictInt] = None

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.

field manual_eradication: Optional[StrictStr] = None

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.

ArrayFactoryResetToken

pydantic model pypureclient.flashblade.ArrayFactoryResetToken(*, name: Optional[StrictStr] = None, token: Optional[StrictInt] = None)

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field token: Optional[StrictInt] = None

A random 7-digit number required as input to perform a factory reset of the array.

ArrayFactoryResetTokenGetResponse

pydantic model pypureclient.flashblade.ArrayFactoryResetTokenGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[ArrayFactoryResetToken]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[ArrayFactoryResetToken]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

ArrayFactoryResetTokenResponse

pydantic model pypureclient.flashblade.ArrayFactoryResetTokenResponse(*, items: Optional[ConstrainedListValue[ArrayFactoryResetToken]] = None)

field items: Optional[ConstrainedListValue[ArrayFactoryResetToken]] = None

ArrayGetResponse

pydantic model pypureclient.flashblade.ArrayGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Array]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[Array]] = None

A list of array objects.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

ArrayHttpSpecificPerformance

pydantic model pypureclient.flashblade.ArrayHttpSpecificPerformance(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, context: Optional[Reference] = None, others_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, read_dirs_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, read_files_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, time: Optional[StrictInt] = None, usec_per_other_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, usec_per_read_dir_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, usec_per_read_file_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, usec_per_write_dir_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, usec_per_write_file_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, write_dirs_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, write_files_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None)

field context: Optional[Reference] = None

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.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field others_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Other operations processed per second.

field read_dirs_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Read directory requests processed per second.

field read_files_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Read file requests processed per second.

field time: Optional[StrictInt] = None

Sample time in milliseconds since UNIX epoch.

field usec_per_other_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average time, measured in microseconds, it takes the array to process other operations.

field usec_per_read_dir_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average time, measured in microseconds, it takes the array to process a read directory request.

field usec_per_read_file_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average time, measured in microseconds, it takes the array to process a read file request.

field usec_per_write_dir_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average time, measured in microseconds, it takes the array to process a write directory request.

field usec_per_write_file_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average time, measured in microseconds, it takes the array to process a write file request.

field write_dirs_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Write directory requests processed per second.

field write_files_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Write file requests processed per second.

ArrayHttpSpecificPerformanceGet

pydantic model pypureclient.flashblade.ArrayHttpSpecificPerformanceGet(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None, items: Optional[ConstrainedListValue[ArrayHttpSpecificPerformance]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[ArrayHttpSpecificPerformance]] = None

A list of http specific array performance metrics objects.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

ArrayNfsSpecificPerformance

pydantic model pypureclient.flashblade.ArrayNfsSpecificPerformance(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, context: Optional[Reference] = None, accesses_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, aggregate_file_metadata_creates_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, aggregate_file_metadata_modifies_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, aggregate_file_metadata_reads_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, aggregate_other_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, aggregate_share_metadata_reads_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, aggregate_usec_per_file_metadata_create_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, aggregate_usec_per_file_metadata_modify_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, aggregate_usec_per_file_metadata_read_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, aggregate_usec_per_other_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, aggregate_usec_per_share_metadata_read_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, creates_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, fsinfos_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, fsstats_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, getattrs_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, links_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, lookups_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, mkdirs_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, pathconfs_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, readdirpluses_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, readdirs_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, readlinks_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, reads_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, removes_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, renames_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, rmdirs_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, setattrs_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, symlinks_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, time: Optional[StrictInt] = None, usec_per_access_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, usec_per_create_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, usec_per_fsinfo_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, usec_per_fsstat_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, usec_per_getattr_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, usec_per_link_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, usec_per_lookup_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, usec_per_mkdir_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, usec_per_pathconf_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, usec_per_read_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, usec_per_readdir_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, usec_per_readdirplus_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, usec_per_readlink_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, usec_per_remove_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, usec_per_rename_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, usec_per_rmdir_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, usec_per_setattr_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, usec_per_symlink_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, usec_per_write_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, writes_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None)

field accesses_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

ACCESS requests processed per second.

field aggregate_file_metadata_creates_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Sum of file-level or directory-level create-like metadata requests per second. Includes CREATE, LINK, MKDIR, and SYMLINK.

field aggregate_file_metadata_modifies_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Sum of file-level or directory-level modify-like and delete-like metadata requests per second. Includes REMOVE, RENAME, RMDIR, and SETATTR.

field aggregate_file_metadata_reads_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Sum of file-level or directory-level read-like metadata requests per second. Includes GETATTR, LOOKUP, PATHCONF, READDIR, READDIRPLUS, and READLINK.

field aggregate_other_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

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.

field aggregate_share_metadata_reads_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Sum of share-level read-like metadata requests per second. Includes ACCESS, FSINFO, and FSSTAT.

field aggregate_usec_per_file_metadata_create_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

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.

field aggregate_usec_per_file_metadata_modify_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

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.

field aggregate_usec_per_file_metadata_read_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

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.

field aggregate_usec_per_other_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

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.

field aggregate_usec_per_share_metadata_read_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average time, measured in microseconds, it takes the array to process a share-level read-like metadata request. Includes ACCESS, FSINFO, and FSSTAT.

field context: Optional[Reference] = None

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.

field creates_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

CREATE requests processed per second.

field fsinfos_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

FSINFO requests processed per second.

field fsstats_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

FSSTAT requests processed per second.

field getattrs_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

GETATTR requests processed per second.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field links_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

LINK requests processed per second.

field lookups_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

LOOKUP requests processed per second.

field mkdirs_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

MKDIR requests processed per second.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field pathconfs_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

PATHCONF requests processed per second.

field readdirpluses_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

READDIRPLUS requests processed per second.

field readdirs_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

READDIR requests processed per second.

field readlinks_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

READLINK requests processed per second.

field reads_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

READ requests processed per second.

field removes_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

REMOVE requests processed per second.

field renames_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

RENAME requests processed per second.

field rmdirs_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

RMDIR requests processed per second.

field setattrs_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

SETATTR requests processed per second.

field symlinks_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

SYMLINK requests processed per second.

field time: Optional[StrictInt] = None

Sample time in milliseconds since UNIX epoch.

field usec_per_access_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average time, measured in microseconds, it takes the array to process an ACCESS request.

field usec_per_create_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average time, measured in microseconds, it takes the array to process a CREATE request.

field usec_per_fsinfo_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average time, measured in microseconds, it takes the array to process an FSINFO request.

field usec_per_fsstat_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average time, measured in microseconds, it takes the array to process an FSSTAT request.

field usec_per_getattr_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average time, measured in microseconds, it takes the array to process a GETATTR request.

field usec_per_link_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average time, measured in microseconds, it takes the array to process a LINK request.

field usec_per_lookup_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average time, measured in microseconds, it takes the array to process a LOOKUP request.

field usec_per_mkdir_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average time, measured in microseconds, it takes the array to process a MKDIR request.

field usec_per_pathconf_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average time, measured in microseconds, it takes the array to process a PATHCONF request.

field usec_per_read_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average time, measured in microseconds, it takes the array to process a READ request.

field usec_per_readdir_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average time, measured in microseconds, it takes the array to process a READDIR request.

field usec_per_readdirplus_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average time, measured in microseconds, it takes the array to process a READDIRPLUS request.

field usec_per_readlink_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average time, measured in microseconds, it takes the array to process a READLINK request.

field usec_per_remove_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average time, measured in microseconds, it takes the array to process a REMOVE request.

field usec_per_rename_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average time, measured in microseconds, it takes the array to process a RENAME request.

field usec_per_rmdir_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average time, measured in microseconds, it takes the array to process an RMDIR request.

field usec_per_setattr_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average time, measured in microseconds, it takes the array to process a SETATTR request.

field usec_per_symlink_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average time, measured in microseconds, it takes the array to process a SYMLINK request.

field usec_per_write_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average time, measured in microseconds, it takes the array to process a WRITE request.

field writes_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

WRITE requests processed per second.

ArrayNfsSpecificPerformanceGet

pydantic model pypureclient.flashblade.ArrayNfsSpecificPerformanceGet(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None, items: Optional[ConstrainedListValue[ArrayNfsSpecificPerformance]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[ArrayNfsSpecificPerformance]] = None

A list of NFS specific array performance metrics objects.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

ArrayPerformance

pydantic model pypureclient.flashblade.ArrayPerformance(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, context: Optional[Reference] = None, bytes_per_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, bytes_per_read: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, bytes_per_write: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, others_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, read_bytes_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, reads_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, time: Optional[StrictInt] = None, usec_per_other_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, usec_per_read_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, usec_per_write_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, write_bytes_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, writes_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None)

field bytes_per_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average operation size (read bytes+write bytes/read ops+write ops).

field bytes_per_read: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average read size in bytes per read operation.

field bytes_per_write: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average write size in bytes per write operation.

field context: Optional[Reference] = None

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.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field others_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Other operations processed per second.

field read_bytes_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Bytes read per second.

field reads_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Read requests processed per second.

field time: Optional[StrictInt] = None

Sample time in milliseconds since UNIX epoch.

field usec_per_other_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average time, measured in microseconds, it takes the array to process other operations.

field usec_per_read_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average time, measured in microseconds, it takes the array to process a read request.

field usec_per_write_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average time, measured in microseconds, it takes the array to process a write request.

field write_bytes_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Bytes written per second.

field writes_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Write requests processed per second.

ArrayPerformanceGetResponse

pydantic model pypureclient.flashblade.ArrayPerformanceGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None, items: Optional[ConstrainedListValue[ArrayPerformance]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[ArrayPerformance]] = None

A list of array performance metrics objects.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

ArrayPerformanceReplicationGetResp

pydantic model pypureclient.flashblade.ArrayPerformanceReplicationGetResp(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None, items: Optional[ConstrainedListValue[RelationshipPerformanceReplication]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[RelationshipPerformanceReplication]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

ArrayResponse

pydantic model pypureclient.flashblade.ArrayResponse(*, items: Optional[ConstrainedListValue[Array]] = None)

field items: Optional[ConstrainedListValue[Array]] = None

A list of array objects.

ArrayS3SpecificPerformance

pydantic model pypureclient.flashblade.ArrayS3SpecificPerformance(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, context: Optional[Reference] = None, others_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, read_buckets_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, read_objects_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, time: Optional[StrictInt] = None, usec_per_other_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, usec_per_read_bucket_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, usec_per_read_object_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, usec_per_write_bucket_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, usec_per_write_object_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, write_buckets_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, write_objects_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None)

field context: Optional[Reference] = None

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.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field others_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Other operations processed per second.

field read_buckets_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Read buckets requests processed per second.

field read_objects_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Read object requests processed per second.

field time: Optional[StrictInt] = None

Sample time in milliseconds since UNIX epoch.

field usec_per_other_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average time, measured in microseconds, it takes the array to process other operations.

field usec_per_read_bucket_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average time, measured in microseconds, it takes the array to process a read bucket request.

field usec_per_read_object_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average time, measured in microseconds, it takes the array to process a read object request.

field usec_per_write_bucket_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average time, measured in microseconds, it takes the array to process a write bucket request.

field usec_per_write_object_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average time, measured in microseconds, it takes the array to process a write object request.

field write_buckets_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Write buckets requests processed per second.

field write_objects_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Write object requests processed per second.

ArrayS3SpecificPerformanceGetResp

pydantic model pypureclient.flashblade.ArrayS3SpecificPerformanceGetResp(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None, items: Optional[ConstrainedListValue[ArrayS3SpecificPerformance]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[ArrayS3SpecificPerformance]] = None

A list of S3 specific array performance metrics objects.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

ArraySpace

pydantic model pypureclient.flashblade.ArraySpace(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, context: Optional[Reference] = None, capacity: Optional[StrictInt] = None, parity: Optional[Union[StrictFloat, StrictInt]] = None, space: Optional[Space] = None, time: Optional[StrictInt] = None)

field capacity: Optional[StrictInt] = None

Usable capacity in bytes.

field context: Optional[Reference] = None

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.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field parity: Optional[Union[StrictFloat, StrictInt]] = None

A representation of data redundancy on the array. Data redundancy is rebuilt automatically by the system whenever parity is less than 1.0.

field space: Optional[Space] = None

field time: Optional[StrictInt] = None

Sample time in milliseconds since UNIX epoch.

ArraySpaceGetResponse

pydantic model pypureclient.flashblade.ArraySpaceGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None, items: Optional[ConstrainedListValue[ArraySpace]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[ArraySpace]] = None

A list of array space metrics objects.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

ArraySpaceStorageClassGetResponse

pydantic model pypureclient.flashblade.ArraySpaceStorageClassGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[StorageClassSpace]] = None, total: Optional[StorageClassSpace] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[StorageClassSpace]] = None

A list of array space metrics objects for each storage class.

field total: Optional[StorageClassSpace] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

ArraysSupportedTimeZonesGetResponse

pydantic model pypureclient.flashblade.ArraysSupportedTimeZonesGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[TimeZone]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[TimeZone]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

Audit

pydantic model pypureclient.flashblade.Audit(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, arguments: Optional[StrictStr] = None, command: Optional[StrictStr] = None, ip_address: Optional[StrictStr] = None, origin: Optional[FixedReference] = None, subcommand: Optional[StrictStr] = None, time: Optional[StrictInt] = None, user: Optional[StrictStr] = None, user_agent: Optional[StrictStr] = None, user_interface: Optional[StrictStr] = None)

field arguments: Optional[StrictStr] = None

field command: Optional[StrictStr] = None

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field ip_address: Optional[StrictStr] = None

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field origin: Optional[FixedReference] = None

field subcommand: Optional[StrictStr] = None

field time: Optional[StrictInt] = None

field user: Optional[StrictStr] = None

field user_agent: Optional[StrictStr] = None

field user_interface: Optional[StrictStr] = None

The user interface through which the user session event was performed. Valid values are CLI, GUI, and REST.

AuditFileSystemsPoliciesGetResponse

pydantic model pypureclient.flashblade.AuditFileSystemsPoliciesGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[AuditFileSystemsPolicy]] = None, errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[AuditFileSystemsPolicy]] = None

A list of audit policy objects.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

AuditFileSystemsPoliciesMembersGetResponse

pydantic model pypureclient.flashblade.AuditFileSystemsPoliciesMembersGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[PolicyMemberContext]] = None, errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[PolicyMemberContext]] = None

A list of members for audit policies.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

AuditFileSystemsPoliciesMembersResponse

pydantic model pypureclient.flashblade.AuditFileSystemsPoliciesMembersResponse(*, items: Optional[ConstrainedListValue[PolicyMemberContext]] = None)

field items: Optional[ConstrainedListValue[PolicyMemberContext]] = None

A list of members for audit policies.

AuditFileSystemsPoliciesPatch

pydantic model pypureclient.flashblade.AuditFileSystemsPoliciesPatch(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, enabled: Optional[StrictBool] = None, is_local: Optional[StrictBool] = None, location: Optional[FixedReference] = None, policy_type: Optional[StrictStr] = None, log_targets: Optional[ConstrainedListValue[Reference]] = None, add_log_targets: Optional[ConstrainedListValue[Reference]] = None, remove_log_targets: Optional[ConstrainedListValue[Reference]] = None)

field add_log_targets: Optional[ConstrainedListValue[Reference]] = None

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.

field enabled: Optional[StrictBool] = None

If true, the policy is enabled. If not specified, defaults to true.

Constraints

• type = boolean

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field is_local: Optional[StrictBool] = None

Whether the policy is defined on the local array.

Constraints

• type = boolean

field location: Optional[FixedReference] = None

Reference to the array where the policy is defined.

field log_targets: Optional[ConstrainedListValue[Reference]] = None

List of targets which will be utilized for audit log storage. These may either be file system targets or remote syslog server targets.

field name: Optional[StrictStr] = None

A name chosen by the user. Can be changed. Must be locally unique.

field policy_type: Optional[StrictStr] = None

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.

field remove_log_targets: Optional[ConstrainedListValue[Reference]] = None

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.

AuditFileSystemsPoliciesPost

pydantic model pypureclient.flashblade.AuditFileSystemsPoliciesPost(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, enabled: Optional[StrictBool] = None, is_local: Optional[StrictBool] = None, location: Optional[FixedReference] = None, policy_type: Optional[StrictStr] = None, log_targets: Optional[ConstrainedListValue[Reference]] = None)

field enabled: Optional[StrictBool] = None

If true, the policy is enabled. If not specified, defaults to true.

Constraints

• type = boolean

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field is_local: Optional[StrictBool] = None

Whether the policy is defined on the local array.

Constraints

• type = boolean

field location: Optional[FixedReference] = None

Reference to the array where the policy is defined.

field log_targets: Optional[ConstrainedListValue[Reference]] = None

List of targets which will be utilized for audit log storage. These may either be file system targets or remote syslog server targets.

field name: Optional[StrictStr] = None

A name chosen by the user. Can be changed. Must be locally unique.

field policy_type: Optional[StrictStr] = None

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.

AuditFileSystemsPoliciesResponse

pydantic model pypureclient.flashblade.AuditFileSystemsPoliciesResponse(*, items: Optional[ConstrainedListValue[AuditFileSystemsPolicy]] = None)

field items: Optional[ConstrainedListValue[AuditFileSystemsPolicy]] = None

A list of audit policy objects.

AuditFileSystemsPolicy

pydantic model pypureclient.flashblade.AuditFileSystemsPolicy(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, enabled: Optional[StrictBool] = None, is_local: Optional[StrictBool] = None, location: Optional[FixedReference] = None, policy_type: Optional[StrictStr] = None, log_targets: Optional[ConstrainedListValue[Reference]] = None, context: Optional[Reference] = None)

field context: Optional[Reference] = None

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.

field enabled: Optional[StrictBool] = None

If true, the policy is enabled. If not specified, defaults to true.

Constraints

• type = boolean

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field is_local: Optional[StrictBool] = None

Whether the policy is defined on the local array.

Constraints

• type = boolean

field location: Optional[FixedReference] = None

Reference to the array where the policy is defined.

field log_targets: Optional[ConstrainedListValue[Reference]] = None

List of targets which will be utilized for audit log storage. These may either be file system targets or remote syslog server targets.

field name: Optional[StrictStr] = None

A name chosen by the user. Can be changed. Must be locally unique.

field policy_type: Optional[StrictStr] = None

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.

AuditFileSystemsPolicyNoContext

pydantic model pypureclient.flashblade.AuditFileSystemsPolicyNoContext(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, enabled: Optional[StrictBool] = None, is_local: Optional[StrictBool] = None, location: Optional[FixedReference] = None, policy_type: Optional[StrictStr] = None, log_targets: Optional[ConstrainedListValue[Reference]] = None)

field enabled: Optional[StrictBool] = None

If true, the policy is enabled. If not specified, defaults to true.

Constraints

• type = boolean

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field is_local: Optional[StrictBool] = None

Whether the policy is defined on the local array.

Constraints

• type = boolean

field location: Optional[FixedReference] = None

Reference to the array where the policy is defined.

field log_targets: Optional[ConstrainedListValue[Reference]] = None

List of targets which will be utilized for audit log storage. These may either be file system targets or remote syslog server targets.

field name: Optional[StrictStr] = None

A name chosen by the user. Can be changed. Must be locally unique.

field policy_type: Optional[StrictStr] = None

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.

AuditGetResponse

pydantic model pypureclient.flashblade.AuditGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Audit]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[Audit]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

AuditResponse

pydantic model pypureclient.flashblade.AuditResponse(*, items: Optional[ConstrainedListValue[Audit]] = None)

field items: Optional[ConstrainedListValue[Audit]] = None

Blade

pydantic model pypureclient.flashblade.Blade(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, details: Optional[StrictStr] = None, progress: Optional[Union[StrictFloat, StrictInt]] = None, raw_capacity: Optional[StrictInt] = None, status: Optional[StrictStr] = None, target: Optional[StrictStr] = None)

field details: Optional[StrictStr] = None

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field progress: Optional[Union[StrictFloat, StrictInt]] = None

field raw_capacity: Optional[StrictInt] = None

field status: Optional[StrictStr] = None

Valid values are critical, evacuated, evacuating, healthy, identifying, unhealthy, unknown, and unused.

field target: Optional[StrictStr] = None

BladeGetResponse

pydantic model pypureclient.flashblade.BladeGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Blade]] = None, total: Optional[Dict[str, Any]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[Blade]] = None

A list of blade objects.

field total: Optional[Dict[str, Any]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

Bucket

pydantic model pypureclient.flashblade.Bucket(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, context: Optional[Reference] = None, account: Optional[FixedReference] = None, bucket_type: Optional[StrictStr] = None, created: Optional[StrictInt] = None, destroyed: Optional[StrictBool] = None, eradication_config: Optional[BucketEradicationConfig] = None, hard_limit_enabled: Optional[StrictBool] = None, object_count: Optional[StrictInt] = None, object_lock_config: Optional[ObjectLockConfigResponse] = None, public_access_config: Optional[PublicAccessConfig] = None, public_status: Optional[StrictStr] = None, quota_limit: Optional[StrictInt] = None, retention_lock: Optional[StrictStr] = None, space: Optional[Space] = None, time_remaining: Optional[StrictInt] = None, time_remaining_status: Optional[StrictStr] = None, versioning: Optional[StrictStr] = None)

field account: Optional[FixedReference] = None

field bucket_type: Optional[StrictStr] = None

The bucket type for the bucket.

field context: Optional[Reference] = None

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.

field created: Optional[StrictInt] = None

Creation timestamp of the object.

field destroyed: Optional[StrictBool] = None

Is the bucket destroyed?

Constraints

• type = boolean

field eradication_config: Optional[BucketEradicationConfig] = None

field hard_limit_enabled: Optional[StrictBool] = None

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.

Constraints

• type = boolean

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field object_count: Optional[StrictInt] = None

The count of objects within the bucket.

field object_lock_config: Optional[ObjectLockConfigResponse] = None

field public_access_config: Optional[PublicAccessConfig] = None

field public_status: Optional[StrictStr] = None

Bucket’s public status. Valid values include bucket-and-objects-not-public, only-authorized-users-of-this-account and public.

field quota_limit: Optional[StrictInt] = None

The effective quota limit applied against the size of the bucket, displayed in bytes. If unset, the bucket is unlimited in size.

field retention_lock: Optional[StrictStr] = None

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.

field space: Optional[Space] = None

The space specification of the bucket.

field time_remaining: Optional[StrictInt] = None

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.

field time_remaining_status: Optional[StrictStr] = None

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.

field versioning: Optional[StrictStr] = None

The versioning state for objects within the bucket. Valid values are none, enabled, and suspended.

BucketAccessPolicy

pydantic model pypureclient.flashblade.BucketAccessPolicy(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, enabled: Optional[StrictBool] = None, is_local: Optional[StrictBool] = None, location: Optional[FixedReference] = None, policy_type: Optional[StrictStr] = None, context: Optional[Reference] = None, bucket: Optional[FixedReference] = None, rules: Optional[ConstrainedListValue[BucketAccessPolicyRule]] = None)

field bucket: Optional[FixedReference] = None

The bucket to which this policy belongs.

field context: Optional[Reference] = None

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.

field enabled: Optional[StrictBool] = None

If true, the policy is enabled. If not specified, defaults to true.

Constraints

• type = boolean

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field is_local: Optional[StrictBool] = None

Whether the policy is defined on the local array.

Constraints

• type = boolean

field location: Optional[FixedReference] = None

Reference to the array where the policy is defined.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field policy_type: Optional[StrictStr] = None

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.

field rules: Optional[ConstrainedListValue[BucketAccessPolicyRule]] = None

BucketAccessPolicyGetResponse

pydantic model pypureclient.flashblade.BucketAccessPolicyGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None, items: Optional[ConstrainedListValue[BucketAccessPolicy]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[BucketAccessPolicy]] = None

A list of bucket policy objects.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

BucketAccessPolicyPost

pydantic model pypureclient.flashblade.BucketAccessPolicyPost(*, rules: Optional[ConstrainedListValue[BucketAccessPolicyRuleBulkManage]] = None)

field rules: Optional[ConstrainedListValue[BucketAccessPolicyRuleBulkManage]] = None

BucketAccessPolicyResponse

pydantic model pypureclient.flashblade.BucketAccessPolicyResponse(*, items: Optional[ConstrainedListValue[BucketAccessPolicy]] = None)

field items: Optional[ConstrainedListValue[BucketAccessPolicy]] = None

A list of bucket policy objects.

BucketAccessPolicyRule

pydantic model pypureclient.flashblade.BucketAccessPolicyRule(*, name: Optional[StrictStr] = None, actions: Optional[ConstrainedListValue[StrictStr]] = None, effect: Optional[StrictStr] = None, principals: Optional[BucketAccessPolicyRulePrincipal] = None, resources: Optional[ConstrainedListValue[StrictStr]] = None, policy: Optional[FixedReference] = None)

field actions: Optional[ConstrainedListValue[StrictStr]] = None

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.

field effect: Optional[StrictStr] = None

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.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field policy: Optional[FixedReference] = None

The policy to which this rule belongs.

field principals: Optional[BucketAccessPolicyRulePrincipal] = None

The principals to which this rule applies. Currently, only all principals are supported.

field resources: Optional[ConstrainedListValue[StrictStr]] = None

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.

BucketAccessPolicyRuleBulkManage

pydantic model pypureclient.flashblade.BucketAccessPolicyRuleBulkManage(*, actions: Optional[ConstrainedListValue[StrictStr]] = None, effect: Optional[StrictStr] = None, principals: Optional[BucketAccessPolicyRulePrincipal] = None, resources: Optional[ConstrainedListValue[StrictStr]] = None, name: Optional[StrictStr] = None)

field actions: Optional[ConstrainedListValue[StrictStr]] = None

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.

field effect: Optional[StrictStr] = None

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.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field principals: Optional[BucketAccessPolicyRulePrincipal] = None

The principals to which this rule applies. Currently, only all principals are supported.

field resources: Optional[ConstrainedListValue[StrictStr]] = None

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.

BucketAccessPolicyRuleGetResponse

pydantic model pypureclient.flashblade.BucketAccessPolicyRuleGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None, items: Optional[ConstrainedListValue[BucketAccessPolicyRuleWithContext]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[BucketAccessPolicyRuleWithContext]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

BucketAccessPolicyRulePost

pydantic model pypureclient.flashblade.BucketAccessPolicyRulePost(*, actions: Optional[ConstrainedListValue[StrictStr]] = None, effect: Optional[StrictStr] = None, principals: Optional[BucketAccessPolicyRulePrincipal] = None, resources: Optional[ConstrainedListValue[StrictStr]] = None)

field actions: Optional[ConstrainedListValue[StrictStr]] = None

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.

field effect: Optional[StrictStr] = None

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.

field principals: Optional[BucketAccessPolicyRulePrincipal] = None

The principals to which this rule applies. Currently, only all principals are supported.

field resources: Optional[ConstrainedListValue[StrictStr]] = None

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.

BucketAccessPolicyRulePrincipal

pydantic model pypureclient.flashblade.BucketAccessPolicyRulePrincipal(*, all: Optional[StrictBool] = None)

field all: Optional[StrictBool] = None

If true, the rule will apply to all object store users regardless of their origin or principal.

Constraints

• type = boolean

BucketAccessPolicyRuleResponse

pydantic model pypureclient.flashblade.BucketAccessPolicyRuleResponse(*, items: Optional[ConstrainedListValue[BucketAccessPolicyRuleWithContext]] = None)

field items: Optional[ConstrainedListValue[BucketAccessPolicyRuleWithContext]] = None

BucketAccessPolicyRuleWithContext

pydantic model pypureclient.flashblade.BucketAccessPolicyRuleWithContext(*, name: Optional[StrictStr] = None, actions: Optional[ConstrainedListValue[StrictStr]] = None, effect: Optional[StrictStr] = None, principals: Optional[BucketAccessPolicyRulePrincipal] = None, resources: Optional[ConstrainedListValue[StrictStr]] = None, policy: Optional[FixedReference] = None, context: Optional[Reference] = None)

field actions: Optional[ConstrainedListValue[StrictStr]] = None

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.

field context: Optional[Reference] = None

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.

field effect: Optional[StrictStr] = None

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.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field policy: Optional[FixedReference] = None

The policy to which this rule belongs.

field principals: Optional[BucketAccessPolicyRulePrincipal] = None

The principals to which this rule applies. Currently, only all principals are supported.

field resources: Optional[ConstrainedListValue[StrictStr]] = None

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.

BucketDefaults

pydantic model pypureclient.flashblade.BucketDefaults(*, hard_limit_enabled: Optional[StrictBool] = None, quota_limit: Optional[StrictStr] = None)

field hard_limit_enabled: Optional[StrictBool] = None

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.

Constraints

• type = boolean

field quota_limit: Optional[StrictStr] = None

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.

BucketDefaultsReadonly

pydantic model pypureclient.flashblade.BucketDefaultsReadonly(*, hard_limit_enabled: Optional[StrictBool] = None, quota_limit: Optional[StrictInt] = None)

field hard_limit_enabled: Optional[StrictBool] = None

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.

Constraints

• type = boolean

field quota_limit: Optional[StrictInt] = None

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.

BucketEradicationConfig

pydantic model pypureclient.flashblade.BucketEradicationConfig(*, eradication_delay: Optional[StrictInt] = None, eradication_mode: Optional[StrictStr] = None, manual_eradication: Optional[StrictStr] = None)

Configuration settings related to bucket eradication.

field eradication_delay: Optional[StrictInt] = None

Minimum eradication delay in milliseconds. Automatically eradicate destroyed buckets after the delay time passes unless automatic eradication is delayed due to other configuration values.

field eradication_mode: Optional[StrictStr] = None

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.

field manual_eradication: Optional[StrictStr] = None

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.

BucketGetResponse

pydantic model pypureclient.flashblade.BucketGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Bucket]] = None, errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None, total: Optional[Bucket] = None)

field continuation_token: Optional[StrictStr] = None

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).

field errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[Bucket]] = None

A list of bucket objects.

field total: Optional[Bucket] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

BucketPatch

pydantic model pypureclient.flashblade.BucketPatch(*, destroyed: Optional[StrictBool] = None, eradication_config: Optional[BucketEradicationConfig] = None, hard_limit_enabled: Optional[StrictBool] = None, object_lock_config: Optional[ObjectLockConfigRequestBody] = None, public_access_config: Optional[PublicAccessConfig] = None, quota_limit: Optional[StrictStr] = None, retention_lock: Optional[StrictStr] = None, versioning: Optional[StrictStr] = None)

field destroyed: Optional[StrictBool] = None

Is the bucket destroyed?

Constraints

• type = boolean

field eradication_config: Optional[BucketEradicationConfig] = None

field hard_limit_enabled: Optional[StrictBool] = None

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.

Constraints

• type = boolean

field object_lock_config: Optional[ObjectLockConfigRequestBody] = None

field public_access_config: Optional[PublicAccessConfig] = None

field quota_limit: Optional[StrictStr] = None

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.

field retention_lock: Optional[StrictStr] = None

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.

field versioning: Optional[StrictStr] = None

The versioning state for objects within the bucket. Valid values are none, enabled, and suspended.

BucketPerformance

pydantic model pypureclient.flashblade.BucketPerformance(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, bytes_per_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, bytes_per_read: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, bytes_per_write: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, others_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, read_bytes_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, reads_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, time: Optional[StrictInt] = None, usec_per_other_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, usec_per_read_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, usec_per_write_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, write_bytes_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, writes_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None)

field bytes_per_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average operation size (read bytes+write bytes/read ops+write ops).

field bytes_per_read: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average read size in bytes per read operation.

field bytes_per_write: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average write size in bytes per write operation.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field others_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Other operations processed per second.

field read_bytes_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Bytes read per second.

field reads_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Read requests processed per second.

field time: Optional[StrictInt] = None

Sample time in milliseconds since UNIX epoch.

field usec_per_other_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average time, measured in microseconds, it takes the array to process other operations.

field usec_per_read_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average time, measured in microseconds, it takes the array to process a read request.

field usec_per_write_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average time, measured in microseconds, it takes the array to process a write request.

field write_bytes_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Bytes written per second.

field writes_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Write requests processed per second.

BucketPerformanceGetResponse

pydantic model pypureclient.flashblade.BucketPerformanceGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[BucketPerformance]] = None, total: Optional[ConstrainedListValue[BucketPerformance]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[BucketPerformance]] = None

A list of bucket performance objects.

field total: Optional[ConstrainedListValue[BucketPerformance]] = None

Total of all records after filtering. If total_only query param is true, then no items will be returned.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

BucketPost

pydantic model pypureclient.flashblade.BucketPost(*, account: Optional[ReferenceWritable] = None, bucket_type: Optional[StrictStr] = None, eradication_config: Optional[BucketEradicationConfig] = None, hard_limit_enabled: Optional[StrictBool] = None, object_lock_config: Optional[ObjectLockConfigRequestBody] = None, quota_limit: Optional[StrictStr] = None, retention_lock: Optional[StrictStr] = None)

field account: Optional[ReferenceWritable] = None

The account name for bucket creation.

field bucket_type: Optional[StrictStr] = None

The bucket type for the bucket. Valid values are classic, and multi-site-writable. Default value is multi-site-writable.

field eradication_config: Optional[BucketEradicationConfig] = None

field hard_limit_enabled: Optional[StrictBool] = None

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.

Constraints

• type = boolean

field object_lock_config: Optional[ObjectLockConfigRequestBody] = None

field quota_limit: Optional[StrictStr] = None

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.

field retention_lock: Optional[StrictStr] = None

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.

BucketReplicaLink

pydantic model pypureclient.flashblade.BucketReplicaLink(*, id: Optional[StrictStr] = None, direction: Optional[StrictStr] = None, lag: Optional[StrictInt] = None, status_details: Optional[StrictStr] = None, context: Optional[Reference] = None, cascading_enabled: Optional[StrictBool] = None, local_bucket: Optional[FixedReference] = None, object_backlog: Optional[ObjectBacklog] = None, paused: Optional[StrictBool] = None, recovery_point: Optional[StrictInt] = None, remote: Optional[FixedReference] = None, remote_bucket: Optional[FixedReferenceNameOnly] = None, remote_credentials: Optional[ReferenceWritable] = None, status: Optional[StrictStr] = None)

field cascading_enabled: Optional[StrictBool] = None

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.

Constraints

• type = boolean

field context: Optional[Reference] = None

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.

field direction: Optional[StrictStr] = None

The direction of replication. Valid values are inbound and outbound.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field lag: Optional[StrictInt] = None

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.

field local_bucket: Optional[FixedReference] = None

Reference to a local bucket.

field object_backlog: Optional[ObjectBacklog] = None

The number of pending operations and their size that are currently in the backlog.

field paused: Optional[StrictBool] = None

Is the replica link paused?

Constraints

• type = boolean

field recovery_point: Optional[StrictInt] = None

Time, in milliseconds since UNIX epoch, where all object changes before this time are guaranteed to have been replicated. Changes after this time may have been replicated.

field remote: Optional[FixedReference] = None

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.

field remote_bucket: Optional[FixedReferenceNameOnly] = None

Reference to a remote bucket.

field remote_credentials: Optional[ReferenceWritable] = None

Reference to a remote-credentials object to access the remote bucket.

field status: Optional[StrictStr] = None

Status of the replica link. Values include replicating, paused, and unhealthy.

field status_details: Optional[StrictStr] = None

Detailed information about the status of the replica link when it is unhealthy.

BucketReplicaLinkGetResponse

pydantic model pypureclient.flashblade.BucketReplicaLinkGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None, items: Optional[ConstrainedListValue[BucketReplicaLink]] = None, total: Optional[BucketReplicaLink] = None)

field continuation_token: Optional[StrictStr] = None

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).

field errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[BucketReplicaLink]] = None

A list of object store bucket replica link objects.

field total: Optional[BucketReplicaLink] = None

If total_only query param is true, then it will be a total of all records after filtering and no items will be returned. If total_only is false, then it will be a total of all records on this page.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

BucketReplicaLinkPost

pydantic model pypureclient.flashblade.BucketReplicaLinkPost(*, cascading_enabled: Optional[StrictBool] = None, paused: Optional[StrictBool] = None)

field cascading_enabled: Optional[StrictBool] = None

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.

Constraints

• type = boolean

field paused: Optional[StrictBool] = None

Create link in the paused state? Defaults to false.

Constraints

• type = boolean

BucketReplicaLinkResponse

pydantic model pypureclient.flashblade.BucketReplicaLinkResponse(*, items: Optional[ConstrainedListValue[BucketReplicaLink]] = None, total: Optional[BucketReplicaLink] = None)

field items: Optional[ConstrainedListValue[BucketReplicaLink]] = None

A list of object store bucket replica link objects.

field total: Optional[BucketReplicaLink] = None

If total_only query param is true, then it will be a total of all records after filtering and no items will be returned. If total_only is false, then it will be a total of all records on this page.

BucketResponse

pydantic model pypureclient.flashblade.BucketResponse(*, items: Optional[ConstrainedListValue[Bucket]] = None)

field items: Optional[ConstrainedListValue[Bucket]] = None

A list of bucket objects.

BucketS3SpecificPerformance

pydantic model pypureclient.flashblade.BucketS3SpecificPerformance(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, others_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, read_buckets_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, read_objects_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, time: Optional[StrictInt] = None, usec_per_other_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, usec_per_read_bucket_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, usec_per_read_object_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, usec_per_write_bucket_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, usec_per_write_object_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, write_buckets_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, write_objects_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None)

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field others_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Other operations processed per second.

field read_buckets_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Read buckets requests processed per second.

field read_objects_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Read object requests processed per second.

field time: Optional[StrictInt] = None

Sample time in milliseconds since UNIX epoch.

field usec_per_other_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average time, measured in microseconds, it takes the array to process other operations.

field usec_per_read_bucket_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average time, measured in microseconds, it takes the array to process a read bucket request.

field usec_per_read_object_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average time, measured in microseconds, it takes the array to process a read object request.

field usec_per_write_bucket_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average time, measured in microseconds, it takes the array to process a write bucket request.

field usec_per_write_object_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average time, measured in microseconds, it takes the array to process a write object request.

field write_buckets_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Write buckets requests processed per second.

field write_objects_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Write object requests processed per second.

BucketS3SpecificPerformanceGetResp

pydantic model pypureclient.flashblade.BucketS3SpecificPerformanceGetResp(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[BucketS3SpecificPerformance]] = None, total: Optional[ConstrainedListValue[BucketS3SpecificPerformance]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[BucketS3SpecificPerformance]] = None

A list of S3 specific bucket performance metrics objects.

field total: Optional[ConstrainedListValue[BucketS3SpecificPerformance]] = None

Total of all records after filtering. If total_only query param is true, then no items will be returned.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

BuiltIn

pydantic model pypureclient.flashblade.BuiltIn(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None)

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

BuiltInNoId

pydantic model pypureclient.flashblade.BuiltInNoId(*, name: Optional[StrictStr] = None)

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

BuiltInRelationship

pydantic model pypureclient.flashblade.BuiltInRelationship(*, id: Optional[StrictStr] = None)

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

Certificate

pydantic model pypureclient.flashblade.Certificate(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, certificate: Optional[StrictStr] = None, certificate_type: Optional[StrictStr] = None, common_name: Optional[StrictStr] = None, country: Optional[StrictStr] = None, email: Optional[StrictStr] = None, intermediate_certificate: Optional[StrictStr] = None, issued_by: Optional[StrictStr] = None, issued_to: Optional[StrictStr] = None, key_size: Optional[StrictInt] = None, locality: Optional[StrictStr] = None, organization: Optional[StrictStr] = None, organizational_unit: Optional[StrictStr] = None, state: Optional[StrictStr] = None, status: Optional[StrictStr] = None, subject_alternative_names: Optional[ConstrainedListValue[StrictStr]] = None, valid_from: Optional[StrictStr] = None, valid_to: Optional[StrictStr] = None)

field certificate: Optional[StrictStr] = None

The text of the certificate.

field certificate_type: Optional[StrictStr] = None

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.

field common_name: Optional[StrictStr] = None

FQDN or management IP address of the current array.

field country: Optional[StrictStr] = None

The country field listed in the certificate.

field email: Optional[StrictStr] = None

The email field listed in the certificate.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field intermediate_certificate: Optional[StrictStr] = None

Intermediate certificate chains.

field issued_by: Optional[StrictStr] = None

Who issued this certificate.

field issued_to: Optional[StrictStr] = None

Who this certificate was issued to.

field key_size: Optional[StrictInt] = None

The size of the private key for this certificate in bits.

field locality: Optional[StrictStr] = None

The locality field listed in the certificate.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field organization: Optional[StrictStr] = None

The organization field listed in the certificate.

field organizational_unit: Optional[StrictStr] = None

The organizational unit field listed in the certificate.

field state: Optional[StrictStr] = None

The state/province field listed in the certificate.

field status: Optional[StrictStr] = None

The type of certificate. Valid values are self-signed and imported.

field subject_alternative_names: Optional[ConstrainedListValue[StrictStr]] = None

The alternative names that are secured by this certificate. Alternative names may be IP addresses, DNS names, or URIs.

field valid_from: Optional[StrictStr] = None

The start date of when this certificate is valid.

field valid_to: Optional[StrictStr] = None

The end date of when this certificate is valid.

CertificateCertificateGroupGetResp

pydantic model pypureclient.flashblade.CertificateCertificateGroupGetResp(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Member]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[Member]] = None

A list of certificate and certificate group relationships.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

CertificateCertificateGroupResponse

pydantic model pypureclient.flashblade.CertificateCertificateGroupResponse(*, items: Optional[ConstrainedListValue[Member]] = None)

field items: Optional[ConstrainedListValue[Member]] = None

A list of certificate and certificate group relationships.

CertificateGetResponse

pydantic model pypureclient.flashblade.CertificateGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Certificate]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[Certificate]] = None

A list of certificate objects.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

CertificateGroup

pydantic model pypureclient.flashblade.CertificateGroup(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None)

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

CertificateGroupCertificateGetResp

pydantic model pypureclient.flashblade.CertificateGroupCertificateGetResp(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Member]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[Member]] = None

A list of certificate and certificate group relationships.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

CertificateGroupCertificateResponse

pydantic model pypureclient.flashblade.CertificateGroupCertificateResponse(*, items: Optional[ConstrainedListValue[Member]] = None)

field items: Optional[ConstrainedListValue[Member]] = None

A list of certificate and certificate group relationships.

CertificateGroupGetResponse

pydantic model pypureclient.flashblade.CertificateGroupGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[CertificateGroup]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[CertificateGroup]] = None

A list of certificate group objects.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

CertificateGroupResponse

pydantic model pypureclient.flashblade.CertificateGroupResponse(*, items: Optional[ConstrainedListValue[CertificateGroup]] = None)

field items: Optional[ConstrainedListValue[CertificateGroup]] = None

A list of certificate group objects.

CertificateGroupUse

pydantic model pypureclient.flashblade.CertificateGroupUse(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, use: Optional[FixedReferenceWithRemote] = None)

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field use: Optional[FixedReferenceWithRemote] = None

A reference to an object using this certificate group.

CertificateGroupUseGetResponse

pydantic model pypureclient.flashblade.CertificateGroupUseGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[CertificateGroupUse]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[CertificateGroupUse]] = None

A list of certificate group use objects.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

CertificatePatch

pydantic model pypureclient.flashblade.CertificatePatch(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, certificate: Optional[StrictStr] = None, intermediate_certificate: Optional[StrictStr] = None, passphrase: Optional[StrictStr] = None, private_key: Optional[StrictStr] = None)

field certificate: Optional[StrictStr] = None

The text of the certificate.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field intermediate_certificate: Optional[StrictStr] = None

Intermediate certificate chains.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field passphrase: Optional[StrictStr] = None

The passphrase used to encrypt private_key.

field private_key: Optional[StrictStr] = None

The private key used to sign the certificate.

CertificatePost

pydantic model pypureclient.flashblade.CertificatePost(*, name: Optional[StrictStr] = None, certificate: Optional[StrictStr] = None, certificate_type: Optional[StrictStr] = None, common_name: Optional[StrictStr] = None, country: Optional[StrictStr] = None, email: Optional[StrictStr] = None, intermediate_certificate: Optional[StrictStr] = None, issued_by: Optional[StrictStr] = None, issued_to: Optional[StrictStr] = None, key_size: Optional[StrictInt] = None, locality: Optional[StrictStr] = None, organization: Optional[StrictStr] = None, organizational_unit: Optional[StrictStr] = None, passphrase: Optional[StrictStr] = None, private_key: Optional[StrictStr] = None, state: Optional[StrictStr] = None, status: Optional[StrictStr] = None, valid_from: Optional[StrictStr] = None, valid_to: Optional[StrictStr] = None)

field certificate: Optional[StrictStr] = None

The text of the certificate.

field certificate_type: Optional[StrictStr] = None

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.

field common_name: Optional[StrictStr] = None

FQDN or management IP address of the current array.

field country: Optional[StrictStr] = None

The country field listed in the certificate.

field email: Optional[StrictStr] = None

The email field listed in the certificate.

field intermediate_certificate: Optional[StrictStr] = None

Intermediate certificate chains.

field issued_by: Optional[StrictStr] = None

Who issued this certificate.

field issued_to: Optional[StrictStr] = None

Who this certificate was issued to.

field key_size: Optional[StrictInt] = None

The size of the private key for this certificate in bits.

field locality: Optional[StrictStr] = None

The locality field listed in the certificate.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field organization: Optional[StrictStr] = None

The organization field listed in the certificate.

field organizational_unit: Optional[StrictStr] = None

The organizational unit field listed in the certificate.

field passphrase: Optional[StrictStr] = None

The passphrase used to encrypt private_key.

field private_key: Optional[StrictStr] = None

The private key used to sign the certificate.

field state: Optional[StrictStr] = None

The state/province field listed in the certificate.

field status: Optional[StrictStr] = None

The type of certificate. Valid values are self-signed and imported.

field valid_from: Optional[StrictStr] = None

The start date of when this certificate is valid.

field valid_to: Optional[StrictStr] = None

The end date of when this certificate is valid.

CertificateResponse

pydantic model pypureclient.flashblade.CertificateResponse(*, items: Optional[ConstrainedListValue[Certificate]] = None)

field items: Optional[ConstrainedListValue[Certificate]] = None

A list of certificate objects.

CertificateUse

pydantic model pypureclient.flashblade.CertificateUse(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, group: Optional[FixedReference] = None, use: Optional[FixedReferenceWithRemote] = None)

field group: Optional[FixedReference] = None

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.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field use: Optional[FixedReferenceWithRemote] = None

A reference to an object using this certificate.

CertificateUseGetResponse

pydantic model pypureclient.flashblade.CertificateUseGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[CertificateUse]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[CertificateUse]] = None

A list of certificate use objects.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

ClientPerformance

pydantic model pypureclient.flashblade.ClientPerformance(*, name: Optional[StrictStr] = None, bytes_per_op: Optional[ConstrainedIntValue] = None, bytes_per_read: Optional[ConstrainedIntValue] = None, bytes_per_write: Optional[ConstrainedIntValue] = None, others_per_sec: Optional[ConstrainedIntValue] = None, read_bytes_per_sec: Optional[ConstrainedIntValue] = None, reads_per_sec: Optional[ConstrainedIntValue] = None, time: Optional[StrictInt] = None, usec_per_other_op: Optional[ConstrainedIntValue] = None, usec_per_read_op: Optional[ConstrainedIntValue] = None, usec_per_write_op: Optional[ConstrainedIntValue] = None, write_bytes_per_sec: Optional[ConstrainedIntValue] = None, writes_per_sec: Optional[ConstrainedIntValue] = None)

field bytes_per_op: Optional[ConstrainedIntValue] = None

Average operation size (read bytes+write bytes/read ops+write ops).

Constraints

• minimum = 0

field bytes_per_read: Optional[ConstrainedIntValue] = None

Average read size in bytes per read operation.

Constraints

• minimum = 0

field bytes_per_write: Optional[ConstrainedIntValue] = None

Average write size in bytes per write operation.

Constraints

• minimum = 0

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field others_per_sec: Optional[ConstrainedIntValue] = None

Other operations processed per second.

Constraints

• minimum = 0

field read_bytes_per_sec: Optional[ConstrainedIntValue] = None

Bytes read per second.

Constraints

• minimum = 0

field reads_per_sec: Optional[ConstrainedIntValue] = None

Read requests processed per second.

Constraints

• minimum = 0

field time: Optional[StrictInt] = None

Sample time in milliseconds since UNIX epoch.

field usec_per_other_op: Optional[ConstrainedIntValue] = None

Average time, measured in microseconds, it takes the client to process other operations.

Constraints

• minimum = 0

field usec_per_read_op: Optional[ConstrainedIntValue] = None

Average time, measured in microseconds, it takes the client to process a read request.

Constraints

• minimum = 0

field usec_per_write_op: Optional[ConstrainedIntValue] = None

Average time, measured in microseconds, it takes the client to process a write request.

Constraints

• minimum = 0

field write_bytes_per_sec: Optional[ConstrainedIntValue] = None

Bytes written per second.

Constraints

• minimum = 0

field writes_per_sec: Optional[ConstrainedIntValue] = None

Write requests processed per second.

Constraints

• minimum = 0

ClientPerformanceGetResponse

pydantic model pypureclient.flashblade.ClientPerformanceGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None, items: Optional[ConstrainedListValue[ClientPerformance]] = None, total: Optional[ConstrainedListValue[ClientPerformance]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[ClientPerformance]] = None

A list of client performance metrics objects.

field total: Optional[ConstrainedListValue[ClientPerformance]] = None

Total of all records after filtering. If total_only query param is true, then no items will be returned.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

ConnectionRelationshipPerformanceReplication

pydantic model pypureclient.flashblade.ConnectionRelationshipPerformanceReplication(*, id: Optional[StrictStr] = None, aggregate: Optional[ReplicationPerformance] = None, continuous: Optional[ContinuousReplicationPerformance] = None, periodic: Optional[ReplicationPerformance] = None, remote: Optional[FixedReferenceNoResourceType] = None, time: Optional[StrictInt] = None)

field aggregate: Optional[ReplicationPerformance] = None

Total bytes transmitted or received per second for all types of replication.

field continuous: Optional[ContinuousReplicationPerformance] = None

Object backlog information and total bytes transmitted or received per second for continuous replication. Continuous replication includes object replication.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field periodic: Optional[ReplicationPerformance] = None

Total bytes transmitted or received per second for periodic replication. Periodic replication includes file system replication, which is snapshot based.

field remote: Optional[FixedReferenceNoResourceType] = None

Reference to a remote array.

field time: Optional[StrictInt] = None

Sample time in milliseconds since UNIX epoch.

ConnectionRelationshipPerformanceReplicationGetResp

pydantic model pypureclient.flashblade.ConnectionRelationshipPerformanceReplicationGetResp(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[ConnectionRelationshipPerformanceReplication]] = None, total: Optional[ConstrainedListValue[ConnectionRelationshipPerformanceReplication]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[ConnectionRelationshipPerformanceReplication]] = None

field total: Optional[ConstrainedListValue[ConnectionRelationshipPerformanceReplication]] = None

Total of all records after filtering. If total_only query param is true, then no items will be returned.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

Context

pydantic model pypureclient.flashblade.Context(*, context: Optional[Reference] = None)

field context: Optional[Reference] = None

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.

ContinuousReplicationPerformance

pydantic model pypureclient.flashblade.ContinuousReplicationPerformance(*, received_bytes_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, transmitted_bytes_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, object_backlog: Optional[ObjectBacklog] = None)

field object_backlog: Optional[ObjectBacklog] = None

The total number of pending object operations and their size that are currently in the backlog.

field received_bytes_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Total bytes received per second.

field transmitted_bytes_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Total bytes transmitted per second.

CrossOriginResourceSharingPolicy

pydantic model pypureclient.flashblade.CrossOriginResourceSharingPolicy(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, enabled: Optional[StrictBool] = None, is_local: Optional[StrictBool] = None, location: Optional[FixedReference] = None, policy_type: Optional[StrictStr] = None, context: Optional[Reference] = None, bucket: Optional[FixedReference] = None, rules: Optional[ConstrainedListValue[CrossOriginResourceSharingPolicyRuleWithContext]] = None)

field bucket: Optional[FixedReference] = None

The bucket to which this policy belongs.

field context: Optional[Reference] = None

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.

field enabled: Optional[StrictBool] = None

If true, the policy is enabled. If not specified, defaults to true.

Constraints

• type = boolean

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field is_local: Optional[StrictBool] = None

Whether the policy is defined on the local array.

Constraints

• type = boolean

field location: Optional[FixedReference] = None

Reference to the array where the policy is defined.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field policy_type: Optional[StrictStr] = None

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.

field rules: Optional[ConstrainedListValue[CrossOriginResourceSharingPolicyRuleWithContext]] = None

Constraints

• maxItems = 100

CrossOriginResourceSharingPolicyGetResponse

pydantic model pypureclient.flashblade.CrossOriginResourceSharingPolicyGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None, items: Optional[ConstrainedListValue[CrossOriginResourceSharingPolicy]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[CrossOriginResourceSharingPolicy]] = None

A list of cross origin resource sharing policy objects.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

CrossOriginResourceSharingPolicyPatch

pydantic model pypureclient.flashblade.CrossOriginResourceSharingPolicyPatch(*, rules: Optional[ConstrainedListValue[CrossOriginResourceSharingPolicyRuleBulkManage]] = None)

field rules: Optional[ConstrainedListValue[CrossOriginResourceSharingPolicyRuleBulkManage]] = None

CrossOriginResourceSharingPolicyResponse

pydantic model pypureclient.flashblade.CrossOriginResourceSharingPolicyResponse(*, items: Optional[ConstrainedListValue[CrossOriginResourceSharingPolicy]] = None)

field items: Optional[ConstrainedListValue[CrossOriginResourceSharingPolicy]] = None

A list of cross origin resource sharing policy objects.

CrossOriginResourceSharingPolicyRule

pydantic model pypureclient.flashblade.CrossOriginResourceSharingPolicyRule(*, name: Optional[StrictStr] = None, allowed_headers: Optional[ConstrainedListValue[StrictStr]] = None, allowed_methods: Optional[ConstrainedListValue[StrictStr]] = None, allowed_origins: Optional[ConstrainedListValue[StrictStr]] = None, context: Optional[Reference] = None, policy: Optional[FixedReference] = None)

field allowed_headers: Optional[ConstrainedListValue[StrictStr]] = None

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 *.

field allowed_methods: Optional[ConstrainedListValue[StrictStr]] = None

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”].

field allowed_origins: Optional[ConstrainedListValue[StrictStr]] = None

A list of origins (domains) that are permitted to make cross-origin requests to access a bucket. The only currently supported allowed origin is *.

field context: Optional[Reference] = None

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.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field policy: Optional[FixedReference] = None

The policy to which this rule belongs.

CrossOriginResourceSharingPolicyRuleBulkManage

pydantic model pypureclient.flashblade.CrossOriginResourceSharingPolicyRuleBulkManage(*, allowed_headers: Optional[ConstrainedListValue[StrictStr]] = None, allowed_methods: Optional[ConstrainedListValue[StrictStr]] = None, allowed_origins: Optional[ConstrainedListValue[StrictStr]] = None, name: Optional[StrictStr] = None)

field allowed_headers: Optional[ConstrainedListValue[StrictStr]] = None

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 *.

field allowed_methods: Optional[ConstrainedListValue[StrictStr]] = None

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”].

field allowed_origins: Optional[ConstrainedListValue[StrictStr]] = None

A list of origins (domains) that are permitted to make cross-origin requests to access a bucket. The only currently supported allowed origin is *.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

CrossOriginResourceSharingPolicyRuleGetResponse

pydantic model pypureclient.flashblade.CrossOriginResourceSharingPolicyRuleGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None, items: Optional[ConstrainedListValue[CrossOriginResourceSharingPolicyRuleWithContext]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[CrossOriginResourceSharingPolicyRuleWithContext]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

CrossOriginResourceSharingPolicyRulePost

pydantic model pypureclient.flashblade.CrossOriginResourceSharingPolicyRulePost(*, allowed_headers: Optional[ConstrainedListValue[StrictStr]] = None, allowed_methods: Optional[ConstrainedListValue[StrictStr]] = None, allowed_origins: Optional[ConstrainedListValue[StrictStr]] = None)

field allowed_headers: Optional[ConstrainedListValue[StrictStr]] = None

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 *.

field allowed_methods: Optional[ConstrainedListValue[StrictStr]] = None

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”].

field allowed_origins: Optional[ConstrainedListValue[StrictStr]] = None

A list of origins (domains) that are permitted to make cross-origin requests to access a bucket. The only currently supported allowed origin is *.

CrossOriginResourceSharingPolicyRuleResponse

pydantic model pypureclient.flashblade.CrossOriginResourceSharingPolicyRuleResponse(*, items: Optional[ConstrainedListValue[CrossOriginResourceSharingPolicyRuleWithContext]] = None)

field items: Optional[ConstrainedListValue[CrossOriginResourceSharingPolicyRuleWithContext]] = None

CrossOriginResourceSharingPolicyRuleWithContext

pydantic model pypureclient.flashblade.CrossOriginResourceSharingPolicyRuleWithContext(*, name: Optional[StrictStr] = None, allowed_headers: Optional[ConstrainedListValue[StrictStr]] = None, allowed_methods: Optional[ConstrainedListValue[StrictStr]] = None, allowed_origins: Optional[ConstrainedListValue[StrictStr]] = None, context: Optional[Reference] = None, policy: Optional[FixedReference] = None)

field allowed_headers: Optional[ConstrainedListValue[StrictStr]] = None

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 *.

field allowed_methods: Optional[ConstrainedListValue[StrictStr]] = None

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”].

field allowed_origins: Optional[ConstrainedListValue[StrictStr]] = None

A list of origins (domains) that are permitted to make cross-origin requests to access a bucket. The only currently supported allowed origin is *.

field context: Optional[Reference] = None

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.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field policy: Optional[FixedReference] = None

The policy to which this rule belongs.

DirectoryService

pydantic model pypureclient.flashblade.DirectoryService(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, base_dn: Optional[StrictStr] = None, bind_password: Optional[StrictStr] = None, bind_user: Optional[StrictStr] = None, ca_certificate: Optional[Reference] = None, ca_certificate_group: Optional[Reference] = None, enabled: Optional[StrictBool] = None, management: Optional[DirectoryServiceManagement] = None, nfs: Optional[DirectoryServiceNfs] = None, services: Optional[ConstrainedListValue[StrictStr]] = None, smb: Optional[DirectoryServiceSmb] = None, uris: Optional[ConstrainedListValue[ConstrainedStrValue]] = None)

field base_dn: Optional[StrictStr] = None

Base of the Distinguished Name (DN) of the directory service groups.

field bind_password: Optional[StrictStr] = None

Obfuscated password used to query the directory.

field bind_user: Optional[StrictStr] = None

Username used to query the directory.

field ca_certificate: Optional[Reference] = None

CA certificate used to validate the authenticity of the configured servers.

field ca_certificate_group: Optional[Reference] = None

A certificate group containing CA certificates that can be used to validate the authenticity of the configured servers.

field enabled: Optional[StrictBool] = None

Is the directory service enabled or not?

Constraints

• type = boolean

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field management: Optional[DirectoryServiceManagement] = None

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field nfs: Optional[DirectoryServiceNfs] = None

field services: Optional[ConstrainedListValue[StrictStr]] = None

Services that the directory service configuration is used for.

field smb: Optional[DirectoryServiceSmb] = None

field uris: Optional[ConstrainedListValue[ConstrainedStrValue]] = None

List of URIs for the configured directory servers.

Constraints

• maxItems = 30

DirectoryServiceGetResponse

pydantic model pypureclient.flashblade.DirectoryServiceGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[DirectoryService]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[DirectoryService]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

DirectoryServiceManagement

pydantic model pypureclient.flashblade.DirectoryServiceManagement(*, user_login_attribute: Optional[StrictStr] = None, user_object_class: Optional[StrictStr] = None)

Properties specific to the management service.

field user_login_attribute: Optional[StrictStr] = None

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.

field user_object_class: Optional[StrictStr] = None

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.

DirectoryServiceNfs

pydantic model pypureclient.flashblade.DirectoryServiceNfs(*, nis_domains: Optional[ConstrainedListValue[StrictStr]] = None, nis_servers: Optional[ConstrainedListValue[StrictStr]] = None)

Properties specific to the NFS service.

field nis_domains: Optional[ConstrainedListValue[StrictStr]] = None

NIS domains to search.

field nis_servers: Optional[ConstrainedListValue[StrictStr]] = None

A list of the IP addresses or hostnames of NIS servers to search.

DirectoryServiceResponse

pydantic model pypureclient.flashblade.DirectoryServiceResponse(*, items: Optional[ConstrainedListValue[DirectoryService]] = None)

field items: Optional[ConstrainedListValue[DirectoryService]] = None

DirectoryServiceRole

pydantic model pypureclient.flashblade.DirectoryServiceRole(*, group: Optional[StrictStr] = None, group_base: Optional[StrictStr] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, role: Optional[ReferenceWritable] = None)

field group: Optional[StrictStr] = None

Common Name (CN) of the directory service group containing users with authority level of the specified role name.

field group_base: Optional[StrictStr] = None

Specifies where the configured group is located in the directory tree.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

Name of the role mapping object.

field role: Optional[ReferenceWritable] = None

A reference to the role; can be any role that exists on the system.

DirectoryServiceRolesGetResponse

pydantic model pypureclient.flashblade.DirectoryServiceRolesGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[DirectoryServiceRole]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[DirectoryServiceRole]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

DirectoryServiceRolesResponse

pydantic model pypureclient.flashblade.DirectoryServiceRolesResponse(*, items: Optional[ConstrainedListValue[DirectoryServiceRole]] = None)

field items: Optional[ConstrainedListValue[DirectoryServiceRole]] = None

DirectoryServiceSmb

pydantic model pypureclient.flashblade.DirectoryServiceSmb(*, join_ou: Optional[StrictStr] = None)

DEPRECATED - Properties specific to the SMB service.

field join_ou: Optional[StrictStr] = None

Optional organizational unit where the machine account for the directory service will be created.

Dns

pydantic model pypureclient.flashblade.Dns(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, domain: Optional[StrictStr] = None, nameservers: Optional[ConstrainedListValue[StrictStr]] = None, services: Optional[ConstrainedListValue[StrictStr]] = None, sources: Optional[ConstrainedListValue[Reference]] = None)

field domain: Optional[StrictStr] = None

Domain suffix to be appended by the appliance when performing DNS lookups.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

A name chosen by the user. Can be changed. Must be locally unique.

field nameservers: Optional[ConstrainedListValue[StrictStr]] = None

List of DNS server IP addresses.

Constraints

• maxItems = 3

field services: Optional[ConstrainedListValue[StrictStr]] = None

The list of services utilizing the DNS configuration.

field sources: Optional[ConstrainedListValue[Reference]] = None

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.

Constraints

• maxItems = 1

DnsGetResponse

pydantic model pypureclient.flashblade.DnsGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Dns]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[Dns]] = None

A list of dns objects.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

DnsPost

pydantic model pypureclient.flashblade.DnsPost(*, domain: Optional[StrictStr] = None, nameservers: Optional[ConstrainedListValue[StrictStr]] = None, services: Optional[ConstrainedListValue[StrictStr]] = None, sources: Optional[ConstrainedListValue[Reference]] = None)

field domain: Optional[StrictStr] = None

Domain suffix to be appended by the appliance when performing DNS lookups.

field nameservers: Optional[ConstrainedListValue[StrictStr]] = None

List of DNS server IP addresses.

Constraints

• maxItems = 3

field services: Optional[ConstrainedListValue[StrictStr]] = None

The list of services utilizing the DNS configuration.

field sources: Optional[ConstrainedListValue[Reference]] = None

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.

Constraints

• maxItems = 1

DnsResponse

pydantic model pypureclient.flashblade.DnsResponse(*, items: Optional[ConstrainedListValue[Dns]] = None)

field items: Optional[ConstrainedListValue[Dns]] = None

A list of dns objects.

Drive

pydantic model pypureclient.flashblade.Drive(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, details: Optional[StrictStr] = None, progress: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, raw_capacity: Optional[StrictInt] = None, status: Optional[StrictStr] = None, type: Optional[StrictStr] = None)

field details: Optional[StrictStr] = None

Details about the status of the drive if not healthy.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field progress: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Reflects this drive’s current progress toward completing a planned evacuation. If a planned evacuation is not occurring, the value will be null.

field raw_capacity: Optional[StrictInt] = None

field status: Optional[StrictStr] = None

Current status of the drive. Valid values are evacuated, evacuating, healthy, unhealthy, unused, and updating.

field type: Optional[StrictStr] = None

The type of the module. Valid values are DFM and DFMe.

DriveGetResponse

pydantic model pypureclient.flashblade.DriveGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Drive]] = None, total: Optional[Dict[str, Any]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[Drive]] = None

A list of drive objects.

field total: Optional[Dict[str, Any]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

ErrorContextResponse

pydantic model pypureclient.flashblade.ErrorContextResponse(*, errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None)

field errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

ErrorContextResponseErrors

pydantic model pypureclient.flashblade.ErrorContextResponseErrors(*, context: Optional[StrictStr] = None, location_context: Optional[FixedReferenceWithType] = None, message: Optional[StrictStr] = None)

field context: Optional[StrictStr] = None

Contains information relating to the cause of this error, or the name of the object that was being processed when the error was encountered. This may be null for more general errors.

field location_context: Optional[FixedReferenceWithType] = None

Contains information relating to the context in which the request was executing when the error occurred. For example, this may be the name of an array in the same fleet. This may be null for more general errors, or if no explicit context parameter was provided with the request.

field message: Optional[StrictStr] = None

A description of the error which occurred.

Eula

pydantic model pypureclient.flashblade.Eula(*, agreement: Optional[StrictStr] = None, signature: Optional[EulaSignature] = None)

field agreement: Optional[StrictStr] = None

End User Agreement text.

field signature: Optional[EulaSignature] = None

EulaGetResponse

pydantic model pypureclient.flashblade.EulaGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Eula]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[Eula]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

EulaResponse

pydantic model pypureclient.flashblade.EulaResponse(*, items: Optional[ConstrainedListValue[Eula]] = None)

field items: Optional[ConstrainedListValue[Eula]] = None

EulaSignature

pydantic model pypureclient.flashblade.EulaSignature(*, accepted: Optional[StrictInt] = None, company: Optional[StrictStr] = None, name: Optional[StrictStr] = None, title: Optional[StrictStr] = None)

field accepted: Optional[StrictInt] = None

Accepted time in milliseconds since the UNIX epoch.

field company: Optional[StrictStr] = None

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.

field name: Optional[StrictStr] = None

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.

field title: Optional[StrictStr] = None

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.

FileInfo

pydantic model pypureclient.flashblade.FileInfo(*, name: Optional[StrictStr] = None, length: Optional[StrictInt] = None)

field length: Optional[StrictInt] = None

Length of the file (in bytes).

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

FileLock

pydantic model pypureclient.flashblade.FileLock(*, name: Optional[StrictStr] = None, access_type: Optional[StrictStr] = None, client: Optional[FixedReferenceNoId] = None, created_at: Optional[StrictInt] = None, inode: Optional[StrictInt] = None, path: Optional[StrictStr] = None, protocol: Optional[StrictStr] = None, range: Optional[FileLockRange] = None, source: Optional[FixedReference] = None)

field access_type: Optional[StrictStr] = None

Type of access the lock provides. Valid values are shared, exclusive and no-access.

field client: Optional[FixedReferenceNoId] = None

Reference to the file system client that holds the lock.

field created_at: Optional[StrictInt] = None

Creation timestamp of the lock. Measured in milliseconds since the UNIX epoch.

field inode: Optional[StrictInt] = None

The inode of the file where the lock is found relative to the specified source.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field path: Optional[StrictStr] = None

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.

field protocol: Optional[StrictStr] = None

The protocol utilized for obtaining and managing the lock. Valid values include NLM, NFSv4.1 and SMB.

field range: Optional[FileLockRange] = None

field source: Optional[FixedReference] = None

Reference to location where the path/inode can be found.

FileLockGetResponse

pydantic model pypureclient.flashblade.FileLockGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[FileLock]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[FileLock]] = None

A list of file locks.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

FileLockNlmReclamationResponse

pydantic model pypureclient.flashblade.FileLockNlmReclamationResponse(*, items: Optional[ConstrainedListValue[FileSystemLockNlmReclamation]] = None)

field items: Optional[ConstrainedListValue[FileSystemLockNlmReclamation]] = None

FileLockRange

pydantic model pypureclient.flashblade.FileLockRange(*, length: Optional[StrictInt] = None, offset: Optional[StrictInt] = None)

The range in bytes (offset, length) the lock covers within a file. If the lock reaches the end of the file, the length will be null. If the lock is set for the entire file, both offset and length will be null.

field length: Optional[StrictInt] = None

field offset: Optional[StrictInt] = None

FileLockResponse

pydantic model pypureclient.flashblade.FileLockResponse(*, items: Optional[ConstrainedListValue[FileLock]] = None)

field items: Optional[ConstrainedListValue[FileLock]] = None

A list of file locks.

FileSession

pydantic model pypureclient.flashblade.FileSession(*, name: Optional[StrictStr] = None, authentication: Optional[StrictStr] = None, client: Optional[FixedReferenceNameOnly] = None, connection_time: Optional[StrictInt] = None, idle_time: Optional[StrictInt] = None, opens: Optional[StrictInt] = None, port: Optional[StrictInt] = None, protocol: Optional[StrictStr] = None, time: Optional[StrictInt] = None, user: Optional[UserNoId] = None)

field authentication: Optional[StrictStr] = None

Describes how was the user authenticated. Valid values include KRB and NTLMv2.

field client: Optional[FixedReferenceNameOnly] = None

Client that holds the session.

field connection_time: Optional[StrictInt] = None

Connection time in milliseconds since UNIX epoch.

field idle_time: Optional[StrictInt] = None

Duration in milliseconds that indicates how long the session has been idle.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field opens: Optional[StrictInt] = None

Number of opens for the given session.

field port: Optional[StrictInt] = None

Port number the client is connected from.

field protocol: Optional[StrictStr] = None

The protocol utilized for obtaining and managing the session. Valid values include nfs and smb.

field time: Optional[StrictInt] = None

Current time in milliseconds since UNIX epoch.

field user: Optional[UserNoId] = None

The user who has created the session.

FileSessionGetResponse

pydantic model pypureclient.flashblade.FileSessionGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[FileSession]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[FileSession]] = None

A list of file sessions.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

FileSessionResponse

pydantic model pypureclient.flashblade.FileSessionResponse(*, items: Optional[ConstrainedListValue[FileSession]] = None)

field items: Optional[ConstrainedListValue[FileSession]] = None

A list of file sessions.

FileSystem

pydantic model pypureclient.flashblade.FileSystem(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, context: Optional[Reference] = None, created: Optional[StrictInt] = None, default_group_quota: Optional[StrictInt] = None, default_user_quota: Optional[StrictInt] = None, destroyed: Optional[StrictBool] = None, eradication_config: Optional[FileSystemEradicationConfig] = None, fast_remove_directory_enabled: Optional[StrictBool] = None, group_ownership: Optional[StrictStr] = None, hard_limit_enabled: Optional[StrictBool] = None, http: Optional[Http] = None, multi_protocol: Optional[MultiProtocol] = None, nfs: Optional[Nfs] = None, promotion_status: Optional[StrictStr] = None, provisioned: Optional[StrictInt] = None, qos_policy: Optional[FixedReference] = None, requested_promotion_state: Optional[StrictStr] = None, smb: Optional[Smb] = None, snapshot_directory_enabled: Optional[StrictBool] = None, source: Optional[LocationReference] = None, space: Optional[Space] = None, storage_class: Optional[StorageClassInfo] = None, time_remaining: Optional[StrictInt] = None, writable: Optional[StrictBool] = None)

field context: Optional[Reference] = None

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.

field created: Optional[StrictInt] = None

Creation timestamp of the file system.

field default_group_quota: Optional[StrictInt] = None

The default space quota for a group writing to this file system.

field default_user_quota: Optional[StrictInt] = None

The default space quota for a user writing to this file system.

field destroyed: Optional[StrictBool] = None

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.

Constraints

• type = boolean

field eradication_config: Optional[FileSystemEradicationConfig] = None

field fast_remove_directory_enabled: Optional[StrictBool] = None

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.

Constraints

• type = boolean

field group_ownership: Optional[StrictStr] = None

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.

field hard_limit_enabled: Optional[StrictBool] = None

If set to true, the file system’s size, as defined by provisioned, is used as a hard limit quota.

Constraints

• type = boolean

field http: Optional[Http] = None

HTTP configuration.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field multi_protocol: Optional[MultiProtocol] = None

Multi-protocol configuration.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field nfs: Optional[Nfs] = None

NFS configuration.

field promotion_status: Optional[StrictStr] = None

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.

field provisioned: Optional[StrictInt] = None

The provisioned size of the file system, displayed in bytes. If set to an empty string (“”), the file system is unlimited in size.

field qos_policy: Optional[FixedReference] = None

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.

field requested_promotion_state: Optional[StrictStr] = None

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.

field smb: Optional[Smb] = None

SMB configuration.

field snapshot_directory_enabled: Optional[StrictBool] = None

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.

Constraints

• type = boolean

field source: Optional[LocationReference] = None

A reference to the source file system.

field space: Optional[Space] = None

The space usage of the file system.

field storage_class: Optional[StorageClassInfo] = None

field time_remaining: Optional[StrictInt] = None

Time in milliseconds before the file system is eradicated. null if not destroyed.

field writable: Optional[StrictBool] = None

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.

Constraints

• type = boolean

FileSystemClient

pydantic model pypureclient.flashblade.FileSystemClient(*, name: Optional[StrictStr] = None)

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

FileSystemClientsGetResponse

pydantic model pypureclient.flashblade.FileSystemClientsGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[FileSystemClient]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[FileSystemClient]] = None

A list of file system clients.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

FileSystemClientsResponse

pydantic model pypureclient.flashblade.FileSystemClientsResponse(*, items: Optional[ConstrainedListValue[FileSystemClient]] = None)

field items: Optional[ConstrainedListValue[FileSystemClient]] = None

A list of file system clients.

FileSystemEradicationConfig

pydantic model pypureclient.flashblade.FileSystemEradicationConfig(*, eradication_mode: Optional[StrictStr] = None, manual_eradication: Optional[StrictStr] = None)

Configuration settings related to file system eradication.

field eradication_mode: Optional[StrictStr] = None

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.

field manual_eradication: Optional[StrictStr] = None

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.

FileSystemExport

pydantic model pypureclient.flashblade.FileSystemExport(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, context: Optional[Reference] = None, enabled: Optional[StrictBool] = None, export_name: Optional[StrictStr] = None, member: Optional[FixedReference] = None, policy: Optional[Reference] = None, policy_type: Optional[StrictStr] = None, server: Optional[FixedReference] = None, share_policy: Optional[Reference] = None, status: Optional[StrictStr] = None)

field context: Optional[Reference] = None

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.

field enabled: Optional[StrictBool] = None

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.

Constraints

• type = boolean

field export_name: Optional[StrictStr] = None

The name of the export used by clients to mount the file system. Export names must be unique within the same protocol/server combination.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field member: Optional[FixedReference] = None

Reference to the file system the policy is applied to.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field policy: Optional[Reference] = None

Reference to the NFS export policy or SMB client policy.

field policy_type: Optional[StrictStr] = None

Policy type attached to the export. It is either SMB or NFS.

field server: Optional[FixedReference] = None

Reference to the server the export will be visible on.

field share_policy: Optional[Reference] = None

Reference to the SMB share policy (only used for SMB).

field status: Optional[StrictStr] = None

Explains why enabled is false. Valid values include policy_disabled and protocol_disabled.

FileSystemExportGetResponse

pydantic model pypureclient.flashblade.FileSystemExportGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[FileSystemExport]] = None, errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[FileSystemExport]] = None

A list of file system export objects.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

FileSystemExportPost

pydantic model pypureclient.flashblade.FileSystemExportPost(*, export_name: Optional[StrictStr] = None, server: Optional[Reference] = None, share_policy: Optional[Reference] = None)

field export_name: Optional[StrictStr] = None

The name of the export to create. Export names must be unique within the same protocol and server.

field server: Optional[Reference] = None

Reference to the server the export will be visible on.

field share_policy: Optional[Reference] = None

Reference to the SMB share policy (only used for SMB).

FileSystemExportResponse

pydantic model pypureclient.flashblade.FileSystemExportResponse(*, items: Optional[ConstrainedListValue[FileSystemExport]] = None)

field items: Optional[ConstrainedListValue[FileSystemExport]] = None

A list of file system export objects.

FileSystemGetResponse

pydantic model pypureclient.flashblade.FileSystemGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[FileSystem]] = None, errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None, total: Optional[FileSystem] = None)

field continuation_token: Optional[StrictStr] = None

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).

field errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[FileSystem]] = None

A list of file system objects.

field total: Optional[FileSystem] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

FileSystemGroupPerformance

pydantic model pypureclient.flashblade.FileSystemGroupPerformance(*, name: Optional[StrictStr] = None, bytes_per_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, bytes_per_read: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, bytes_per_write: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, file_system: Optional[FixedReference] = None, group: Optional[Group] = None, others_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, read_bytes_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, reads_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, time: Optional[StrictInt] = None, usec_per_other_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, usec_per_read_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, usec_per_write_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, write_bytes_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, writes_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None)

field bytes_per_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average operation size (read bytes+write bytes/read ops+write ops).

field bytes_per_read: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average read size in bytes per read operation.

field bytes_per_write: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average write size in bytes per write operation.

field file_system: Optional[FixedReference] = None

The file system on which the performance was measured.

field group: Optional[Group] = None

The group whose performance is represented.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field others_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Other operations processed per second.

field read_bytes_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Bytes read per second.

field reads_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Read requests processed per second.

field time: Optional[StrictInt] = None

Sample time in milliseconds since UNIX epoch.

field usec_per_other_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average time, measured in microseconds, it takes the array to process other operations.

field usec_per_read_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average time, measured in microseconds, it takes the array to process a read request.

field usec_per_write_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average time, measured in microseconds, it takes the array to process a write request.

field write_bytes_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Bytes written per second.

field writes_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Write requests processed per second.

FileSystemGroupsPerformanceGetResponse

pydantic model pypureclient.flashblade.FileSystemGroupsPerformanceGetResponse(*, items: Optional[ConstrainedListValue[FileSystemGroupPerformance]] = None, total: Optional[ConstrainedListValue[FileSystemGroupPerformance]] = None)

field items: Optional[ConstrainedListValue[FileSystemGroupPerformance]] = None

A list of file system group performance objects.

field total: Optional[ConstrainedListValue[FileSystemGroupPerformance]] = None

Total of all records after filtering. If total_only query param is true, then no items will be returned.

FileSystemLockNlmReclamation

pydantic model pypureclient.flashblade.FileSystemLockNlmReclamation(*, end: Optional[StrictInt] = None, start: Optional[StrictInt] = None)

field end: Optional[StrictInt] = None

End time of the NLM reclamation in milliseconds since the UNIX epoch.

field start: Optional[StrictInt] = None

Start time of the NLM reclamation in milliseconds since the UNIX epoch.

FileSystemOpenFile

pydantic model pypureclient.flashblade.FileSystemOpenFile(*, client: Optional[FixedReferenceNameOnly] = None, id: Optional[StrictStr] = None, lock_count: Optional[ConstrainedIntValue] = None, mode: Optional[StrictStr] = None, path: Optional[StrictStr] = None, session: Optional[FixedReferenceNameOnly] = None, source: Optional[FixedReference] = None, user: Optional[UserNoId] = None)

field client: Optional[FixedReferenceNameOnly] = None

Client that has the file open.

field id: Optional[StrictStr] = None

The unique identifier of the open file.

field lock_count: Optional[ConstrainedIntValue] = None

The number of locks on the file.

Constraints

• minimum = 0

field mode: Optional[StrictStr] = None

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.

field path: Optional[StrictStr] = None

The path to the open file.

field session: Optional[FixedReferenceNameOnly] = None

The name of the session with the open file.

field source: Optional[FixedReference] = None

Reference to the file system.

field user: Optional[UserNoId] = None

The user who has the file open.

FileSystemOpenFilesGetResponse

pydantic model pypureclient.flashblade.FileSystemOpenFilesGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[FileSystemOpenFile]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[FileSystemOpenFile]] = None

A list of file system open file objects.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

FileSystemOpenFilesResponse

pydantic model pypureclient.flashblade.FileSystemOpenFilesResponse(*, items: Optional[ConstrainedListValue[FileSystemOpenFile]] = None)

field items: Optional[ConstrainedListValue[FileSystemOpenFile]] = None

A list of file system open file objects.

FileSystemPatch

pydantic model pypureclient.flashblade.FileSystemPatch(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, created: Optional[StrictInt] = None, default_group_quota: Optional[StrictInt] = None, default_user_quota: Optional[StrictInt] = None, destroyed: Optional[StrictBool] = None, fast_remove_directory_enabled: Optional[StrictBool] = None, group_ownership: Optional[StrictStr] = None, hard_limit_enabled: Optional[StrictBool] = None, http: Optional[Http] = None, multi_protocol: Optional[MultiProtocol] = None, nfs: Optional[NfsPatch] = None, promotion_status: Optional[StrictStr] = None, provisioned: Optional[StrictInt] = None, qos_policy: Optional[Reference] = None, requested_promotion_state: Optional[StrictStr] = None, smb: Optional[Smb] = None, snapshot_directory_enabled: Optional[StrictBool] = None, source: Optional[FixedLocationReference] = None, storage_class: Optional[StorageClassInfo] = None, time_remaining: Optional[StrictInt] = None, writable: Optional[StrictBool] = None)

field created: Optional[StrictInt] = None

Creation timestamp of the file system.

field default_group_quota: Optional[StrictInt] = None

The default space quota for a group writing to this file system.

field default_user_quota: Optional[StrictInt] = None

The default space quota for a user writing to this file system.

field destroyed: Optional[StrictBool] = None

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.

Constraints

• type = boolean

field fast_remove_directory_enabled: Optional[StrictBool] = None

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.

Constraints

• type = boolean

field group_ownership: Optional[StrictStr] = None

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.

field hard_limit_enabled: Optional[StrictBool] = None

If set to true, the file system’s size, as defined by provisioned, is used as a hard limit quota.

Constraints

• type = boolean

field http: Optional[Http] = None

HTTP configuration.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field multi_protocol: Optional[MultiProtocol] = None

Multi-protocol configuration.

field name: Optional[StrictStr] = None

A name chosen by the user. Can be changed. Must be locally unique.

field nfs: Optional[NfsPatch] = None

NFS configuration.

field promotion_status: Optional[StrictStr] = None

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.

field provisioned: Optional[StrictInt] = None

The provisioned size of the file system, displayed in bytes. If set to an empty string (“”), the file system is unlimited in size.

field qos_policy: Optional[Reference] = None

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.

field requested_promotion_state: Optional[StrictStr] = None

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.

field smb: Optional[Smb] = None

SMB configuration.

field snapshot_directory_enabled: Optional[StrictBool] = None

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.

Constraints

• type = boolean

field source: Optional[FixedLocationReference] = None

A reference to the source file system.

field storage_class: Optional[StorageClassInfo] = None

field time_remaining: Optional[StrictInt] = None

Time in milliseconds before the file system is eradicated. null if not destroyed.

field writable: Optional[StrictBool] = None

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.

Constraints

• type = boolean

FileSystemPerformance

pydantic model pypureclient.flashblade.FileSystemPerformance(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, bytes_per_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, bytes_per_read: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, bytes_per_write: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, others_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, read_bytes_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, reads_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, time: Optional[StrictInt] = None, usec_per_other_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, usec_per_read_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, usec_per_write_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, write_bytes_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, writes_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None)

field bytes_per_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average operation size (read bytes+write bytes/read ops+write ops).

field bytes_per_read: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average read size in bytes per read operation.

field bytes_per_write: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average write size in bytes per write operation.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field others_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Other operations processed per second.

field read_bytes_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Bytes read per second.

field reads_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Read requests processed per second.

field time: Optional[StrictInt] = None

Sample time in milliseconds since UNIX epoch.

field usec_per_other_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average time, measured in microseconds, it takes the array to process other operations.

field usec_per_read_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average time, measured in microseconds, it takes the array to process a read request.

field usec_per_write_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average time, measured in microseconds, it takes the array to process a write request.

field write_bytes_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Bytes written per second.

field writes_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Write requests processed per second.

FileSystemPerformanceGetResponse

pydantic model pypureclient.flashblade.FileSystemPerformanceGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[FileSystemPerformance]] = None, total: Optional[ConstrainedListValue[FileSystemPerformance]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[FileSystemPerformance]] = None

A list of file system performance objects.

field total: Optional[ConstrainedListValue[FileSystemPerformance]] = None

Total of all records after filtering. If total_only query param is true, then no items will be returned.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

FileSystemPost

pydantic model pypureclient.flashblade.FileSystemPost(*, default_group_quota: Optional[StrictInt] = None, default_user_quota: Optional[StrictInt] = None, eradication_config: Optional[FileSystemEradicationConfig] = None, fast_remove_directory_enabled: Optional[StrictBool] = None, group_ownership: Optional[StrictStr] = None, hard_limit_enabled: Optional[StrictBool] = None, http: Optional[Http] = None, multi_protocol: Optional[MultiProtocolPost] = None, nfs: Optional[Nfs] = None, provisioned: Optional[StrictInt] = None, qos_policy: Optional[Reference] = None, requested_promotion_state: Optional[StrictStr] = None, smb: Optional[SmbPost] = None, snapshot_directory_enabled: Optional[StrictBool] = None, source: Optional[Reference] = None, writable: Optional[StrictBool] = None)

field default_group_quota: Optional[StrictInt] = None

The default space quota for a group writing to this file system.

field default_user_quota: Optional[StrictInt] = None

The default space quota for a user writing to this file system.

field eradication_config: Optional[FileSystemEradicationConfig] = None

field fast_remove_directory_enabled: Optional[StrictBool] = None

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.

Constraints

• type = boolean

field group_ownership: Optional[StrictStr] = None

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.

field hard_limit_enabled: Optional[StrictBool] = None

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.

Constraints

• type = boolean

field http: Optional[Http] = None

HTTP configuration.

field multi_protocol: Optional[MultiProtocolPost] = None

Multi-protocol configuration.

field nfs: Optional[Nfs] = None

NFS configuration.

field provisioned: Optional[StrictInt] = None

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.

field qos_policy: Optional[Reference] = None

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.

field requested_promotion_state: Optional[StrictStr] = None

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.

field smb: Optional[SmbPost] = None

SMB configuration.

field snapshot_directory_enabled: Optional[StrictBool] = None

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.

Constraints

• type = boolean

field source: Optional[Reference] = None

The source snapshot whose data is copied to the file system specified.

field writable: Optional[StrictBool] = None

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.

Constraints

• type = boolean

FileSystemReplicaLink

pydantic model pypureclient.flashblade.FileSystemReplicaLink(*, id: Optional[StrictStr] = None, direction: Optional[StrictStr] = None, lag: Optional[StrictInt] = None, status_details: Optional[StrictStr] = None, context: Optional[Reference] = None, link_type: Optional[StrictStr] = None, local_file_system: Optional[FixedReference] = None, policies: Optional[ConstrainedListValue[LocationReference]] = None, recovery_point: Optional[StrictInt] = None, remote: Optional[FixedReferenceNoResourceType] = None, remote_file_system: Optional[FixedReferenceNoResourceType] = None, status: Optional[StrictStr] = None)

field context: Optional[Reference] = None

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.

field direction: Optional[StrictStr] = None

The direction of replication. Valid values are inbound and outbound.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field lag: Optional[StrictInt] = None

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.

field link_type: Optional[StrictStr] = None

Type of the replica link. Values include full-replica, and partial-replica.

field local_file_system: Optional[FixedReference] = None

Reference to a local file system.

field policies: Optional[ConstrainedListValue[LocationReference]] = None

field recovery_point: Optional[StrictInt] = None

Time when the last replicated snapshot was created, in milliseconds since UNIX epoch. I.e. the recovery point if the file system is promoted.

field remote: Optional[FixedReferenceNoResourceType] = None

Reference to a remote array.

field remote_file_system: Optional[FixedReferenceNoResourceType] = None

Reference to a remote file system.

field status: Optional[StrictStr] = None

Status of the replica link. Values include replicating, idle, and unhealthy.

field status_details: Optional[StrictStr] = None

Detailed information about the status of the replica link when it is unhealthy.

FileSystemReplicaLinkGetResponse

pydantic model pypureclient.flashblade.FileSystemReplicaLinkGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[FileSystemReplicaLink]] = None, errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[FileSystemReplicaLink]] = None

A list of file system replica link objects.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

FileSystemReplicaLinkResponse

pydantic model pypureclient.flashblade.FileSystemReplicaLinkResponse(*, items: Optional[ConstrainedListValue[FileSystemReplicaLink]] = None)

field items: Optional[ConstrainedListValue[FileSystemReplicaLink]] = None

A list of file system replica link objects.

FileSystemResponse

pydantic model pypureclient.flashblade.FileSystemResponse(*, items: Optional[ConstrainedListValue[FileSystem]] = None)

field items: Optional[ConstrainedListValue[FileSystem]] = None

A list of file system objects.

FileSystemSnapshot

pydantic model pypureclient.flashblade.FileSystemSnapshot(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, context: Optional[Reference] = None, created: Optional[StrictInt] = None, destroyed: Optional[StrictBool] = None, owner: Optional[FixedReference] = None, owner_destroyed: Optional[StrictBool] = None, policies: Optional[ConstrainedListValue[FixedLocationReference]] = None, policy: Optional[FixedLocationReference] = None, source: Optional[FixedLocationReference] = None, suffix: Optional[StrictStr] = None, time_remaining: Optional[StrictInt] = None)

field context: Optional[Reference] = None

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.

field created: Optional[StrictInt] = None

Creation timestamp of the object.

field destroyed: Optional[StrictBool] = None

Is the file system snapshot destroyed? If not specified, defaults to false.

Constraints

• type = boolean

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

A name chosen by the user. Can be changed. Must be locally unique.

field owner: Optional[FixedReference] = None

A reference to the file system that owns this snapshot. If the owner is destroyed, this will be destroyed.

field owner_destroyed: Optional[StrictBool] = None

Is the owning file system destroyed?

Constraints

• type = boolean

field policies: Optional[ConstrainedListValue[FixedLocationReference]] = None

An array of references to the associated policies.

field policy: Optional[FixedLocationReference] = None

A reference to the associated policy that drives the behavior of the snapshot.

field source: Optional[FixedLocationReference] = None

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.

field suffix: Optional[StrictStr] = None

The suffix of the snapshot, e.g., snap1.

field time_remaining: Optional[StrictInt] = None

Time in milliseconds before the file system snapshot is eradicated. null if not destroyed.

FileSystemSnapshotGetResponse

pydantic model pypureclient.flashblade.FileSystemSnapshotGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[FileSystemSnapshot]] = None, errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None, total: Optional[FileSystemSnapshot] = None)

field continuation_token: Optional[StrictStr] = None

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).

field errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[FileSystemSnapshot]] = None

A list of file system snapshot objects.

field total: Optional[FileSystemSnapshot] = None

If total_only query param is true, then it will be a total of all records after filtering and no items will be returned. If total_only is false, then it will be a total of all records on this page.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

FileSystemSnapshotGetTransferResponse

pydantic model pypureclient.flashblade.FileSystemSnapshotGetTransferResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[FileSystemSnapshotTransfer]] = None, errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None, total: Optional[FileSystemSnapshotTransfer] = None)

field continuation_token: Optional[StrictStr] = None

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).

field errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[FileSystemSnapshotTransfer]] = None

A list of file system snapshot objects.

field total: Optional[FileSystemSnapshotTransfer] = None

If total_only query param is true, then it will be a total of all records after filtering and no items will be returned. If total_only is false, then it will be a total of all records on this page.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

FileSystemSnapshotPost

pydantic model pypureclient.flashblade.FileSystemSnapshotPost(*, suffix: Optional[StrictStr] = None)

field suffix: Optional[StrictStr] = None

The suffix of the snapshot, e.g., snap1.

FileSystemSnapshotResponse

pydantic model pypureclient.flashblade.FileSystemSnapshotResponse(*, items: Optional[ConstrainedListValue[FileSystemSnapshot]] = None)

field items: Optional[ConstrainedListValue[FileSystemSnapshot]] = None

A list of file system snapshot objects.

FileSystemSnapshotTransfer

pydantic model pypureclient.flashblade.FileSystemSnapshotTransfer(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, context: Optional[Reference] = None, completed: Optional[StrictInt] = None, data_transferred: Optional[StrictInt] = None, direction: Optional[StrictStr] = None, local_snapshot: Optional[FixedReferenceNoResourceType] = None, progress: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, remote: Optional[FixedReferenceNoResourceType] = None, remote_snapshot: Optional[FixedReferenceNoResourceType] = None, started: Optional[StrictInt] = None, status: Optional[StrictStr] = None)

field completed: Optional[StrictInt] = None

A timestamp at which the replication of the snapshot completed.

field context: Optional[Reference] = None

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.

field data_transferred: Optional[StrictInt] = None

The amount of data transferred to the target, in bytes.

field direction: Optional[StrictStr] = None

The direction of replication. Valid values are inbound and outbound.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field local_snapshot: Optional[FixedReferenceNoResourceType] = None

A reference to the associated local file system snapshot.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field progress: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

A percentage that indicates how much progress has been made on the transfer.

field remote: Optional[FixedReferenceNoResourceType] = None

The array where the remote file system snapshot is located.

field remote_snapshot: Optional[FixedReferenceNoResourceType] = None

A reference to the associated remote file system snapshot.

field started: Optional[StrictInt] = None

A timestamp at which the replication of the snapshot started.

field status: Optional[StrictStr] = None

The status of current replication. Valid values are completed, in-progress, and queued.

FileSystemSnapshotTransferResponse

pydantic model pypureclient.flashblade.FileSystemSnapshotTransferResponse(*, items: Optional[ConstrainedListValue[FileSystemSnapshotTransfer]] = None)

field items: Optional[ConstrainedListValue[FileSystemSnapshotTransfer]] = None

A list of file system snapshot objects.

FileSystemUserPerformance

pydantic model pypureclient.flashblade.FileSystemUserPerformance(*, name: Optional[StrictStr] = None, bytes_per_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, bytes_per_read: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, bytes_per_write: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, file_system: Optional[FixedReference] = None, others_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, read_bytes_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, reads_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, time: Optional[StrictInt] = None, usec_per_other_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, usec_per_read_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, usec_per_write_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, user: Optional[User] = None, write_bytes_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, writes_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None)

field bytes_per_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average operation size (read bytes+write bytes/read ops+write ops).

field bytes_per_read: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average read size in bytes per read operation.

field bytes_per_write: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average write size in bytes per write operation.

field file_system: Optional[FixedReference] = None

The file system on which the performance was measured.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field others_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Other operations processed per second.

field read_bytes_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Bytes read per second.

field reads_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Read requests processed per second.

field time: Optional[StrictInt] = None

Sample time in milliseconds since UNIX epoch.

field usec_per_other_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average time, measured in microseconds, it takes the array to process other operations.

field usec_per_read_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average time, measured in microseconds, it takes the array to process a read request.

field usec_per_write_op: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Average time, measured in microseconds, it takes the array to process a write request.

field user: Optional[User] = None

The user whose performance is represented.

field write_bytes_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Bytes written per second.

field writes_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Write requests processed per second.

FileSystemUsersPerformanceGetResponse

pydantic model pypureclient.flashblade.FileSystemUsersPerformanceGetResponse(*, items: Optional[ConstrainedListValue[FileSystemUserPerformance]] = None, total: Optional[ConstrainedListValue[FileSystemUserPerformance]] = None)

field items: Optional[ConstrainedListValue[FileSystemUserPerformance]] = None

A list of file system user performance objects.

field total: Optional[ConstrainedListValue[FileSystemUserPerformance]] = None

Total of all records after filtering. If total_only query param is true, then no items will be returned.

FixedLocationReference

pydantic model pypureclient.flashblade.FixedLocationReference(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, resource_type: Optional[StrictStr] = None, display_name: Optional[StrictStr] = None, is_local: Optional[StrictBool] = None, location: Optional[FixedReference] = None)

field display_name: Optional[StrictStr] = None

Full name of the source with remote array information. Response will be same as source name for local file systems and policies.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field is_local: Optional[StrictBool] = None

Is the location reference to the local array or somewhere remote?

Constraints

• type = boolean

field location: Optional[FixedReference] = None

A reference to the location where the object is defined.

field name: Optional[StrictStr] = None

field resource_type: Optional[StrictStr] = None

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.

FixedReference

pydantic model pypureclient.flashblade.FixedReference(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, resource_type: Optional[StrictStr] = None)

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

field resource_type: Optional[StrictStr] = None

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.

FixedReferenceNameOnly

pydantic model pypureclient.flashblade.FixedReferenceNameOnly(*, name: Optional[StrictStr] = None)

field name: Optional[StrictStr] = None

FixedReferenceNoId

pydantic model pypureclient.flashblade.FixedReferenceNoId(*, name: Optional[StrictStr] = None, resource_type: Optional[StrictStr] = None)

field name: Optional[StrictStr] = None

field resource_type: Optional[StrictStr] = None

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.

FixedReferenceNoResourceType

pydantic model pypureclient.flashblade.FixedReferenceNoResourceType(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None)

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

FixedReferenceWithIsLocal

pydantic model pypureclient.flashblade.FixedReferenceWithIsLocal(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, resource_type: Optional[StrictStr] = None, is_local: Optional[StrictBool] = None)

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field is_local: Optional[StrictBool] = None

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.

Constraints

• type = boolean

field name: Optional[StrictStr] = None

field resource_type: Optional[StrictStr] = None

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.

FixedReferenceWithRemote

pydantic model pypureclient.flashblade.FixedReferenceWithRemote(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, resource_type: Optional[StrictStr] = None, remote: Optional[FixedReferenceNoResourceType] = None)

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

field remote: Optional[FixedReferenceNoResourceType] = None

The remote field of the corresponding array connection.

field resource_type: Optional[StrictStr] = None

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.

FixedReferenceWithType

pydantic model pypureclient.flashblade.FixedReferenceWithType(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, resource_type: Optional[StrictStr] = None)

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

field resource_type: Optional[StrictStr] = None

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.

Fleet

pydantic model pypureclient.flashblade.Fleet(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, is_local: Optional[StrictBool] = None)

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field is_local: Optional[StrictBool] = None

If set to true, the current array is a member of the fleet.

Constraints

• type = boolean

field name: Optional[StrictStr] = None

A name chosen by the user. Can be changed. Must be locally unique.

FleetGetResponse

pydantic model pypureclient.flashblade.FleetGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Fleet]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[Fleet]] = None

Returns a list of all items after filtering. If applicable, the values are displayed for each name.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

FleetKey

pydantic model pypureclient.flashblade.FleetKey(*, created: Optional[StrictInt] = None, expires: Optional[StrictInt] = None, fleet_key: Optional[StrictStr] = None)

field created: Optional[StrictInt] = None

Creation time in milliseconds since UNIX epoch.

field expires: Optional[StrictInt] = None

Expiration time in milliseconds since UNIX epoch.

field fleet_key: Optional[StrictStr] = None

Fleet key, used for fleet connections. After creation, listing will only show ****.

FleetKeyGetResponse

pydantic model pypureclient.flashblade.FleetKeyGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[FleetKey]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[FleetKey]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

FleetKeyResponse

pydantic model pypureclient.flashblade.FleetKeyResponse(*, items: Optional[ConstrainedListValue[FleetKey]] = None)

field items: Optional[ConstrainedListValue[FleetKey]] = None

FleetMember

pydantic model pypureclient.flashblade.FleetMember(*, fleet: Optional[FixedReferenceWithIsLocal] = None, member: Optional[FixedReferenceWithIsLocal] = None, status: Optional[StrictStr] = None, status_details: Optional[StrictStr] = None)

field fleet: Optional[FixedReferenceWithIsLocal] = None

field member: Optional[FixedReferenceWithIsLocal] = None

field status: Optional[StrictStr] = None

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.

field status_details: Optional[StrictStr] = None

Describes the error, if any.

FleetMemberGetResponse

pydantic model pypureclient.flashblade.FleetMemberGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[FleetMember]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[FleetMember]] = None

Returns a list of all items after filtering. If applicable, the values are displayed for each name.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

FleetMemberPost

pydantic model pypureclient.flashblade.FleetMemberPost(*, members: Optional[ConstrainedListValue[FleetMemberPostMembers]] = None)

field members: Optional[ConstrainedListValue[FleetMemberPostMembers]] = None

Info about the members being added to fleet.

FleetMemberPostMembers

pydantic model pypureclient.flashblade.FleetMemberPostMembers(*, key: Optional[StrictStr] = None, member: Optional[FleetMemberPostMembersMember] = None)

field key: Optional[StrictStr] = None

Provide the fleet key generated from any array in the fleet.

field member: Optional[FleetMemberPostMembersMember] = None

FleetMemberPostMembersMember

pydantic model pypureclient.flashblade.FleetMemberPostMembersMember(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, resource_type: Optional[StrictStr] = None)

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified.

field name: Optional[StrictStr] = None

The resource name.

field resource_type: Optional[StrictStr] = None

Type of the object (e.g. remote-arrays)

FleetMemberResponse

pydantic model pypureclient.flashblade.FleetMemberResponse(*, items: Optional[ConstrainedListValue[FleetMember]] = None)

field items: Optional[ConstrainedListValue[FleetMember]] = None

Returns a list of all items after filtering. If applicable, the values are displayed for each name.

FleetPatch

pydantic model pypureclient.flashblade.FleetPatch(*, name: Optional[StrictStr] = None)

field name: Optional[StrictStr] = None

The new name for the resource.

FleetResponse

pydantic model pypureclient.flashblade.FleetResponse(*, items: Optional[ConstrainedListValue[Fleet]] = None)

field items: Optional[ConstrainedListValue[Fleet]] = None

Returns a list of all items after filtering. If applicable, the values are displayed for each name.

Group

pydantic model pypureclient.flashblade.Group(*, id: Optional[StrictInt] = None, name: Optional[StrictStr] = None)

field id: Optional[StrictInt] = None

The numeric group id that represents the group’s identity in a POSIX system.

field name: Optional[StrictStr] = None

The group name that represents the group’s identity, and which resolves to the group’s id in a configured directory service.

GroupQuota

pydantic model pypureclient.flashblade.GroupQuota(*, name: Optional[StrictStr] = None, context: Optional[Reference] = None, file_system: Optional[FixedReference] = None, file_system_default_quota: Optional[StrictInt] = None, group: Optional[Group] = None, quota: Optional[StrictInt] = None, usage: Optional[StrictInt] = None)

field context: Optional[Reference] = None

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.

field file_system: Optional[FixedReference] = None

field file_system_default_quota: Optional[StrictInt] = None

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.

field group: Optional[Group] = None

The group on which this quota is enforced.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field quota: Optional[StrictInt] = None

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.

field usage: Optional[StrictInt] = None

The usage of the file system (in bytes) by the specified group.

GroupQuotaGetResponse

pydantic model pypureclient.flashblade.GroupQuotaGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[GroupQuota]] = None, errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[GroupQuota]] = None

A list of quota objects.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

GroupQuotaPatch

pydantic model pypureclient.flashblade.GroupQuotaPatch(*, name: Optional[StrictStr] = None, quota: StrictInt)

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field quota: StrictInt [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.

GroupQuotaPost

pydantic model pypureclient.flashblade.GroupQuotaPost(*, name: Optional[StrictStr] = None, quota: StrictInt)

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field quota: StrictInt [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.

GroupQuotaResponse

pydantic model pypureclient.flashblade.GroupQuotaResponse(*, items: Optional[ConstrainedListValue[GroupQuota]] = None)

field items: Optional[ConstrainedListValue[GroupQuota]] = None

A list of quota objects.

Hardware

pydantic model pypureclient.flashblade.Hardware(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, data_mac: Optional[StrictStr] = None, details: Optional[StrictStr] = None, identify_enabled: Optional[StrictBool] = None, index: Optional[StrictInt] = None, management_mac: Optional[StrictStr] = None, model: Optional[StrictStr] = None, part_number: Optional[StrictStr] = None, serial: Optional[StrictStr] = None, slot: Optional[StrictInt] = None, speed: Optional[StrictInt] = None, status: Optional[StrictStr] = None, temperature: Optional[StrictInt] = None, type: Optional[StrictStr] = None)

field data_mac: Optional[StrictStr] = None

Ethernet (data) MAC address

field details: Optional[StrictStr] = None

Details about the status of the component if not healthy.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field identify_enabled: Optional[StrictBool] = None

State of an LED used to visually identify the component.

Constraints

• type = boolean

field index: Optional[StrictInt] = None

Number that identifies the relative position of a hardware component within the array.

field management_mac: Optional[StrictStr] = None

Hardware component (burned-in) MAC address

field model: Optional[StrictStr] = None

Model number of the hardware component.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field part_number: Optional[StrictStr] = None

Part number of the hardware component.

field serial: Optional[StrictStr] = None

Serial number of the hardware component.

field slot: Optional[StrictInt] = None

Slot number occupied by the PCI Express card that hosts the component.

field speed: Optional[StrictInt] = None

The maximum speed (in b/s) at which the component is capable of operating.

field status: Optional[StrictStr] = None

Component status. Valid values are critical, healthy, identifying, unhealthy, unknown, and unused.

field temperature: Optional[StrictInt] = None

Temperature (in degrees celsius) reported by the component.

field type: Optional[StrictStr] = None

Type of hardware component. Valid values are bay, ch, eth, fan, fb, fm, pwr, and xfm.

HardwareConnector

pydantic model pypureclient.flashblade.HardwareConnector(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, connector_type: Optional[StrictStr] = None, lane_speed: Optional[StrictInt] = None, port_count: Optional[StrictInt] = None, port_speed: Optional[StrictInt] = None, transceiver_type: Optional[StrictStr] = None)

field connector_type: Optional[StrictStr] = None

Form-factor of the interface. Valid values include QSFP and RJ-45.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field lane_speed: Optional[StrictInt] = None

Configured speed of each lane in the connector in bits-per-second.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field port_count: Optional[StrictInt] = None

Configured number of ports in the connector (1/2/4 for QSFP).

field port_speed: Optional[StrictInt] = None

Configured speed of each port in the connector in bits-per-second.

field transceiver_type: Optional[StrictStr] = None

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.

HardwareConnectorGetResponse

pydantic model pypureclient.flashblade.HardwareConnectorGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[HardwareConnector]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[HardwareConnector]] = None

A list of connector objects.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

HardwareConnectorPerformance

pydantic model pypureclient.flashblade.HardwareConnectorPerformance(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, link_aggregation_group: Optional[FixedReference] = None, other_errors_per_sec: Optional[ConstrainedIntValue] = None, received_bytes_per_sec: Optional[ConstrainedIntValue] = None, received_crc_errors_per_sec: Optional[ConstrainedIntValue] = None, received_frame_errors_per_sec: Optional[ConstrainedIntValue] = None, received_packets_per_sec: Optional[ConstrainedIntValue] = None, time: Optional[StrictInt] = None, total_errors_per_sec: Optional[ConstrainedIntValue] = None, transmitted_bytes_per_sec: Optional[ConstrainedIntValue] = None, transmitted_carrier_errors_per_sec: Optional[ConstrainedIntValue] = None, transmitted_dropped_errors_per_sec: Optional[ConstrainedIntValue] = None, transmitted_packets_per_sec: Optional[ConstrainedIntValue] = None)

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field link_aggregation_group: Optional[FixedReference] = None

The link aggregation group which this entity belongs to.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field other_errors_per_sec: Optional[ConstrainedIntValue] = None

The sum of unspecified reception and transmission errors per second.

Constraints

• minimum = 0

field received_bytes_per_sec: Optional[ConstrainedIntValue] = None

Bytes received per second.

Constraints

• minimum = 0

field received_crc_errors_per_sec: Optional[ConstrainedIntValue] = None

Reception CRC errors per second.

Constraints

• minimum = 0

field received_frame_errors_per_sec: Optional[ConstrainedIntValue] = None

Received packet frame errors per second.

Constraints

• minimum = 0

field received_packets_per_sec: Optional[ConstrainedIntValue] = None

Packets received per second.

Constraints

• minimum = 0

field time: Optional[StrictInt] = None

Sample time in milliseconds since UNIX epoch.

field total_errors_per_sec: Optional[ConstrainedIntValue] = None

The sum of all reception and transmission errors per second.

Constraints

• minimum = 0

field transmitted_bytes_per_sec: Optional[ConstrainedIntValue] = None

Bytes transmitted per second.

Constraints

• minimum = 0

field transmitted_carrier_errors_per_sec: Optional[ConstrainedIntValue] = None

Transmission carrier errors per second.

Constraints

• minimum = 0

field transmitted_dropped_errors_per_sec: Optional[ConstrainedIntValue] = None

Transmitted packets dropped per second.

Constraints

• minimum = 0

field transmitted_packets_per_sec: Optional[ConstrainedIntValue] = None

Packets transmitted per second.

Constraints

• minimum = 0

HardwareConnectorPerformanceGetResponse

pydantic model pypureclient.flashblade.HardwareConnectorPerformanceGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[HardwareConnectorPerformance]] = None, total: Optional[ConstrainedListValue[HardwareConnectorPerformance]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[HardwareConnectorPerformance]] = None

A list of hardware connector performance objects.

field total: Optional[ConstrainedListValue[HardwareConnectorPerformance]] = None

Total of all records after filtering. If total_only query param is true, then no individual items will be returned.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

HardwareConnectorResponse

pydantic model pypureclient.flashblade.HardwareConnectorResponse(*, items: Optional[ConstrainedListValue[HardwareConnector]] = None)

field items: Optional[ConstrainedListValue[HardwareConnector]] = None

A list of connector objects.

HardwareGetResponse

pydantic model pypureclient.flashblade.HardwareGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Hardware]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[Hardware]] = None

A list of hardware component objects.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

HardwareResponse

pydantic model pypureclient.flashblade.HardwareResponse(*, items: Optional[ConstrainedListValue[Hardware]] = None)

field items: Optional[ConstrainedListValue[Hardware]] = None

A list of hardware component objects.

Http

pydantic model pypureclient.flashblade.Http(*, enabled: Optional[StrictBool] = None)

field enabled: Optional[StrictBool] = None

Is the protocol enabled? If not specified, defaults to false.

Constraints

• type = boolean

Index

pydantic model pypureclient.flashblade.Index(*, index: Optional[StrictInt] = None)

field index: Optional[StrictInt] = None

Index of the object in the containing array.

Keytab

pydantic model pypureclient.flashblade.Keytab(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, encryption_type: Optional[StrictStr] = None, fqdn: Optional[StrictStr] = None, kvno: Optional[StrictInt] = None, prefix: Optional[StrictStr] = None, principal: Optional[StrictStr] = None, realm: Optional[StrictStr] = None, server: Optional[FixedReference] = None, source: Optional[FixedReference] = None, suffix: Optional[StrictInt] = None)

field encryption_type: Optional[StrictStr] = None

The encryption type used by the Kerberos key distribution center to generate the keytab.

field fqdn: Optional[StrictStr] = None

The fully qualified domain name to which the keytab was issued.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field kvno: Optional[StrictInt] = None

The key version number of the key used to generate the keytab.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field prefix: Optional[StrictStr] = None

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.

field principal: Optional[StrictStr] = None

The service name for which the keytab was issued.

field realm: Optional[StrictStr] = None

The Kerberos realm that issued the keytab.

field server: Optional[FixedReference] = None

The server where the keytab is used.

field source: Optional[FixedReference] = None

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.

field suffix: Optional[StrictInt] = None

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.

KeytabGetResponse

pydantic model pypureclient.flashblade.KeytabGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Keytab]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[Keytab]] = None

A list of Kerberos keytab objects.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

KeytabPost

pydantic model pypureclient.flashblade.KeytabPost(*, source: Optional[Reference] = None)

field source: Optional[Reference] = None

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.

KeytabResponse

pydantic model pypureclient.flashblade.KeytabResponse(*, items: Optional[ConstrainedListValue[Keytab]] = None)

field items: Optional[ConstrainedListValue[Keytab]] = None

A list of Kerberos keytab objects.

KmipServer

pydantic model pypureclient.flashblade.KmipServer(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, ca_certificate: Optional[Reference] = None, ca_certificate_group: Optional[Reference] = None, uris: Optional[ConstrainedListValue[ConstrainedStrValue]] = None)

field ca_certificate: Optional[Reference] = None

CA certificate used to validate the authenticity of the configured servers.

field ca_certificate_group: Optional[Reference] = None

A certificate group containing CA certificates that can be used to validate the authenticity of the configured servers.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field uris: Optional[ConstrainedListValue[ConstrainedStrValue]] = None

List of URIs for the configured KMIP servers in the format [protocol://]hostname:port.

Constraints

• minItems = 1

• maxItems = 30

KmipServerResponse

pydantic model pypureclient.flashblade.KmipServerResponse(*, items: Optional[ConstrainedListValue[KmipServer]] = None)

field items: Optional[ConstrainedListValue[KmipServer]] = None

LegalHold

pydantic model pypureclient.flashblade.LegalHold(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, description: Optional[StrictStr] = None)

field description: Optional[StrictStr] = None

The description of the legal hold instance.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

LegalHoldHeldEntity

pydantic model pypureclient.flashblade.LegalHoldHeldEntity(*, file_system: Optional[FixedReference] = None, legal_hold: Optional[FixedReference] = None, path: Optional[StrictStr] = None, status: Optional[StrictStr] = None)

field file_system: Optional[FixedReference] = None

Reference to the file system that the legal hold is applied to.

field legal_hold: Optional[FixedReference] = None

Reference to the legal hold.

field path: Optional[StrictStr] = None

The path of the file or directory being held.

field status: Optional[StrictStr] = None

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.

LegalHoldsGetResponse

pydantic model pypureclient.flashblade.LegalHoldsGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[LegalHold]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[LegalHold]] = None

A list of legal hold instances.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

LegalHoldsHeldEntitiesGetResponse

pydantic model pypureclient.flashblade.LegalHoldsHeldEntitiesGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[LegalHoldHeldEntity]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[LegalHoldHeldEntity]] = None

A list of held entities for legal holds.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

LegalHoldsHeldEntitiesResponse

pydantic model pypureclient.flashblade.LegalHoldsHeldEntitiesResponse(*, items: Optional[ConstrainedListValue[LegalHoldHeldEntity]] = None)

field items: Optional[ConstrainedListValue[LegalHoldHeldEntity]] = None

A list of held entities for legal holds.

LegalHoldsResponse

pydantic model pypureclient.flashblade.LegalHoldsResponse(*, items: Optional[ConstrainedListValue[LegalHold]] = None)

field items: Optional[ConstrainedListValue[LegalHold]] = None

A list of legal hold instances.

LifecycleRule

pydantic model pypureclient.flashblade.LifecycleRule(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, context: Optional[Reference] = None, abort_incomplete_multipart_uploads_after: Optional[StrictInt] = None, keep_current_version_for: Optional[StrictInt] = None, keep_current_version_until: Optional[StrictInt] = None, bucket: Optional[FixedReference] = None, cleanup_expired_object_delete_marker: Optional[StrictBool] = None, enabled: Optional[StrictBool] = None, keep_previous_version_for: Optional[StrictInt] = None, prefix: Optional[StrictStr] = None, rule_id: Optional[StrictStr] = None)

field abort_incomplete_multipart_uploads_after: Optional[StrictInt] = None

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.

field bucket: Optional[FixedReference] = None

The bucket which this lifecycle rule is targeting.

field cleanup_expired_object_delete_marker: Optional[StrictBool] = None

Returns a value of true if the expired object delete markers will be removed.

Constraints

• type = boolean

field context: Optional[Reference] = None

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.

field enabled: Optional[StrictBool] = None

If set to true, this rule will be enabled.

Constraints

• type = boolean

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field keep_current_version_for: Optional[StrictInt] = None

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.

field keep_current_version_until: Optional[StrictInt] = None

Time after which current versions will be marked expired. Measured in milliseconds, time since epoch. Must be a valid date, accurate to day.

field keep_previous_version_for: Optional[StrictInt] = None

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.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field prefix: Optional[StrictStr] = None

Object key prefix identifying one or more objects in the bucket. Can have a maximum length of 1024 characters.

field rule_id: Optional[StrictStr] = None

Unique identifier for the rule. Can have a maximum length of 255 characters.

LifecycleRuleConfigExtension

pydantic model pypureclient.flashblade.LifecycleRuleConfigExtension(*, abort_incomplete_multipart_uploads_after: Optional[StrictInt] = None, keep_current_version_for: Optional[StrictInt] = None, keep_current_version_until: Optional[StrictInt] = None)

field abort_incomplete_multipart_uploads_after: Optional[StrictInt] = None

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.

field keep_current_version_for: Optional[StrictInt] = None

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.

field keep_current_version_until: Optional[StrictInt] = None

Time after which current versions will be marked expired. Measured in milliseconds, time since epoch. Must be a valid date, accurate to day.

LifecycleRuleGetResponse

pydantic model pypureclient.flashblade.LifecycleRuleGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None, items: Optional[ConstrainedListValue[LifecycleRule]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[LifecycleRule]] = None

A list of lifecycle rule objects.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

LifecycleRulePatch

pydantic model pypureclient.flashblade.LifecycleRulePatch(*, abort_incomplete_multipart_uploads_after: Optional[StrictInt] = None, keep_current_version_for: Optional[StrictInt] = None, keep_current_version_until: Optional[StrictInt] = None, enabled: Optional[StrictBool] = None, keep_previous_version_for: Optional[StrictInt] = None, prefix: Optional[StrictStr] = None)

field abort_incomplete_multipart_uploads_after: Optional[StrictInt] = None

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.

field enabled: Optional[StrictBool] = None

If set to true, this rule will be enabled.

Constraints

• type = boolean

field keep_current_version_for: Optional[StrictInt] = None

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.

field keep_current_version_until: Optional[StrictInt] = None

Time after which current versions will be marked expired. Measured in milliseconds, time since epoch. Must be a valid date, accurate to day.

field keep_previous_version_for: Optional[StrictInt] = None

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.

field prefix: Optional[StrictStr] = None

Object key prefix identifying one or more objects in the bucket. Can have a maximum length of 1024 characters.

LifecycleRulePost

pydantic model pypureclient.flashblade.LifecycleRulePost(*, abort_incomplete_multipart_uploads_after: Optional[StrictInt] = None, keep_current_version_for: Optional[StrictInt] = None, keep_current_version_until: Optional[StrictInt] = None, bucket: Optional[ReferenceWritable] = None, keep_previous_version_for: Optional[StrictInt] = None, prefix: Optional[StrictStr] = None, rule_id: Optional[StrictStr] = None)

field abort_incomplete_multipart_uploads_after: Optional[StrictInt] = None

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.

field bucket: Optional[ReferenceWritable] = None

The bucket name for lifecycle rule creation.

field keep_current_version_for: Optional[StrictInt] = None

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.

field keep_current_version_until: Optional[StrictInt] = None

Time after which current versions will be marked expired. Measured in milliseconds, time since epoch. Must be a valid date, accurate to day.

field keep_previous_version_for: Optional[StrictInt] = None

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.

field prefix: Optional[StrictStr] = None

Object key prefix identifying one or more objects in the bucket. Can have a maximum length of 1024 characters.

field rule_id: Optional[StrictStr] = None

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.

LifecycleRuleResponse

pydantic model pypureclient.flashblade.LifecycleRuleResponse(*, items: Optional[ConstrainedListValue[LifecycleRule]] = None)

field items: Optional[ConstrainedListValue[LifecycleRule]] = None

A list of lifecycle rule objects.

LinkAggregationGroup

pydantic model pypureclient.flashblade.LinkAggregationGroup(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, lag_speed: Optional[StrictInt] = None, mac_address: Optional[ConstrainedStrValue] = None, port_speed: Optional[StrictInt] = None, ports: Optional[ConstrainedListValue[FixedReference]] = None, status: Optional[StrictStr] = None)

Validators

• mac_address_validate_regular_expression » mac_address

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field lag_speed: Optional[StrictInt] = None

Combined speed of all ports in the LAG in bits-per-second.

field mac_address: Optional[ConstrainedStrValue] = None

Unique MAC address assigned to the LAG.

Validated by

• mac_address_validate_regular_expression

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field port_speed: Optional[StrictInt] = None

Configured speed of each port in the LAG in bits-per-second.

field ports: Optional[ConstrainedListValue[FixedReference]] = None

Ports associated with the LAG.

field status: Optional[StrictStr] = None

Health status of the LAG. Valid values are critical, healthy, identifying, unclaimed, unhealthy, unrecognized, and unused.

validator mac_address_validate_regular_expression  »  mac_address

Validates the regular expression

LinkAggregationGroupGetResponse

pydantic model pypureclient.flashblade.LinkAggregationGroupGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[LinkAggregationGroup]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[LinkAggregationGroup]] = None

A list of lag objects.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

LinkAggregationGroupResponse

pydantic model pypureclient.flashblade.LinkAggregationGroupResponse(*, items: Optional[ConstrainedListValue[LinkAggregationGroup]] = None)

field items: Optional[ConstrainedListValue[LinkAggregationGroup]] = None

A list of lag objects.

LocationReference

pydantic model pypureclient.flashblade.LocationReference(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, resource_type: Optional[StrictStr] = None, display_name: Optional[StrictStr] = None, is_local: Optional[StrictBool] = None, location: Optional[Reference] = None)

Reference to a policy that is driving replication.

field display_name: Optional[StrictStr] = None

Full name of the source with remote array information. Response will be same as source name for local file systems and policies.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field is_local: Optional[StrictBool] = None

Is the location reference to the local array or somewhere remote?

Constraints

• type = boolean

field location: Optional[Reference] = None

A reference to the location where the object is defined.

field name: Optional[StrictStr] = None

A name chosen by the user. Can be changed. Must be locally unique.

field resource_type: Optional[StrictStr] = None

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.

Login

pydantic model pypureclient.flashblade.Login(*, username: Optional[StrictStr] = None)

field username: Optional[StrictStr] = None

The username of the user.

LoginBannerGetResponse

pydantic model pypureclient.flashblade.LoginBannerGetResponse(*, login_banner: Optional[StrictStr] = None)

field login_banner: Optional[StrictStr] = None

The string to show as login banner.

LogsAsync

pydantic model pypureclient.flashblade.LogsAsync(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, available_files: Optional[ConstrainedListValue[FileInfo]] = None, end_time: Optional[ConstrainedIntValue] = None, hardware_components: Optional[ConstrainedListValue[FixedReference]] = None, last_request_time: Optional[ConstrainedIntValue] = None, processing: Optional[StrictBool] = None, progress: Optional[Union[StrictFloat, StrictInt]] = None, start_time: Optional[ConstrainedIntValue] = None)

field available_files: Optional[ConstrainedListValue[FileInfo]] = None

All of the available files ready for download.

field end_time: Optional[ConstrainedIntValue] = None

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.

Constraints

• minimum = 0

field hardware_components: Optional[ConstrainedListValue[FixedReference]] = None

All of the hardware components for which logs are being processed.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field last_request_time: Optional[ConstrainedIntValue] = None

The last time log preparation was requested (in milliseconds since epoch).

Constraints

• minimum = 0

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field processing: Optional[StrictBool] = None

Returns a value of true if the logs are being prepared.

Constraints

• type = boolean

field progress: Optional[Union[StrictFloat, StrictInt]] = None

A representation of log preparation progress. Ranges from 0 to 1.0.

field start_time: Optional[ConstrainedIntValue] = None

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.

Constraints

• minimum = 0

LogsAsyncGetResponse

pydantic model pypureclient.flashblade.LogsAsyncGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[LogsAsync]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[LogsAsync]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

LogsAsyncResponse

pydantic model pypureclient.flashblade.LogsAsyncResponse(*, items: Optional[ConstrainedListValue[LogsAsync]] = None)

field items: Optional[ConstrainedListValue[LogsAsync]] = None

MaintenanceWindow

pydantic model pypureclient.flashblade.MaintenanceWindow(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, created: Optional[StrictInt] = None, expires: Optional[StrictInt] = None)

field created: Optional[StrictInt] = None

The maintenance window start time, measured in milliseconds since the UNIX epoch.

field expires: Optional[StrictInt] = None

The maintenance window end time, measured in milliseconds since the UNIX epoch.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

MaintenanceWindowPost

pydantic model pypureclient.flashblade.MaintenanceWindowPost(*, timeout: Optional[StrictInt] = None)

field timeout: Optional[StrictInt] = None

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.

MaintenanceWindowsGetResponse

pydantic model pypureclient.flashblade.MaintenanceWindowsGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[MaintenanceWindow]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[MaintenanceWindow]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

MaintenanceWindowsResponse

pydantic model pypureclient.flashblade.MaintenanceWindowsResponse(*, items: Optional[ConstrainedListValue[MaintenanceWindow]] = None)

field items: Optional[ConstrainedListValue[MaintenanceWindow]] = None

Member

pydantic model pypureclient.flashblade.Member(*, group: Optional[Reference] = None, member: Optional[Reference] = None)

field group: Optional[Reference] = None

A reference to a group object that has the referenced member object as a member.

field member: Optional[Reference] = None

A reference to an object that is a member of the referenced group.

MemberLink

pydantic model pypureclient.flashblade.MemberLink(*, local_file_system: Optional[FixedReference] = None, remote: Optional[FixedReferenceNoResourceType] = None, remote_file_system: Optional[FixedReferenceNoResourceType] = None)

field local_file_system: Optional[FixedReference] = None

Reference to a local file system.

field remote: Optional[FixedReferenceNoResourceType] = None

Reference to a remote array.

field remote_file_system: Optional[FixedReferenceNoResourceType] = None

Reference to a remote file system.

MultiProtocol

pydantic model pypureclient.flashblade.MultiProtocol(*, access_control_style: Optional[StrictStr] = None, safeguard_acls: Optional[StrictBool] = None)

field access_control_style: Optional[StrictStr] = None

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.

field safeguard_acls: Optional[StrictBool] = None

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.

Constraints

• type = boolean

MultiProtocolPost

pydantic model pypureclient.flashblade.MultiProtocolPost(*, access_control_style: Optional[StrictStr] = None, safeguard_acls: Optional[StrictBool] = None)

field access_control_style: Optional[StrictStr] = None

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.

field safeguard_acls: Optional[StrictBool] = None

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.

Constraints

• type = boolean

NetworkAccessPolicy

pydantic model pypureclient.flashblade.NetworkAccessPolicy(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, enabled: Optional[StrictBool] = None, is_local: Optional[StrictBool] = None, location: Optional[FixedReference] = None, policy_type: Optional[StrictStr] = None, version: Optional[StrictStr] = None, rules: Optional[ConstrainedListValue[NetworkAccessPolicyRuleInPolicy]] = None)

field enabled: Optional[StrictBool] = None

If true, the policy is enabled. If not specified, defaults to true.

Constraints

• type = boolean

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field is_local: Optional[StrictBool] = None

Whether the policy is defined on the local array.

Constraints

• type = boolean

field location: Optional[FixedReference] = None

Reference to the array where the policy is defined.

field name: Optional[StrictStr] = None

A name chosen by the user. Can be changed. Must be locally unique.

field policy_type: Optional[StrictStr] = None

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.

field rules: Optional[ConstrainedListValue[NetworkAccessPolicyRuleInPolicy]] = None

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.

Constraints

• maxItems = 200

field version: Optional[StrictStr] = None

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.

NetworkAccessPolicyGetResponse

pydantic model pypureclient.flashblade.NetworkAccessPolicyGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[NetworkAccessPolicy]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[NetworkAccessPolicy]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

NetworkAccessPolicyResponse

pydantic model pypureclient.flashblade.NetworkAccessPolicyResponse(*, items: Optional[ConstrainedListValue[NetworkAccessPolicy]] = None)

field items: Optional[ConstrainedListValue[NetworkAccessPolicy]] = None

NetworkAccessPolicyRule

pydantic model pypureclient.flashblade.NetworkAccessPolicyRule(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, client: Optional[StrictStr] = None, effect: Optional[StrictStr] = None, interfaces: Optional[ConstrainedListValue[StrictStr]] = None, policy: Optional[FixedReference] = None, policy_version: Optional[StrictStr] = None, index: Optional[StrictInt] = None)

field client: Optional[StrictStr] = None

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.

field effect: Optional[StrictStr] = None

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.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field index: Optional[StrictInt] = None

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.

field interfaces: Optional[ConstrainedListValue[StrictStr]] = None

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.

Constraints

• maxItems = 5

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field policy: Optional[FixedReference] = None

The policy to which this rule belongs.

field policy_version: Optional[StrictStr] = None

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.

NetworkAccessPolicyRuleBase

pydantic model pypureclient.flashblade.NetworkAccessPolicyRuleBase(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, client: Optional[StrictStr] = None, effect: Optional[StrictStr] = None, interfaces: Optional[ConstrainedListValue[StrictStr]] = None, policy: Optional[FixedReference] = None, policy_version: Optional[StrictStr] = None)

field client: Optional[StrictStr] = None

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.

field effect: Optional[StrictStr] = None

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.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field interfaces: Optional[ConstrainedListValue[StrictStr]] = None

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.

Constraints

• maxItems = 5

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field policy: Optional[FixedReference] = None

The policy to which this rule belongs.

field policy_version: Optional[StrictStr] = None

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.

NetworkAccessPolicyRuleGetResponse

pydantic model pypureclient.flashblade.NetworkAccessPolicyRuleGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[NetworkAccessPolicyRule]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[NetworkAccessPolicyRule]] = None

Displays a list of all items after filtering.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

NetworkAccessPolicyRuleInPolicy

pydantic model pypureclient.flashblade.NetworkAccessPolicyRuleInPolicy(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, client: Optional[StrictStr] = None, effect: Optional[StrictStr] = None, interfaces: Optional[ConstrainedListValue[StrictStr]] = None, policy: Optional[FixedReference] = None, policy_version: Optional[StrictStr] = None, index: Optional[StrictInt] = None)

field client: Optional[StrictStr] = None

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.

field effect: Optional[StrictStr] = None

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.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field index: Optional[StrictInt] = None

The index within the policy. The index indicates the order the rules are evaluated.

field interfaces: Optional[ConstrainedListValue[StrictStr]] = None

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.

Constraints

• maxItems = 5

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field policy: Optional[FixedReference] = None

The policy to which this rule belongs.

field policy_version: Optional[StrictStr] = None

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.

NetworkAccessPolicyRulePost

pydantic model pypureclient.flashblade.NetworkAccessPolicyRulePost(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, client: Optional[StrictStr] = None, effect: Optional[StrictStr] = None, interfaces: Optional[ConstrainedListValue[StrictStr]] = None, index: Optional[StrictInt] = None)

field client: Optional[StrictStr] = None

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.

field effect: Optional[StrictStr] = None

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.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field index: Optional[StrictInt] = None

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.

field interfaces: Optional[ConstrainedListValue[StrictStr]] = None

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.

Constraints

• maxItems = 5

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

NetworkAccessPolicyRulePostBase

pydantic model pypureclient.flashblade.NetworkAccessPolicyRulePostBase(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, client: Optional[StrictStr] = None, effect: Optional[StrictStr] = None, interfaces: Optional[ConstrainedListValue[StrictStr]] = None)

field client: Optional[StrictStr] = None

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.

field effect: Optional[StrictStr] = None

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.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field interfaces: Optional[ConstrainedListValue[StrictStr]] = None

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.

Constraints

• maxItems = 5

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

NetworkAccessPolicyRuleResponse

pydantic model pypureclient.flashblade.NetworkAccessPolicyRuleResponse(*, items: Optional[ConstrainedListValue[NetworkAccessPolicyRule]] = None)

field items: Optional[ConstrainedListValue[NetworkAccessPolicyRule]] = None

Displays a list of all items after filtering.

NetworkInterface

pydantic model pypureclient.flashblade.NetworkInterface(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, address: Optional[StrictStr] = None, enabled: Optional[StrictBool] = None, gateway: Optional[StrictStr] = None, mtu: Optional[StrictInt] = None, netmask: Optional[StrictStr] = None, server: Optional[Reference] = None, services: Optional[ConstrainedListValue[StrictStr]] = None, subnet: Optional[Dict[str, Any]] = None, type: Optional[StrictStr] = None, vlan: Optional[StrictInt] = None)

field address: Optional[StrictStr] = None

The IPv4 or IPv6 address to be associated with the specified network interface.

field enabled: Optional[StrictBool] = None

Indicates if the specified network interface is enabled (true) or disabled (false). If not specified, defaults to true.

Constraints

• type = boolean

field gateway: Optional[StrictStr] = None

Derived from subnet.gateway.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field mtu: Optional[StrictInt] = None

Derived from subnet.mtu.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field netmask: Optional[StrictStr] = None

Derived from subnet.prefix.

field server: Optional[Reference] = None

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.

field services: Optional[ConstrainedListValue[StrictStr]] = None

Services and protocols that are enabled on the interface.

field subnet: Optional[Dict[str, Any]] = None

field type: Optional[StrictStr] = None

The only valid value is vip.

field vlan: Optional[StrictInt] = None

Derived from subnet.vlan.

NetworkInterfaceGetResponse

pydantic model pypureclient.flashblade.NetworkInterfaceGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[NetworkInterface]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[NetworkInterface]] = None

A list of network interface objects.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

NetworkInterfacePatch

pydantic model pypureclient.flashblade.NetworkInterfacePatch(*, address: Optional[StrictStr] = None, server: Optional[Reference] = None, services: Optional[ConstrainedListValue[StrictStr]] = None)

field address: Optional[StrictStr] = None

The IPv4 or IPv6 address to be associated with the specified network interface.

field server: Optional[Reference] = None

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.

field services: Optional[ConstrainedListValue[StrictStr]] = None

Services and protocols that are enabled on the interface.

NetworkInterfacePing

pydantic model pypureclient.flashblade.NetworkInterfacePing(*, component_name: Optional[StrictStr] = None, destination: Optional[StrictStr] = None, details: Optional[StrictStr] = None, source: Optional[StrictStr] = None)

Output from running the linux command ‘ping’ directly on the array with start and end location information.

field component_name: Optional[StrictStr] = None

Name of the component running the check.

field destination: Optional[StrictStr] = None

The destination address or hostname provided in the request that the operation is run against.

field details: Optional[StrictStr] = None

Giant text block that contains raw output of the operation and a client needs to parse.

field source: Optional[StrictStr] = None

The address where the check starts. Can be a subnet or IP inside the subnet.

NetworkInterfacePingGetResponse

pydantic model pypureclient.flashblade.NetworkInterfacePingGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[NetworkInterfacePing]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[NetworkInterfacePing]] = None

A list of network ping run result.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

NetworkInterfacePingResponse

pydantic model pypureclient.flashblade.NetworkInterfacePingResponse(*, items: Optional[ConstrainedListValue[NetworkInterfacePing]] = None)

field items: Optional[ConstrainedListValue[NetworkInterfacePing]] = None

A list of network ping run result.

NetworkInterfaceResponse

pydantic model pypureclient.flashblade.NetworkInterfaceResponse(*, items: Optional[ConstrainedListValue[NetworkInterface]] = None)

field items: Optional[ConstrainedListValue[NetworkInterface]] = None

A list of network interface objects.

NetworkInterfaceTrace

pydantic model pypureclient.flashblade.NetworkInterfaceTrace(*, component_name: Optional[StrictStr] = None, destination: Optional[StrictStr] = None, details: Optional[StrictStr] = None, source: Optional[StrictStr] = None)

Output from running the linux command ‘traceroute’ directly on the array with start and end location information.

field component_name: Optional[StrictStr] = None

Name of the component running the check.

field destination: Optional[StrictStr] = None

The destination address or hostname provided in the request that the operation is run against.

field details: Optional[StrictStr] = None

Giant text block that contains raw output of the operation and a client needs to parse.

field source: Optional[StrictStr] = None

The address where the check starts. Can be a subnet or IP inside the subnet.

NetworkInterfaceTraceGetResponse

pydantic model pypureclient.flashblade.NetworkInterfaceTraceGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[NetworkInterfaceTrace]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[NetworkInterfaceTrace]] = None

A list of network trace run result.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

NetworkInterfaceTraceResponse

pydantic model pypureclient.flashblade.NetworkInterfaceTraceResponse(*, items: Optional[ConstrainedListValue[NetworkInterfaceTrace]] = None)

field items: Optional[ConstrainedListValue[NetworkInterfaceTrace]] = None

A list of network trace run result.

NetworkInterfacesConnectorsGetResponse

pydantic model pypureclient.flashblade.NetworkInterfacesConnectorsGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[HardwareConnector]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[HardwareConnector]] = None

A list of network connector objects.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

NetworkInterfacesConnectorsPerformance

pydantic model pypureclient.flashblade.NetworkInterfacesConnectorsPerformance(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, link_aggregation_group: Optional[FixedReference] = None, other_errors_per_sec: Optional[ConstrainedIntValue] = None, received_bytes_per_sec: Optional[ConstrainedIntValue] = None, received_crc_errors_per_sec: Optional[ConstrainedIntValue] = None, received_frame_errors_per_sec: Optional[ConstrainedIntValue] = None, received_packets_per_sec: Optional[ConstrainedIntValue] = None, time: Optional[StrictInt] = None, total_errors_per_sec: Optional[ConstrainedIntValue] = None, transmitted_bytes_per_sec: Optional[ConstrainedIntValue] = None, transmitted_carrier_errors_per_sec: Optional[ConstrainedIntValue] = None, transmitted_dropped_errors_per_sec: Optional[ConstrainedIntValue] = None, transmitted_packets_per_sec: Optional[ConstrainedIntValue] = None, flow_control_received_congestion_packets_per_sec: Optional[ConstrainedIntValue] = None, flow_control_received_discarded_packets_per_sec: Optional[ConstrainedIntValue] = None, flow_control_received_lossless_bytes_per_sec: Optional[ConstrainedIntValue] = None, flow_control_received_pause_frames_per_sec: Optional[ConstrainedIntValue] = None, flow_control_transmitted_congestion_packets_per_sec: Optional[ConstrainedIntValue] = None, flow_control_transmitted_discarded_packets_per_sec: Optional[ConstrainedIntValue] = None, flow_control_transmitted_lossless_bytes_per_sec: Optional[ConstrainedIntValue] = None, flow_control_transmitted_pause_frames_per_sec: Optional[ConstrainedIntValue] = None, rdma_received_req_cqe_errors_per_sec: Optional[ConstrainedIntValue] = None, rdma_received_sequence_errors_per_sec: Optional[ConstrainedIntValue] = None, rdma_transmitted_local_ack_timeout_errors_per_sec: Optional[ConstrainedIntValue] = None)

field flow_control_received_congestion_packets_per_sec: Optional[ConstrainedIntValue] = None

Number of congestion control packets received per second.

Constraints

• minimum = 0

field flow_control_received_discarded_packets_per_sec: Optional[ConstrainedIntValue] = None

Number of received packets that were physically discarded per second due to errors or other reasons.

Constraints

• minimum = 0

field flow_control_received_lossless_bytes_per_sec: Optional[ConstrainedIntValue] = None

Bytes received per second with lossless flow control settings.

Constraints

• minimum = 0

field flow_control_received_pause_frames_per_sec: Optional[ConstrainedIntValue] = None

Received pause frames per second.

Constraints

• minimum = 0

field flow_control_transmitted_congestion_packets_per_sec: Optional[ConstrainedIntValue] = None

Number of congestion control packets transmitted per second.

Constraints

• minimum = 0

field flow_control_transmitted_discarded_packets_per_sec: Optional[ConstrainedIntValue] = None

Number of transmitted packets that were physically discarded by the NIC per second due to errors or other reasons.

Constraints

• minimum = 0

field flow_control_transmitted_lossless_bytes_per_sec: Optional[ConstrainedIntValue] = None

Bytes transmitted per second with lossless flow control settings.

Constraints

• minimum = 0

field flow_control_transmitted_pause_frames_per_sec: Optional[ConstrainedIntValue] = None

Transmitted pause frames per second.

Constraints

• minimum = 0

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field link_aggregation_group: Optional[FixedReference] = None

The link aggregation group which this entity belongs to.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field other_errors_per_sec: Optional[ConstrainedIntValue] = None

The sum of unspecified reception and transmission errors per second.

Constraints

• minimum = 0

field rdma_received_req_cqe_errors_per_sec: Optional[ConstrainedIntValue] = None

The number of times port detected RDMA CQEs with error per second.

Constraints

• minimum = 0

field rdma_received_sequence_errors_per_sec: Optional[ConstrainedIntValue] = None

The number of received RDMA packet sequence errors per second.

Constraints

• minimum = 0

field rdma_transmitted_local_ack_timeout_errors_per_sec: Optional[ConstrainedIntValue] = None

The number of times RDMA ack timer expired for QPs per second.

Constraints

• minimum = 0

field received_bytes_per_sec: Optional[ConstrainedIntValue] = None

Bytes received per second.

Constraints

• minimum = 0

field received_crc_errors_per_sec: Optional[ConstrainedIntValue] = None

Reception CRC errors per second.

Constraints

• minimum = 0

field received_frame_errors_per_sec: Optional[ConstrainedIntValue] = None

Received packet frame errors per second.

Constraints

• minimum = 0

field received_packets_per_sec: Optional[ConstrainedIntValue] = None

Packets received per second.

Constraints

• minimum = 0

field time: Optional[StrictInt] = None

Sample time in milliseconds since UNIX epoch.

field total_errors_per_sec: Optional[ConstrainedIntValue] = None

The sum of all reception and transmission errors per second.

Constraints

• minimum = 0

field transmitted_bytes_per_sec: Optional[ConstrainedIntValue] = None

Bytes transmitted per second.

Constraints

• minimum = 0

field transmitted_carrier_errors_per_sec: Optional[ConstrainedIntValue] = None

Transmission carrier errors per second.

Constraints

• minimum = 0

field transmitted_dropped_errors_per_sec: Optional[ConstrainedIntValue] = None

Transmitted packets dropped per second.

Constraints

• minimum = 0

field transmitted_packets_per_sec: Optional[ConstrainedIntValue] = None

Packets transmitted per second.

Constraints

• minimum = 0

NetworkInterfacesConnectorsPerformanceGetResponse

pydantic model pypureclient.flashblade.NetworkInterfacesConnectorsPerformanceGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[NetworkInterfacesConnectorsPerformance]] = None, total: Optional[ConstrainedListValue[NetworkInterfacesConnectorsPerformance]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[NetworkInterfacesConnectorsPerformance]] = None

A list of network connector performance objects.

field total: Optional[ConstrainedListValue[NetworkInterfacesConnectorsPerformance]] = None

Total of all records after filtering. If total_only query param is true, then no individual items will be returned.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

NetworkInterfacesConnectorsResponse

pydantic model pypureclient.flashblade.NetworkInterfacesConnectorsResponse(*, items: Optional[ConstrainedListValue[HardwareConnector]] = None)

field items: Optional[ConstrainedListValue[HardwareConnector]] = None

A list of network connector objects.

NetworkInterfacesConnectorsSetting

pydantic model pypureclient.flashblade.NetworkInterfacesConnectorsSetting(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, roce: Optional[NetworkInterfacesConnectorsSettingRoce] = None)

The global network setting for all network connectors.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field roce: Optional[NetworkInterfacesConnectorsSettingRoce] = None

RoCE(RDMA over Converged Ethernet) configuration for network connectors.

NetworkInterfacesConnectorsSettingRoce

pydantic model pypureclient.flashblade.NetworkInterfacesConnectorsSettingRoce(*, default_ecn: Optional[NetworkInterfacesConnectorsSettingRoceEcn] = None, default_pfc: Optional[NetworkInterfacesConnectorsSettingRocePfc] = None, enabled: Optional[StrictBool] = None, network_congestion_mode: Optional[StrictStr] = None, trust_mode: Optional[StrictStr] = None)

RoCE(RDMA over Converged Ethernet) configuration for network connectors.

field default_ecn: Optional[NetworkInterfacesConnectorsSettingRoceEcn] = None

The default ECN(Explicit Congestion Notification) setting for network connectors.

field default_pfc: Optional[NetworkInterfacesConnectorsSettingRocePfc] = None

The default PFC(Priority Flow Control) setting for network connectors.

field enabled: Optional[StrictBool] = None

If true, then RoCE networking is enabled. Otherwise, it is disabled.

Constraints

• type = boolean

field network_congestion_mode: Optional[StrictStr] = None

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.

field trust_mode: Optional[StrictStr] = None

The trust mode of the RoCE network. Valid values include pcp and dscp.

NetworkInterfacesConnectorsSettingRoceEcn

pydantic model pypureclient.flashblade.NetworkInterfacesConnectorsSettingRoceEcn(*, marking_probability: Optional[Union[StrictFloat, StrictInt]] = None, max_ecn_marked_threshold: Optional[StrictInt] = None, min_ecn_marked_threshold: Optional[StrictInt] = None)

Default ECN(Explicit Network Notification) configuration for network connectors.

field marking_probability: Optional[Union[StrictFloat, StrictInt]] = None

The ECN marking probability when min ECN marked threshold is reached.

field max_ecn_marked_threshold: Optional[StrictInt] = None

The maximum threshold value in bytes at which the packets start being marked with ECN at the highest probability or dropped.

field min_ecn_marked_threshold: Optional[StrictInt] = None

The minimum threshold value in bytes at which the packets start being marked with ECN.

NetworkInterfacesConnectorsSettingRocePfc

pydantic model pypureclient.flashblade.NetworkInterfacesConnectorsSettingRocePfc(*, port_buffer: Optional[StrictInt] = None, xoff_threshold: Optional[StrictInt] = None, xon_threshold: Optional[StrictInt] = None)

Default PFC(Priority Flow Control) configuration for network connectors.

field port_buffer: Optional[StrictInt] = None

The buffer size in bytes reserved to absorb in-flight packets after XOFF threshold is reached.

field xoff_threshold: Optional[StrictInt] = None

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.

field xon_threshold: Optional[StrictInt] = None

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.

NetworkInterfacesConnectorsSettingsGetResponse

pydantic model pypureclient.flashblade.NetworkInterfacesConnectorsSettingsGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[NetworkInterfacesConnectorsSetting]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[NetworkInterfacesConnectorsSetting]] = None

A list of global network settings for network connectors.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

Nfs

pydantic model pypureclient.flashblade.Nfs(*, export_policy: Optional[ReferenceWritable] = None, rules: Optional[StrictStr] = None, v3_enabled: Optional[StrictBool] = None, v4_1_enabled: Optional[StrictBool] = None)

field export_policy: Optional[ReferenceWritable] = None

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.

field rules: Optional[StrictStr] = None

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).

field v3_enabled: Optional[StrictBool] = None

If set to true, the NFSv3 protocol will be enabled.

Constraints

• type = boolean

field v4_1_enabled: Optional[StrictBool] = None

If set to true, the NFSv4.1 protocol will be enabled.

Constraints

• type = boolean

NfsExportPolicy

pydantic model pypureclient.flashblade.NfsExportPolicy(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, enabled: Optional[StrictBool] = None, is_local: Optional[StrictBool] = None, location: Optional[FixedReference] = None, policy_type: Optional[StrictStr] = None, version: Optional[StrictStr] = None, context: Optional[Reference] = None, rules: Optional[ConstrainedListValue[NfsExportPolicyRuleInPolicy]] = None)

field context: Optional[Reference] = None

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.

field enabled: Optional[StrictBool] = None

If true, the policy is enabled. If not specified, defaults to true.

Constraints

• type = boolean

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field is_local: Optional[StrictBool] = None

Whether the policy is defined on the local array.

Constraints

• type = boolean

field location: Optional[FixedReference] = None

Reference to the array where the policy is defined.

field name: Optional[StrictStr] = None

A name chosen by the user. Can be changed. Must be locally unique.

field policy_type: Optional[StrictStr] = None

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.

field rules: Optional[ConstrainedListValue[NfsExportPolicyRuleInPolicy]] = None

All of the rules that are part of this policy. The order is the evaluation order.

Constraints

• maxItems = 200

field version: Optional[StrictStr] = None

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.

NfsExportPolicyGetResponse

pydantic model pypureclient.flashblade.NfsExportPolicyGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[NfsExportPolicy]] = None, errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[NfsExportPolicy]] = None

A list of NFS export policy objects.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

NfsExportPolicyPost

pydantic model pypureclient.flashblade.NfsExportPolicyPost(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, enabled: Optional[StrictBool] = None, is_local: Optional[StrictBool] = None, location: Optional[FixedReference] = None, policy_type: Optional[StrictStr] = None, rules: Optional[ConstrainedListValue[NfsExportPolicyRuleInPolicy]] = None)

field enabled: Optional[StrictBool] = None

If true, the policy is enabled. If not specified, defaults to true.

Constraints

• type = boolean

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field is_local: Optional[StrictBool] = None

Whether the policy is defined on the local array.

Constraints

• type = boolean

field location: Optional[FixedReference] = None

Reference to the array where the policy is defined.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field policy_type: Optional[StrictStr] = None

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.

field rules: Optional[ConstrainedListValue[NfsExportPolicyRuleInPolicy]] = None

All of the rules that are part of this policy. The order is the evaluation order.

Constraints

• maxItems = 200

NfsExportPolicyResponse

pydantic model pypureclient.flashblade.NfsExportPolicyResponse(*, items: Optional[ConstrainedListValue[NfsExportPolicy]] = None)

field items: Optional[ConstrainedListValue[NfsExportPolicy]] = None

A list of NFS export policy objects.

NfsExportPolicyRule

pydantic model pypureclient.flashblade.NfsExportPolicyRule(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, access: Optional[StrictStr] = None, anongid: Optional[StrictStr] = None, anonuid: Optional[StrictStr] = None, atime: Optional[StrictBool] = None, client: Optional[StrictStr] = None, fileid_32bit: Optional[StrictBool] = None, permission: Optional[StrictStr] = None, policy: Optional[FixedReference] = None, policy_version: Optional[StrictStr] = None, secure: Optional[StrictBool] = None, security: Optional[ConstrainedListValue[StrictStr]] = None, index: Optional[StrictInt] = None, context: Optional[Reference] = None)

field access: Optional[StrictStr] = None

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.

field anongid: Optional[StrictStr] = None

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.

field anonuid: Optional[StrictStr] = None

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.

field atime: Optional[StrictBool] = None

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.

Constraints

• type = boolean

field client: Optional[StrictStr] = None

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.

field context: Optional[Reference] = None

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.

field fileid_32bit: Optional[StrictBool] = None

Whether the file id is 32 bits or not. Defaults to false.

Constraints

• type = boolean

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field index: Optional[StrictInt] = None

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.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field permission: Optional[StrictStr] = None

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.

field policy: Optional[FixedReference] = None

The policy to which this rule belongs.

field policy_version: Optional[StrictStr] = None

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.

field secure: Optional[StrictBool] = None

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.

Constraints

• type = boolean

field security: Optional[ConstrainedListValue[StrictStr]] = None

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.

NfsExportPolicyRuleBase

pydantic model pypureclient.flashblade.NfsExportPolicyRuleBase(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, access: Optional[StrictStr] = None, anongid: Optional[StrictStr] = None, anonuid: Optional[StrictStr] = None, atime: Optional[StrictBool] = None, client: Optional[StrictStr] = None, fileid_32bit: Optional[StrictBool] = None, permission: Optional[StrictStr] = None, policy: Optional[FixedReference] = None, policy_version: Optional[StrictStr] = None, secure: Optional[StrictBool] = None, security: Optional[ConstrainedListValue[StrictStr]] = None)

field access: Optional[StrictStr] = None

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.

field anongid: Optional[StrictStr] = None

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.

field anonuid: Optional[StrictStr] = None

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.

field atime: Optional[StrictBool] = None

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.

Constraints

• type = boolean

field client: Optional[StrictStr] = None

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.

field fileid_32bit: Optional[StrictBool] = None

Whether the file id is 32 bits or not. Defaults to false.

Constraints

• type = boolean

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field permission: Optional[StrictStr] = None

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.

field policy: Optional[FixedReference] = None

The policy to which this rule belongs.

field policy_version: Optional[StrictStr] = None

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.

field secure: Optional[StrictBool] = None

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.

Constraints

• type = boolean

field security: Optional[ConstrainedListValue[StrictStr]] = None

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.

NfsExportPolicyRuleGetResponse

pydantic model pypureclient.flashblade.NfsExportPolicyRuleGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[NfsExportPolicyRule]] = None, errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[NfsExportPolicyRule]] = None

Displays a list of all items after filtering.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

NfsExportPolicyRuleInPolicy

pydantic model pypureclient.flashblade.NfsExportPolicyRuleInPolicy(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, access: Optional[StrictStr] = None, anongid: Optional[StrictStr] = None, anonuid: Optional[StrictStr] = None, atime: Optional[StrictBool] = None, client: Optional[StrictStr] = None, fileid_32bit: Optional[StrictBool] = None, permission: Optional[StrictStr] = None, policy: Optional[FixedReference] = None, policy_version: Optional[StrictStr] = None, secure: Optional[StrictBool] = None, security: Optional[ConstrainedListValue[StrictStr]] = None, index: Optional[StrictInt] = None)

field access: Optional[StrictStr] = None

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.

field anongid: Optional[StrictStr] = None

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.

field anonuid: Optional[StrictStr] = None

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.

field atime: Optional[StrictBool] = None

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.

Constraints

• type = boolean

field client: Optional[StrictStr] = None

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.

field fileid_32bit: Optional[StrictBool] = None

Whether the file id is 32 bits or not. Defaults to false.

Constraints

• type = boolean

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field index: Optional[StrictInt] = None

The index within the policy. The index indicates the order the rules are evaluated.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field permission: Optional[StrictStr] = None

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.

field policy: Optional[FixedReference] = None

The policy to which this rule belongs.

field policy_version: Optional[StrictStr] = None

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.

field secure: Optional[StrictBool] = None

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.

Constraints

• type = boolean

field security: Optional[ConstrainedListValue[StrictStr]] = None

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.

NfsExportPolicyRuleResponse

pydantic model pypureclient.flashblade.NfsExportPolicyRuleResponse(*, items: Optional[ConstrainedListValue[NfsExportPolicyRule]] = None)

field items: Optional[ConstrainedListValue[NfsExportPolicyRule]] = None

Displays a list of all items after filtering.

NfsPatch

pydantic model pypureclient.flashblade.NfsPatch(*, export_policy: Optional[ReferenceWritable] = None, rules: Optional[StrictStr] = None, v3_enabled: Optional[StrictBool] = None, v4_1_enabled: Optional[StrictBool] = None, add_rules: Optional[StrictStr] = None, after: Optional[StrictStr] = None, remove_rules: Optional[StrictStr] = None)

field add_rules: Optional[StrictStr] = None

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.

field after: Optional[StrictStr] = None

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.

field export_policy: Optional[ReferenceWritable] = None

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.

field remove_rules: Optional[StrictStr] = None

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.

field rules: Optional[StrictStr] = None

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).

field v3_enabled: Optional[StrictBool] = None

If set to true, the NFSv3 protocol will be enabled.

Constraints

• type = boolean

field v4_1_enabled: Optional[StrictBool] = None

If set to true, the NFSv4.1 protocol will be enabled.

Constraints

• type = boolean

Oauth210TokenPost400Response

pydantic model pypureclient.flashblade.Oauth210TokenPost400Response(*, error: Optional[StrictStr] = None, error_description: Optional[StrictStr] = None)

field error: Optional[StrictStr] = None

field error_description: Optional[StrictStr] = None

Oauth210TokenPost401Response

pydantic model pypureclient.flashblade.Oauth210TokenPost401Response(*, error: Optional[StrictStr] = None, error_description: Optional[StrictStr] = None)

field error: Optional[StrictStr] = None

field error_description: Optional[StrictStr] = None

OauthTokenResponse

pydantic model pypureclient.flashblade.OauthTokenResponse(*, access_token: Optional[StrictStr] = None, expires_in: Optional[StrictInt] = None, issued_token_type: Optional[StrictStr] = None, token_type: Optional[StrictStr] = None)

field access_token: Optional[StrictStr] = None

The serialized OAuth 2.0 Bearer token used to perform authenticated requests. The access token must be added to the Authorization header of all API calls.

field expires_in: Optional[StrictInt] = None

The duration after which the access token will expire. Measured in seconds. This differs from other duration fields that are expressed in milliseconds.

field issued_token_type: Optional[StrictStr] = None

The type of token that is issued. The Pure Storage REST API supports OAuth 2.0 access tokens.

field token_type: Optional[StrictStr] = None

Indicates how the API client can use the access token issued. The Pure Storage REST API supports the Bearer token.

ObjectBacklog

pydantic model pypureclient.flashblade.ObjectBacklog(*, bytes_count: Optional[StrictInt] = None, delete_ops_count: Optional[StrictInt] = None, other_ops_count: Optional[StrictInt] = None, put_ops_count: Optional[StrictInt] = None)

field bytes_count: Optional[StrictInt] = None

The size of the objects in bytes that need to be replicated. This does not include the size of custom metadata.

field delete_ops_count: Optional[StrictInt] = None

The number of DELETE operations that need to be replicated.

field other_ops_count: Optional[StrictInt] = None

The number of other operations that need to be replicated.

field put_ops_count: Optional[StrictInt] = None

The number of PUT operations that need to be replicated.

ObjectLockConfigBase

pydantic model pypureclient.flashblade.ObjectLockConfigBase(*, default_retention_mode: Optional[StrictStr] = None, enabled: Optional[StrictBool] = None, freeze_locked_objects: Optional[StrictBool] = None)

Configuration settings related to object lock.

field default_retention_mode: Optional[StrictStr] = None

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.

field enabled: Optional[StrictBool] = None

If set to true, then S3 APIs relating to object lock may be used.

Constraints

• type = boolean

field freeze_locked_objects: Optional[StrictBool] = None

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.

Constraints

• type = boolean

ObjectLockConfigRequestBody

pydantic model pypureclient.flashblade.ObjectLockConfigRequestBody(*, default_retention_mode: Optional[StrictStr] = None, enabled: Optional[StrictBool] = None, freeze_locked_objects: Optional[StrictBool] = None, default_retention: Optional[StrictStr] = None)

field default_retention: Optional[StrictStr] = None

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.

field default_retention_mode: Optional[StrictStr] = None

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.

field enabled: Optional[StrictBool] = None

If set to true, then S3 APIs relating to object lock may be used.

Constraints

• type = boolean

field freeze_locked_objects: Optional[StrictBool] = None

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.

Constraints

• type = boolean

ObjectLockConfigResponse

pydantic model pypureclient.flashblade.ObjectLockConfigResponse(*, default_retention_mode: Optional[StrictStr] = None, enabled: Optional[StrictBool] = None, freeze_locked_objects: Optional[StrictBool] = None, default_retention: Optional[StrictInt] = None)

field default_retention: Optional[StrictInt] = None

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.

field default_retention_mode: Optional[StrictStr] = None

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.

field enabled: Optional[StrictBool] = None

If set to true, then S3 APIs relating to object lock may be used.

Constraints

• type = boolean

field freeze_locked_objects: Optional[StrictBool] = None

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.

Constraints

• type = boolean

ObjectStoreAccessKey

pydantic model pypureclient.flashblade.ObjectStoreAccessKey(*, name: Optional[StrictStr] = None, context: Optional[Reference] = None, created: Optional[StrictInt] = None, enabled: Optional[StrictBool] = None, secret_access_key: Optional[StrictStr] = None, user: Optional[FixedReference] = None)

field context: Optional[Reference] = None

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.

field created: Optional[StrictInt] = None

Creation timestamp of the object.

field enabled: Optional[StrictBool] = None

Is the access key enabled? If not specified, defaults to false.

Constraints

• type = boolean

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field secret_access_key: Optional[StrictStr] = None

The secret access key, only populated on creation if it is not imported from another FlashBlade.

field user: Optional[FixedReference] = None

Reference of the associated user.

ObjectStoreAccessKeyGetResponse

pydantic model pypureclient.flashblade.ObjectStoreAccessKeyGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None, items: Optional[ConstrainedListValue[ObjectStoreAccessKey]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[ObjectStoreAccessKey]] = None

A list of object store access key objects.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

ObjectStoreAccessKeyPost

pydantic model pypureclient.flashblade.ObjectStoreAccessKeyPost(*, secret_access_key: Optional[StrictStr] = None, user: Optional[ObjectStoreAccessKeyPostUser] = None)

field secret_access_key: Optional[StrictStr] = None

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.

field user: Optional[ObjectStoreAccessKeyPostUser] = None

ObjectStoreAccessKeyPostUser

pydantic model pypureclient.flashblade.ObjectStoreAccessKeyPostUser(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, resource_type: Optional[StrictStr] = None)

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

A name chosen by the user. Can be changed. Must be locally unique.

field resource_type: Optional[StrictStr] = None

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.

ObjectStoreAccessKeyResponse

pydantic model pypureclient.flashblade.ObjectStoreAccessKeyResponse(*, items: Optional[ConstrainedListValue[ObjectStoreAccessKey]] = None)

field items: Optional[ConstrainedListValue[ObjectStoreAccessKey]] = None

A list of object store access key objects.

ObjectStoreAccessPolicy

pydantic model pypureclient.flashblade.ObjectStoreAccessPolicy(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, enabled: Optional[StrictBool] = None, is_local: Optional[StrictBool] = None, location: Optional[FixedReference] = None, policy_type: Optional[StrictStr] = None, context: Optional[Reference] = None, account: Optional[FixedReference] = None, arn: Optional[StrictStr] = None, created: Optional[StrictInt] = None, description: Optional[StrictStr] = None, rules: Optional[ConstrainedListValue[PolicyRuleObjectAccess]] = None, updated: Optional[StrictInt] = None)

field account: Optional[FixedReference] = None

Reference of the associated account. If the policy is not associated with an account, all fields in the reference possess null values.

field arn: Optional[StrictStr] = None

Amazon Resource Name of the policy. Used when referencing the policy via S3 APIs.

field context: Optional[Reference] = None

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.

field created: Optional[StrictInt] = None

Creation timestamp of the object.

field description: Optional[StrictStr] = None

A description of the policy, optionally specified when the policy is created. Cannot be modified for an existing policy.

field enabled: Optional[StrictBool] = None

If true, the policy is enabled. If not specified, defaults to true.

Constraints

• type = boolean

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field is_local: Optional[StrictBool] = None

Whether the policy is defined on the local array.

Constraints

• type = boolean

field location: Optional[FixedReference] = None

Reference to the array where the policy is defined.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field policy_type: Optional[StrictStr] = None

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.

field rules: Optional[ConstrainedListValue[PolicyRuleObjectAccess]] = None

field updated: Optional[StrictInt] = None

The last updated timestamp of the object.

ObjectStoreAccessPolicyAction

pydantic model pypureclient.flashblade.ObjectStoreAccessPolicyAction(*, name: Optional[StrictStr] = None, context: Optional[Reference] = None, description: Optional[StrictStr] = None)

field context: Optional[Reference] = None

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.

field description: Optional[StrictStr] = None

A description of the action.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

ObjectStoreAccessPolicyActionGetResponse

pydantic model pypureclient.flashblade.ObjectStoreAccessPolicyActionGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None, items: Optional[ConstrainedListValue[ObjectStoreAccessPolicyAction]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[ObjectStoreAccessPolicyAction]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

ObjectStoreAccessPolicyActionResponse

pydantic model pypureclient.flashblade.ObjectStoreAccessPolicyActionResponse(*, items: Optional[ConstrainedListValue[ObjectStoreAccessPolicyAction]] = None)

field items: Optional[ConstrainedListValue[ObjectStoreAccessPolicyAction]] = None

ObjectStoreAccessPolicyGetResponse

pydantic model pypureclient.flashblade.ObjectStoreAccessPolicyGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None, items: Optional[ConstrainedListValue[ObjectStoreAccessPolicy]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[ObjectStoreAccessPolicy]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

ObjectStoreAccessPolicyPatch

pydantic model pypureclient.flashblade.ObjectStoreAccessPolicyPatch(*, rules: Optional[ConstrainedListValue[PolicyRuleObjectAccessBulkManage]] = None)

field rules: Optional[ConstrainedListValue[PolicyRuleObjectAccessBulkManage]] = None

ObjectStoreAccessPolicyPost

pydantic model pypureclient.flashblade.ObjectStoreAccessPolicyPost(*, rules: Optional[ConstrainedListValue[PolicyRuleObjectAccessBulkManage]] = None, description: Optional[StrictStr] = None)

field description: Optional[StrictStr] = None

A description of the policy, optionally specified when the policy is created. Cannot be modified for an existing policy.

field rules: Optional[ConstrainedListValue[PolicyRuleObjectAccessBulkManage]] = None

ObjectStoreAccessPolicyResponse

pydantic model pypureclient.flashblade.ObjectStoreAccessPolicyResponse(*, items: Optional[ConstrainedListValue[ObjectStoreAccessPolicy]] = None)

field items: Optional[ConstrainedListValue[ObjectStoreAccessPolicy]] = None

ObjectStoreAccessPolicyRuleGetResponse

pydantic model pypureclient.flashblade.ObjectStoreAccessPolicyRuleGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None, items: Optional[ConstrainedListValue[PolicyRuleObjectAccess]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[PolicyRuleObjectAccess]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

ObjectStoreAccessPolicyRuleResponse

pydantic model pypureclient.flashblade.ObjectStoreAccessPolicyRuleResponse(*, items: Optional[ConstrainedListValue[PolicyRuleObjectAccess]] = None)

field items: Optional[ConstrainedListValue[PolicyRuleObjectAccess]] = None

ObjectStoreAccount

pydantic model pypureclient.flashblade.ObjectStoreAccount(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, context: Optional[Reference] = None, bucket_defaults: Optional[BucketDefaultsReadonly] = None, created: Optional[StrictInt] = None, hard_limit_enabled: Optional[StrictBool] = None, object_count: Optional[StrictInt] = None, public_access_config: Optional[PublicAccessConfig] = None, quota_limit: Optional[StrictInt] = None, space: Optional[Space] = None)

field bucket_defaults: Optional[BucketDefaultsReadonly] = None

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.

field context: Optional[Reference] = None

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.

field created: Optional[StrictInt] = None

Creation timestamp of the object.

field hard_limit_enabled: Optional[StrictBool] = None

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.

Constraints

• type = boolean

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field object_count: Optional[StrictInt] = None

The count of objects within the account.

field public_access_config: Optional[PublicAccessConfig] = None

field quota_limit: Optional[StrictInt] = None

The effective quota limit applied against the size of the account, displayed in bytes. If unset, the account is unlimited in size.

field space: Optional[Space] = None

The space specification of the object store account.

ObjectStoreAccountGetResponse

pydantic model pypureclient.flashblade.ObjectStoreAccountGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None, items: Optional[ConstrainedListValue[ObjectStoreAccount]] = None, total: Optional[ObjectStoreAccount] = None)

field continuation_token: Optional[StrictStr] = None

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).

field errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[ObjectStoreAccount]] = None

A list of object store account objects.

field total: Optional[ObjectStoreAccount] = None

If total_only query param is true, then this field will be a total of all records after filtering and no items will be returned. If total_only is false, then it will be a total of all records on this page.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

ObjectStoreAccountPatch

pydantic model pypureclient.flashblade.ObjectStoreAccountPatch(*, bucket_defaults: Optional[BucketDefaults] = None, hard_limit_enabled: Optional[StrictBool] = None, public_access_config: Optional[PublicAccessConfig] = None, quota_limit: Optional[StrictStr] = None)

field bucket_defaults: Optional[BucketDefaults] = None

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.

field hard_limit_enabled: Optional[StrictBool] = None

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.

Constraints

• type = boolean

field public_access_config: Optional[PublicAccessConfig] = None

field quota_limit: Optional[StrictStr] = None

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.

ObjectStoreAccountPost

pydantic model pypureclient.flashblade.ObjectStoreAccountPost(*, bucket_defaults: Optional[BucketDefaults] = None, hard_limit_enabled: Optional[StrictBool] = None, quota_limit: Optional[StrictStr] = None)

field bucket_defaults: Optional[BucketDefaults] = None

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.

field hard_limit_enabled: Optional[StrictBool] = None

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.

Constraints

• type = boolean

field quota_limit: Optional[StrictStr] = None

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.

ObjectStoreAccountResponse

pydantic model pypureclient.flashblade.ObjectStoreAccountResponse(*, items: Optional[ConstrainedListValue[ObjectStoreAccount]] = None)

field items: Optional[ConstrainedListValue[ObjectStoreAccount]] = None

A list of object store account objects.

ObjectStoreRemoteCredentialGetResp

pydantic model pypureclient.flashblade.ObjectStoreRemoteCredentialGetResp(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None, items: Optional[ConstrainedListValue[ObjectStoreRemoteCredentials]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[ObjectStoreRemoteCredentials]] = None

A list of object store remote credentials.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

ObjectStoreRemoteCredentials

pydantic model pypureclient.flashblade.ObjectStoreRemoteCredentials(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, context: Optional[Reference] = None, access_key_id: Optional[StrictStr] = None, remote: Optional[FixedReference] = None, secret_access_key: Optional[StrictStr] = None)

field access_key_id: Optional[StrictStr] = None

Access Key ID to be used when connecting to a remote object store.

field context: Optional[Reference] = None

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.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

A name chosen by the user. Can be changed. Must be locally unique.

field remote: Optional[FixedReference] = None

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.

field secret_access_key: Optional[StrictStr] = None

Secret Access Key to be used when connecting to a remote object store.

ObjectStoreRemoteCredentialsPost

pydantic model pypureclient.flashblade.ObjectStoreRemoteCredentialsPost(*, access_key_id: Optional[StrictStr] = None, secret_access_key: Optional[StrictStr] = None)

field access_key_id: Optional[StrictStr] = None

Access Key ID to be used when connecting to a remote object store.

field secret_access_key: Optional[StrictStr] = None

Secret Access Key to be used when connecting to a remote object store.

ObjectStoreRemoteCredentialsResp

pydantic model pypureclient.flashblade.ObjectStoreRemoteCredentialsResp(*, items: Optional[ConstrainedListValue[ObjectStoreRemoteCredentials]] = None)

field items: Optional[ConstrainedListValue[ObjectStoreRemoteCredentials]] = None

A list of object store remote credentials.

ObjectStoreRole

pydantic model pypureclient.flashblade.ObjectStoreRole(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, context: Optional[Reference] = None, account: Optional[FixedReference] = None, created: Optional[StrictInt] = None, max_session_duration: Optional[StrictInt] = None, prn: Optional[StrictStr] = None, trusted_entities: Optional[ConstrainedListValue[FixedReference]] = None)

field account: Optional[FixedReference] = None

Reference of the associated account.

field context: Optional[Reference] = None

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.

field created: Optional[StrictInt] = None

Creation timestamp of the object.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field max_session_duration: Optional[StrictInt] = None

The maximum session duration for the role in milliseconds

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field prn: Optional[StrictStr] = None

Pure Resource Name of the role

field trusted_entities: Optional[ConstrainedListValue[FixedReference]] = None

List of trusted entities

ObjectStoreRoleGetResponse

pydantic model pypureclient.flashblade.ObjectStoreRoleGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None, items: Optional[ConstrainedListValue[ObjectStoreRole]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[ObjectStoreRole]] = None

A list of object store roles.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

ObjectStoreRolePost

pydantic model pypureclient.flashblade.ObjectStoreRolePost(*, max_session_duration: Optional[StrictInt] = None)

field max_session_duration: Optional[StrictInt] = None

Maximum session duration in milliseconds. If not provided when creating the role, defaults to 1h, minimum is 1h, maximum is 12h.

ObjectStoreRoleResponse

pydantic model pypureclient.flashblade.ObjectStoreRoleResponse(*, items: Optional[ConstrainedListValue[ObjectStoreRole]] = None)

field items: Optional[ConstrainedListValue[ObjectStoreRole]] = None

A list of object store roles.

ObjectStoreTrustPolicy

pydantic model pypureclient.flashblade.ObjectStoreTrustPolicy(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, enabled: Optional[StrictBool] = None, is_local: Optional[StrictBool] = None, location: Optional[FixedReference] = None, policy_type: Optional[StrictStr] = None, context: Optional[Reference] = None, role: Optional[FixedReference] = None, rules: Optional[ConstrainedListValue[TrustPolicyRule]] = None)

field context: Optional[Reference] = None

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.

field enabled: Optional[StrictBool] = None

If true, the policy is enabled. If not specified, defaults to true.

Constraints

• type = boolean

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field is_local: Optional[StrictBool] = None

Whether the policy is defined on the local array.

Constraints

• type = boolean

field location: Optional[FixedReference] = None

Reference to the array where the policy is defined.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field policy_type: Optional[StrictStr] = None

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.

field role: Optional[FixedReference] = None

Object Store Role to which the Trust Policy applies.

field rules: Optional[ConstrainedListValue[TrustPolicyRule]] = None

List of rules establishing the trust policy

ObjectStoreTrustPolicyGetResponse

pydantic model pypureclient.flashblade.ObjectStoreTrustPolicyGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None, items: Optional[ConstrainedListValue[ObjectStoreTrustPolicy]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[ObjectStoreTrustPolicy]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

ObjectStoreTrustPolicyResponse

pydantic model pypureclient.flashblade.ObjectStoreTrustPolicyResponse(*, items: Optional[ConstrainedListValue[ObjectStoreTrustPolicy]] = None)

field items: Optional[ConstrainedListValue[ObjectStoreTrustPolicy]] = None

ObjectStoreTrustPolicyRuleGetResponse

pydantic model pypureclient.flashblade.ObjectStoreTrustPolicyRuleGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None, items: Optional[ConstrainedListValue[TrustPolicyRuleWithContext]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[TrustPolicyRuleWithContext]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

ObjectStoreTrustPolicyRuleResponse

pydantic model pypureclient.flashblade.ObjectStoreTrustPolicyRuleResponse(*, items: Optional[ConstrainedListValue[TrustPolicyRuleWithContext]] = None)

field items: Optional[ConstrainedListValue[TrustPolicyRuleWithContext]] = None

ObjectStoreUser

pydantic model pypureclient.flashblade.ObjectStoreUser(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, context: Optional[Reference] = None, access_keys: Optional[ConstrainedListValue[FixedReference]] = None, account: Optional[FixedReference] = None, created: Optional[StrictInt] = None)

field access_keys: Optional[ConstrainedListValue[FixedReference]] = None

References of the user’s access keys.

field account: Optional[FixedReference] = None

Reference of the associated account.

field context: Optional[Reference] = None

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.

field created: Optional[StrictInt] = None

Creation timestamp of the object.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

ObjectStoreUserGetResponse

pydantic model pypureclient.flashblade.ObjectStoreUserGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None, items: Optional[ConstrainedListValue[ObjectStoreUser]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[ObjectStoreUser]] = None

A list of object store user objects.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

ObjectStoreUserResponse

pydantic model pypureclient.flashblade.ObjectStoreUserResponse(*, items: Optional[ConstrainedListValue[ObjectStoreUser]] = None)

field items: Optional[ConstrainedListValue[ObjectStoreUser]] = None

A list of object store user objects.

ObjectStoreVirtualHost

pydantic model pypureclient.flashblade.ObjectStoreVirtualHost(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, context: Optional[Reference] = None)

field context: Optional[Reference] = None

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.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

A hostname by which the array can be addressed for virtual hosted-style S3 requests.

ObjectStoreVirtualHostGetResponse

pydantic model pypureclient.flashblade.ObjectStoreVirtualHostGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None, items: Optional[ConstrainedListValue[ObjectStoreVirtualHost]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[ObjectStoreVirtualHost]] = None

A list of object store virtual host objects.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

ObjectStoreVirtualHostResponse

pydantic model pypureclient.flashblade.ObjectStoreVirtualHostResponse(*, items: Optional[ConstrainedListValue[ObjectStoreVirtualHost]] = None)

field items: Optional[ConstrainedListValue[ObjectStoreVirtualHost]] = None

A list of object store virtual host objects.

OidcSso

pydantic model pypureclient.flashblade.OidcSso(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, enabled: Optional[StrictBool] = None, idp: Optional[OidcSsoPostIdp] = None, prn: Optional[StrictStr] = None, services: Optional[ConstrainedListValue[StrictStr]] = None)

field enabled: Optional[StrictBool] = None

If set to true, the OIDC SSO configuration is enabled.

Constraints

• type = boolean

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field idp: Optional[OidcSsoPostIdp] = None

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field prn: Optional[StrictStr] = None

Pure Resource Name of the identity provider

field services: Optional[ConstrainedListValue[StrictStr]] = None

Services that the OIDC SSO authentication is used for. Valid values: object.

OidcSsoGetResponse

pydantic model pypureclient.flashblade.OidcSsoGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[OidcSso]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[OidcSso]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

OidcSsoPatch

pydantic model pypureclient.flashblade.OidcSsoPatch(*, enabled: Optional[StrictBool] = None, idp: Optional[OidcSsoPostIdp] = None, prn: Optional[StrictStr] = None, services: Optional[ConstrainedListValue[StrictStr]] = None, name: Optional[StrictStr] = None)

field enabled: Optional[StrictBool] = None

If set to true, the OIDC SSO configuration is enabled.

Constraints

• type = boolean

field idp: Optional[OidcSsoPostIdp] = None

field name: Optional[StrictStr] = None

A new name for the provider

field prn: Optional[StrictStr] = None

Pure Resource Name of the identity provider

field services: Optional[ConstrainedListValue[StrictStr]] = None

Services that the OIDC SSO authentication is used for. Valid values: object.

OidcSsoPost

pydantic model pypureclient.flashblade.OidcSsoPost(*, enabled: Optional[StrictBool] = None, idp: Optional[OidcSsoPostIdp] = None, prn: Optional[StrictStr] = None, services: Optional[ConstrainedListValue[StrictStr]] = None)

field enabled: Optional[StrictBool] = None

If set to true, the OIDC SSO configuration is enabled.

Constraints

• type = boolean

field idp: Optional[OidcSsoPostIdp] = None

field prn: Optional[StrictStr] = None

Pure Resource Name of the identity provider

field services: Optional[ConstrainedListValue[StrictStr]] = None

Services that the OIDC SSO authentication is used for. Valid values: object.

OidcSsoPostIdp

pydantic model pypureclient.flashblade.OidcSsoPostIdp(*, provider_url: Optional[StrictStr] = None, provider_url_ca_certificate: Optional[Reference] = None, provider_url_ca_certificate_group: Optional[Reference] = None)

Identity Provider

field provider_url: Optional[StrictStr] = None

URL of the Identity Provider server

field provider_url_ca_certificate: Optional[Reference] = None

CA certificate used to validate the authenticity of the configured Identity Provider server.

field provider_url_ca_certificate_group: Optional[Reference] = None

A certificate group containing CA certificates that can be used to validate the authenticity of the configured Identity Provider server.

OidcSsoResponse

pydantic model pypureclient.flashblade.OidcSsoResponse(*, items: Optional[ConstrainedListValue[OidcSso]] = None)

field items: Optional[ConstrainedListValue[OidcSso]] = None

PageInfo

pydantic model pypureclient.flashblade.PageInfo(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None)

field continuation_token: Optional[StrictStr] = None

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).

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

PasswordPoliciesGetResponse

pydantic model pypureclient.flashblade.PasswordPoliciesGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[PasswordPolicy]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[PasswordPolicy]] = None

Returns a list of all items after filtering. If applicable, the values are displayed for each name.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

PasswordPoliciesResponse

pydantic model pypureclient.flashblade.PasswordPoliciesResponse(*, items: Optional[ConstrainedListValue[PasswordPolicy]] = None)

field items: Optional[ConstrainedListValue[PasswordPolicy]] = None

Returns a list of all items after filtering. If applicable, the values are displayed for each name.

PasswordPolicy

pydantic model pypureclient.flashblade.PasswordPolicy(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, enabled: Optional[StrictBool] = None, is_local: Optional[StrictBool] = None, location: Optional[FixedReference] = None, policy_type: Optional[StrictStr] = None, enforce_dictionary_check: Optional[StrictBool] = None, enforce_username_check: Optional[StrictBool] = None, lockout_duration: Optional[ConstrainedIntValue] = None, max_login_attempts: Optional[ConstrainedIntValue] = None, min_character_groups: Optional[ConstrainedIntValue] = None, min_characters_per_group: Optional[ConstrainedIntValue] = None, min_password_age: Optional[ConstrainedIntValue] = None, min_password_length: Optional[ConstrainedIntValue] = None, password_history: Optional[ConstrainedIntValue] = None)

field enabled: Optional[StrictBool] = None

If true, the policy is enabled. If not specified, defaults to true.

Constraints

• type = boolean

field enforce_dictionary_check: Optional[StrictBool] = None

If true, test password against dictionary of known leaked passwords. Requires passwords longer than 6 characters.

Constraints

• type = boolean

field enforce_username_check: Optional[StrictBool] = None

If true, the username cannot be a substring of the password. Only applies to usernames of 4 characters and longer.

Constraints

• type = boolean

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field is_local: Optional[StrictBool] = None

Whether the policy is defined on the local array.

Constraints

• type = boolean

field location: Optional[FixedReference] = None

Reference to the array where the policy is defined.

field lockout_duration: Optional[ConstrainedIntValue] = None

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.

Constraints

• minimum = 0

• maximum = 7776000000

field max_login_attempts: Optional[ConstrainedIntValue] = None

Maximum number of failed login attempts allowed before the user is locked out.

Constraints

• minimum = 0

• maximum = 100

field min_character_groups: Optional[ConstrainedIntValue] = None

The minimum number of character groups ([a-z], [A-Z], [0-9], other) required to be present in a password.

Constraints

• minimum = 0

• maximum = 4

field min_characters_per_group: Optional[ConstrainedIntValue] = None

The minimum number of characters per group to count the group as present.

Constraints

• minimum = 0

field min_password_age: Optional[ConstrainedIntValue] = None

The minimum age, in milliseconds, of password before password change is allowed. Ranges from 0 ms to 7 days with precision to 1 hour.

Constraints

• minimum = 0

• maximum = 604800000

field min_password_length: Optional[ConstrainedIntValue] = None

Minimum password length. If not specified, defaults to 1.

Constraints

• minimum = 0

• maximum = 100

field name: Optional[StrictStr] = None

A name chosen by the user. Can be changed. Must be locally unique.

field password_history: Optional[ConstrainedIntValue] = None

The number of passwords tracked to prevent reuse of passwords.

Constraints

• minimum = 0

• maximum = 64

field policy_type: Optional[StrictStr] = None

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.

Permission

pydantic model pypureclient.flashblade.Permission(*, action: Optional[StrictStr] = None, resource_type: Optional[StrictStr] = None)

field action: Optional[StrictStr] = None

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.

field resource_type: Optional[StrictStr] = None

The resource_type that this permission affects.

Policy

pydantic model pypureclient.flashblade.Policy(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, enabled: Optional[StrictBool] = None, is_local: Optional[StrictBool] = None, location: Optional[FixedReference] = None, policy_type: Optional[StrictStr] = None, context: Optional[Reference] = None, retention_lock: Optional[StrictStr] = None, rules: Optional[ConstrainedListValue[PolicyRule]] = None)

field context: Optional[Reference] = None

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.

field enabled: Optional[StrictBool] = None

If true, the policy is enabled. If not specified, defaults to true.

Constraints

• type = boolean

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field is_local: Optional[StrictBool] = None

Whether the policy is defined on the local array.

Constraints

• type = boolean

field location: Optional[FixedReference] = None

Reference to the array where the policy is defined.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field policy_type: Optional[StrictStr] = None

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.

field retention_lock: Optional[StrictStr] = None

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.

field rules: Optional[ConstrainedListValue[PolicyRule]] = None

PolicyBase

pydantic model pypureclient.flashblade.PolicyBase(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, enabled: Optional[StrictBool] = None, is_local: Optional[StrictBool] = None, location: Optional[FixedReference] = None, policy_type: Optional[StrictStr] = None)

field enabled: Optional[StrictBool] = None

If true, the policy is enabled. If not specified, defaults to true.

Constraints

• type = boolean

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field is_local: Optional[StrictBool] = None

Whether the policy is defined on the local array.

Constraints

• type = boolean

field location: Optional[FixedReference] = None

Reference to the array where the policy is defined.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field policy_type: Optional[StrictStr] = None

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.

PolicyBaseContext

pydantic model pypureclient.flashblade.PolicyBaseContext(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, enabled: Optional[StrictBool] = None, is_local: Optional[StrictBool] = None, location: Optional[FixedReference] = None, policy_type: Optional[StrictStr] = None, context: Optional[Reference] = None)

field context: Optional[Reference] = None

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.

field enabled: Optional[StrictBool] = None

If true, the policy is enabled. If not specified, defaults to true.

Constraints

• type = boolean

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field is_local: Optional[StrictBool] = None

Whether the policy is defined on the local array.

Constraints

• type = boolean

field location: Optional[FixedReference] = None

Reference to the array where the policy is defined.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field policy_type: Optional[StrictStr] = None

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.

PolicyBaseGetResponse

pydantic model pypureclient.flashblade.PolicyBaseGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[PolicyBaseContext]] = None, errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[PolicyBaseContext]] = None

A list of basic policy objects.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

PolicyBaseRenameable

pydantic model pypureclient.flashblade.PolicyBaseRenameable(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, enabled: Optional[StrictBool] = None, is_local: Optional[StrictBool] = None, location: Optional[FixedReference] = None, policy_type: Optional[StrictStr] = None)

field enabled: Optional[StrictBool] = None

If true, the policy is enabled. If not specified, defaults to true.

Constraints

• type = boolean

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field is_local: Optional[StrictBool] = None

Whether the policy is defined on the local array.

Constraints

• type = boolean

field location: Optional[FixedReference] = None

Reference to the array where the policy is defined.

field name: Optional[StrictStr] = None

A name chosen by the user. Can be changed. Must be locally unique.

field policy_type: Optional[StrictStr] = None

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.

PolicyBaseResponse

pydantic model pypureclient.flashblade.PolicyBaseResponse(*, items: Optional[ConstrainedListValue[PolicyBaseContext]] = None)

field items: Optional[ConstrainedListValue[PolicyBaseContext]] = None

A list of basic policy objects.

PolicyFileSystemSnapshot

pydantic model pypureclient.flashblade.PolicyFileSystemSnapshot(*, member: Optional[FixedReference] = None, policy: Optional[LocationReference] = None, context: Optional[Reference] = None)

field context: Optional[Reference] = None

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.

field member: Optional[FixedReference] = None

Reference to the resource the policy is applied to.

field policy: Optional[LocationReference] = None

Reference to the policy.

PolicyFileSystemSnapshotGetResponse

pydantic model pypureclient.flashblade.PolicyFileSystemSnapshotGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[PolicyFileSystemSnapshot]] = None, errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[PolicyFileSystemSnapshot]] = None

A list of members for policies.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

PolicyFileSystemSnapshotResponse

pydantic model pypureclient.flashblade.PolicyFileSystemSnapshotResponse(*, items: Optional[ConstrainedListValue[PolicyFileSystemSnapshot]] = None)

field items: Optional[ConstrainedListValue[PolicyFileSystemSnapshot]] = None

A list of members for policies.

PolicyGetResponse

pydantic model pypureclient.flashblade.PolicyGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Policy]] = None, errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[Policy]] = None

A list of policy objects.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

PolicyMember

pydantic model pypureclient.flashblade.PolicyMember(*, member: Optional[FixedReference] = None, policy: Optional[FixedReference] = None)

field member: Optional[FixedReference] = None

Reference to the resource the policy is applied to.

field policy: Optional[FixedReference] = None

Reference to the policy.

PolicyMemberContext

pydantic model pypureclient.flashblade.PolicyMemberContext(*, member: Optional[FixedReference] = None, policy: Optional[FixedReference] = None, context: Optional[Reference] = None)

field context: Optional[Reference] = None

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.

field member: Optional[FixedReference] = None

Reference to the resource the policy is applied to.

field policy: Optional[FixedReference] = None

Reference to the policy.

PolicyMemberContextGetResponse

pydantic model pypureclient.flashblade.PolicyMemberContextGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[PolicyMemberContext]] = None, errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[PolicyMemberContext]] = None

A list of members for policies.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

PolicyMemberContextResponse

pydantic model pypureclient.flashblade.PolicyMemberContextResponse(*, items: Optional[ConstrainedListValue[PolicyMemberContext]] = None)

field items: Optional[ConstrainedListValue[PolicyMemberContext]] = None

A list of members for policies.

PolicyMemberGetResponse

pydantic model pypureclient.flashblade.PolicyMemberGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[PolicyMember]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[PolicyMember]] = None

A list of members for policies.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

PolicyMemberResponse

pydantic model pypureclient.flashblade.PolicyMemberResponse(*, items: Optional[ConstrainedListValue[PolicyMember]] = None)

field items: Optional[ConstrainedListValue[PolicyMember]] = None

A list of members for policies.

PolicyMemberWithRemote

pydantic model pypureclient.flashblade.PolicyMemberWithRemote(*, member: Optional[FixedReference] = None, policy: Optional[LocationReference] = None, context: Optional[Reference] = None, link: Optional[MemberLink] = None)

field context: Optional[Reference] = None

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.

field link: Optional[MemberLink] = None

Only populated if the member is a file system replica link. Contains additional information about the link.

field member: Optional[FixedReference] = None

Reference to the resource the policy is applied to.

field policy: Optional[LocationReference] = None

Reference to the policy.

PolicyMemberWithRemoteGetResponse

pydantic model pypureclient.flashblade.PolicyMemberWithRemoteGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[PolicyMemberWithRemote]] = None, errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[PolicyMemberWithRemote]] = None

A list of members for policies.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

PolicyMemberWithRemoteResponse

pydantic model pypureclient.flashblade.PolicyMemberWithRemoteResponse(*, items: Optional[ConstrainedListValue[PolicyMemberWithRemote]] = None)

field items: Optional[ConstrainedListValue[PolicyMemberWithRemote]] = None

A list of members for policies.

PolicyPatch

pydantic model pypureclient.flashblade.PolicyPatch(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, enabled: Optional[StrictBool] = None, is_local: Optional[StrictBool] = None, location: Optional[FixedReference] = None, policy_type: Optional[StrictStr] = None, context: Optional[Reference] = None, retention_lock: Optional[StrictStr] = None, rules: Optional[ConstrainedListValue[PolicyRule]] = None, add_rules: Optional[ConstrainedListValue[PolicyRule]] = None, remove_rules: Optional[ConstrainedListValue[PolicyRule]] = None)

field add_rules: Optional[ConstrainedListValue[PolicyRule]] = None

field context: Optional[Reference] = None

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.

field enabled: Optional[StrictBool] = None

If true, the policy is enabled. If not specified, defaults to true.

Constraints

• type = boolean

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field is_local: Optional[StrictBool] = None

Whether the policy is defined on the local array.

Constraints

• type = boolean

field location: Optional[FixedReference] = None

Reference to the array where the policy is defined.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field policy_type: Optional[StrictStr] = None

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.

field remove_rules: Optional[ConstrainedListValue[PolicyRule]] = None

field retention_lock: Optional[StrictStr] = None

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.

field rules: Optional[ConstrainedListValue[PolicyRule]] = None

PolicyResponse

pydantic model pypureclient.flashblade.PolicyResponse(*, items: Optional[ConstrainedListValue[Policy]] = None)

field items: Optional[ConstrainedListValue[Policy]] = None

A list of policy objects.

PolicyRule

pydantic model pypureclient.flashblade.PolicyRule(*, at: Optional[StrictInt] = None, every: Optional[StrictInt] = None, keep_for: Optional[StrictInt] = None, time_zone: Optional[StrictStr] = None)

Rule

field at: Optional[StrictInt] = None

Time during the day to take the snapshot (using array time zone), only valid if ‘every’ is in days.

field every: Optional[StrictInt] = None

How often to take snapshots.

field keep_for: Optional[StrictInt] = None

The time to keep the snapshots for.

field time_zone: Optional[StrictStr] = None

The time zone to use with the at time.

PolicyRuleIndex

pydantic model pypureclient.flashblade.PolicyRuleIndex(*, index: Optional[StrictInt] = None)

field index: Optional[StrictInt] = None

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.

PolicyRuleIndexInPolicy

pydantic model pypureclient.flashblade.PolicyRuleIndexInPolicy(*, index: Optional[StrictInt] = None)

field index: Optional[StrictInt] = None

The index within the policy. The index indicates the order the rules are evaluated.

PolicyRuleObjectAccess

pydantic model pypureclient.flashblade.PolicyRuleObjectAccess(*, name: Optional[StrictStr] = None, context: Optional[Reference] = None, actions: Optional[ConstrainedListValue[StrictStr]] = None, conditions: Optional[PolicyRuleObjectAccessCondition] = None, effect: Optional[StrictStr] = None, policy: Optional[FixedReference] = None, resources: Optional[ConstrainedListValue[StrictStr]] = None)

field actions: Optional[ConstrainedListValue[StrictStr]] = None

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.

field conditions: Optional[PolicyRuleObjectAccessCondition] = None

Conditions used to limit the scope which this rule applies to.

field context: Optional[Reference] = None

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.

field effect: Optional[StrictStr] = None

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.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field policy: Optional[FixedReference] = None

The policy to which this rule belongs.

field resources: Optional[ConstrainedListValue[StrictStr]] = None

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.

PolicyRuleObjectAccessBulkManage

pydantic model pypureclient.flashblade.PolicyRuleObjectAccessBulkManage(*, actions: Optional[ConstrainedListValue[StrictStr]] = None, conditions: Optional[PolicyRuleObjectAccessCondition] = None, effect: Optional[StrictStr] = None, resources: Optional[ConstrainedListValue[StrictStr]] = None, name: Optional[StrictStr] = None)

field actions: Optional[ConstrainedListValue[StrictStr]] = None

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.

field conditions: Optional[PolicyRuleObjectAccessCondition] = None

Conditions used to limit the scope which this rule applies to.

field effect: Optional[StrictStr] = None

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.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field resources: Optional[ConstrainedListValue[StrictStr]] = None

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.

PolicyRuleObjectAccessCondition

pydantic model pypureclient.flashblade.PolicyRuleObjectAccessCondition(*, s3_delimiters: Optional[ConstrainedListValue[StrictStr]] = None, s3_prefixes: Optional[ConstrainedListValue[StrictStr]] = None, source_ips: Optional[ConstrainedListValue[StrictStr]] = None)

field s3_delimiters: Optional[ConstrainedListValue[StrictStr]] = None

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.

field s3_prefixes: Optional[ConstrainedListValue[StrictStr]] = None

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.

field source_ips: Optional[ConstrainedListValue[StrictStr]] = None

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.

PolicyRuleObjectAccessPost

pydantic model pypureclient.flashblade.PolicyRuleObjectAccessPost(*, actions: Optional[ConstrainedListValue[StrictStr]] = None, conditions: Optional[PolicyRuleObjectAccessCondition] = None, effect: Optional[StrictStr] = None, resources: Optional[ConstrainedListValue[StrictStr]] = None)

field actions: Optional[ConstrainedListValue[StrictStr]] = None

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.

field conditions: Optional[PolicyRuleObjectAccessCondition] = None

Conditions used to limit the scope which this rule applies to.

field effect: Optional[StrictStr] = None

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.

field resources: Optional[ConstrainedListValue[StrictStr]] = None

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.

PublicAccessConfig

pydantic model pypureclient.flashblade.PublicAccessConfig(*, block_new_public_policies: Optional[StrictBool] = None, block_public_access: Optional[StrictBool] = None)

Configuration settings related to public access.

field block_new_public_policies: Optional[StrictBool] = None

If set to true, adding bucket policies that grant public access to a bucket is not allowed.

Constraints

• type = boolean

field block_public_access: Optional[StrictBool] = None

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.

Constraints

• type = boolean

PublicKey

pydantic model pypureclient.flashblade.PublicKey(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, public_key: Optional[ConstrainedStrValue] = None, algorithm: Optional[StrictStr] = None, key_size: Optional[StrictInt] = None)

field algorithm: Optional[StrictStr] = None

The cryptographic algorithm used by the key. Valid values include rsa, rsassa-pss, dsa, ec, and ed25519.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field key_size: Optional[StrictInt] = None

The size of the public key in bits.

field name: Optional[StrictStr] = None

A name chosen by the user. Can be changed. Must be locally unique.

field public_key: Optional[ConstrainedStrValue] = None

The text of the public key. May be PEM-formatted or OpenSSH-formatted at the time of input.

Constraints

• maxLength = 5400

PublicKeyGetResponse

pydantic model pypureclient.flashblade.PublicKeyGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[PublicKey]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[PublicKey]] = None

A list of public key objects.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

PublicKeyPost

pydantic model pypureclient.flashblade.PublicKeyPost(*, public_key: Optional[ConstrainedStrValue] = None)

A public key configuration, defining a key used for cryptographic signature verification.

field public_key: Optional[ConstrainedStrValue] = None

The text of the public key. May be PEM-formatted or OpenSSH-formatted at the time of input.

Constraints

• maxLength = 5400

PublicKeyResponse

pydantic model pypureclient.flashblade.PublicKeyResponse(*, items: Optional[ConstrainedListValue[PublicKey]] = None)

field items: Optional[ConstrainedListValue[PublicKey]] = None

A list of public key objects.

PublicKeyUse

pydantic model pypureclient.flashblade.PublicKeyUse(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, use: Optional[FixedReference] = None)

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field use: Optional[FixedReference] = None

A reference to an object using this public key.

PublicKeyUseGetResponse

pydantic model pypureclient.flashblade.PublicKeyUseGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[PublicKeyUse]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[PublicKeyUse]] = None

A list of public key use objects.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

PublicKeyUseResponse

pydantic model pypureclient.flashblade.PublicKeyUseResponse(*, items: Optional[ConstrainedListValue[PublicKeyUse]] = None)

field items: Optional[ConstrainedListValue[PublicKeyUse]] = None

A list of public key use objects.

QosPoliciesGetResponse

pydantic model pypureclient.flashblade.QosPoliciesGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[QosPolicy]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[QosPolicy]] = None

A list of QoS policy objects.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

QosPoliciesResponse

pydantic model pypureclient.flashblade.QosPoliciesResponse(*, items: Optional[ConstrainedListValue[QosPolicy]] = None)

field items: Optional[ConstrainedListValue[QosPolicy]] = None

A list of QoS policy objects.

QosPolicy

pydantic model pypureclient.flashblade.QosPolicy(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, enabled: Optional[StrictBool] = None, is_local: Optional[StrictBool] = None, location: Optional[FixedReference] = None, policy_type: Optional[StrictStr] = None, max_total_bytes_per_sec: Optional[ConstrainedIntValue] = None, max_total_ops_per_sec: Optional[ConstrainedIntValue] = None)

field enabled: Optional[StrictBool] = None

If true, the policy is enabled. If not specified, defaults to true.

Constraints

• type = boolean

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field is_local: Optional[StrictBool] = None

Whether the policy is defined on the local array.

Constraints

• type = boolean

field location: Optional[FixedReference] = None

Reference to the array where the policy is defined.

field max_total_bytes_per_sec: Optional[ConstrainedIntValue] = None

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.

Constraints

• minimum = 1048576

• maximum = 549755813888

field max_total_ops_per_sec: Optional[ConstrainedIntValue] = None

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.

Constraints

• minimum = 100

• maximum = 100000000

field name: Optional[StrictStr] = None

A name chosen by the user. Can be changed. Must be locally unique.

field policy_type: Optional[StrictStr] = None

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.

QuotaSetting

pydantic model pypureclient.flashblade.QuotaSetting(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, contact: Optional[StrictStr] = None, direct_notifications_enabled: Optional[StrictBool] = None)

field contact: Optional[StrictStr] = None

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.

field direct_notifications_enabled: Optional[StrictBool] = None

Are notifications regarding space usage and quotas being sent directly to user and group emails?

Constraints

• type = boolean

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

QuotaSettingGetResponse

pydantic model pypureclient.flashblade.QuotaSettingGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[QuotaSetting]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[QuotaSetting]] = None

A list of quota settings objects.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

QuotaSettingResponse

pydantic model pypureclient.flashblade.QuotaSettingResponse(*, items: Optional[ConstrainedListValue[QuotaSetting]] = None)

field items: Optional[ConstrainedListValue[QuotaSetting]] = None

A list of quota settings objects.

RapidDataLocking

pydantic model pypureclient.flashblade.RapidDataLocking(*, enabled: Optional[StrictBool] = None, kmip_server: Optional[Reference] = None)

field enabled: Optional[StrictBool] = None

True if the Rapid Data Locking feature is enabled.

Constraints

• type = boolean

field kmip_server: Optional[Reference] = None

The KMIP server configuration associated with RDL.

RapidDataLockingResponse

pydantic model pypureclient.flashblade.RapidDataLockingResponse(*, items: Optional[ConstrainedListValue[RapidDataLocking]] = None)

field items: Optional[ConstrainedListValue[RapidDataLocking]] = None

Reference

pydantic model pypureclient.flashblade.Reference(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, resource_type: Optional[StrictStr] = None)

An ordinary (as opposed to built-in) resource that can be created, named, renamed or deleted by the user. This might be a virtual resource (e.g., a volume), or correspond to something in the environment, like a host or a server.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

A name chosen by the user. Can be changed. Must be locally unique.

field resource_type: Optional[StrictStr] = None

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.

ReferenceNameOnly

pydantic model pypureclient.flashblade.ReferenceNameOnly(*, name: Optional[StrictStr] = None)

field name: Optional[StrictStr] = None

ReferenceWritable

pydantic model pypureclient.flashblade.ReferenceWritable(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, resource_type: Optional[StrictStr] = None)

An ordinary (as opposed to built-in) resource that can be created, named, renamed or deleted by the user. This might be a virtual resource (e.g., a volume), or correspond to something in the environment, like a host or a server.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

A name chosen by the user. Can be changed. Must be locally unique.

field resource_type: Optional[StrictStr] = None

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.

RelationshipPerformanceReplication

pydantic model pypureclient.flashblade.RelationshipPerformanceReplication(*, id: Optional[StrictStr] = None, context: Optional[Reference] = None, aggregate: Optional[ReplicationPerformance] = None, continuous: Optional[ContinuousReplicationPerformance] = None, periodic: Optional[ReplicationPerformance] = None, time: Optional[StrictInt] = None)

field aggregate: Optional[ReplicationPerformance] = None

Total bytes transmitted or received per second for all types of replication.

field context: Optional[Reference] = None

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.

field continuous: Optional[ContinuousReplicationPerformance] = None

Object backlog information and total bytes transmitted or received per second for continuous replication. Continuous replication includes object replication.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field periodic: Optional[ReplicationPerformance] = None

Total bytes transmitted or received per second for periodic replication. Periodic replication includes file system replication, which is snapshot based.

field time: Optional[StrictInt] = None

Sample time in milliseconds since UNIX epoch.

RemoteArray

pydantic model pypureclient.flashblade.RemoteArray(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, fleet: Optional[FixedReferenceWithIsLocal] = None, is_local: Optional[StrictBool] = None, model: Optional[StrictStr] = None, os: Optional[StrictStr] = None, version: Optional[StrictStr] = None)

field fleet: Optional[FixedReferenceWithIsLocal] = None

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field is_local: Optional[StrictBool] = None

If set to true, this array is the current array.

Constraints

• type = boolean

field model: Optional[StrictStr] = None

Specifies the array model.

field name: Optional[StrictStr] = None

A name chosen by the user. Can be changed. Must be locally unique.

field os: Optional[StrictStr] = None

Specifies the operating system. Valid values are Purity, Purity//FA, and Purity//FB.

field version: Optional[StrictStr] = None

Specifies the operating system version.

RemoteArraysResponse

pydantic model pypureclient.flashblade.RemoteArraysResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[RemoteArray]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[RemoteArray]] = None

Returns a list of all items after filtering. The values are displayed for each name where meaningful.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

ReplicaLinkBuiltIn

pydantic model pypureclient.flashblade.ReplicaLinkBuiltIn(*, id: Optional[StrictStr] = None, direction: Optional[StrictStr] = None, lag: Optional[StrictInt] = None, status_details: Optional[StrictStr] = None)

field direction: Optional[StrictStr] = None

The direction of replication. Valid values are inbound and outbound.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field lag: Optional[StrictInt] = None

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.

field status_details: Optional[StrictStr] = None

Detailed information about the status of the replica link when it is unhealthy.

ReplicationPerformance

pydantic model pypureclient.flashblade.ReplicationPerformance(*, received_bytes_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, transmitted_bytes_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None)

field received_bytes_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Total bytes received per second.

field transmitted_bytes_per_sec: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

Total bytes transmitted per second.

Resource

pydantic model pypureclient.flashblade.Resource(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None)

An ordinary (as opposed to built-in) resource that can be created, named, renamed or deleted by the user. This might be a virtual resource (e.g., a file system), or correspond to something in the environment, like a network interface.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

A name chosen by the user. Can be changed. Must be locally unique.

ResourceFixedNonUniqueName

pydantic model pypureclient.flashblade.ResourceFixedNonUniqueName(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None)

A resource with a non-unique name.

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified.

field name: Optional[StrictStr] = None

Name of the resource. The name cannot be modified.

ResourcePerformanceReplication

pydantic model pypureclient.flashblade.ResourcePerformanceReplication(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, aggregate: Optional[ReplicationPerformance] = None, continuous: Optional[ContinuousReplicationPerformance] = None, periodic: Optional[ReplicationPerformance] = None, time: Optional[StrictInt] = None)

field aggregate: Optional[ReplicationPerformance] = None

Total bytes transmitted or received per second for all types of replication.

field continuous: Optional[ContinuousReplicationPerformance] = None

Object backlog information and total bytes transmitted or received per second for continuous replication. Continuous replication includes object replication.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field periodic: Optional[ReplicationPerformance] = None

Total bytes transmitted or received per second for periodic replication. Periodic replication includes file system replication, which is snapshot based.

field time: Optional[StrictInt] = None

Sample time in milliseconds since UNIX epoch.

ResourcePerformanceReplicationGetResponse

pydantic model pypureclient.flashblade.ResourcePerformanceReplicationGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[ResourcePerformanceReplication]] = None, total: Optional[ConstrainedListValue[ResourcePerformanceReplication]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[ResourcePerformanceReplication]] = None

field total: Optional[ConstrainedListValue[ResourcePerformanceReplication]] = None

Total of all records after filtering. If total_only query param is true, then no items will be returned.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

Role

pydantic model pypureclient.flashblade.Role(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, permissions: Optional[ConstrainedListValue[Permission]] = None)

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field permissions: Optional[ConstrainedListValue[Permission]] = None

A list of permissions that the role can perform.

RoleGetResponse

pydantic model pypureclient.flashblade.RoleGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Role]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[Role]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

Saml2Sso

pydantic model pypureclient.flashblade.Saml2Sso(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, array_url: Optional[StrictStr] = None, binding: Optional[StrictStr] = None, enabled: Optional[StrictBool] = None, idp: Optional[Saml2SsoIdp] = None, prn: Optional[StrictStr] = None, services: Optional[ConstrainedListValue[StrictStr]] = None, sp: Optional[Saml2SsoSp] = None)

Configuration information for SAML2-based SSO for FlashArray.

field array_url: Optional[StrictStr] = None

The URL of the array.

field binding: Optional[StrictStr] = None

SAML2 binding to use for the request from Flashblade to the Identity Provider. Valid values: http-redirect, none. Defaults to http-redirect.

field enabled: Optional[StrictBool] = None

If set to true, the SAML2 SSO configuration is enabled.

Constraints

• type = boolean

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field idp: Optional[Saml2SsoIdp] = None

field name: Optional[StrictStr] = None

A name chosen by the user. Can be changed. Must be locally unique.

field prn: Optional[StrictStr] = None

Pure Resource Name of the identity provider

field services: Optional[ConstrainedListValue[StrictStr]] = None

Services that the SAML2 SSO authentication is used for. Valid values: management, object. Defaults to management.

field sp: Optional[Saml2SsoSp] = None

Saml2SsoGetResponse

pydantic model pypureclient.flashblade.Saml2SsoGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Saml2Sso]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[Saml2Sso]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

Saml2SsoIdp

pydantic model pypureclient.flashblade.Saml2SsoIdp(*, encrypt_assertion_enabled: Optional[StrictBool] = None, entity_id: Optional[StrictStr] = None, metadata_url: Optional[StrictStr] = None, metadata_url_ca_certificate: Optional[ReferenceWritable] = None, metadata_url_ca_certificate_group: Optional[ReferenceWritable] = None, sign_request_enabled: Optional[StrictBool] = None, url: Optional[StrictStr] = None, verification_certificate: Optional[ReferenceWritable] = None)

Properties specific to the identity provider.

field encrypt_assertion_enabled: Optional[StrictBool] = None

If set to true, SAML assertions will be encrypted by the identity provider.

Constraints

• type = boolean

field entity_id: Optional[StrictStr] = None

A globally unique name for the identity provider.

field metadata_url: Optional[StrictStr] = None

The URL of the identity provider metadata.

field metadata_url_ca_certificate: Optional[ReferenceWritable] = None

CA certificate used to validate the authenticity of the configured Identity Provider server.

field metadata_url_ca_certificate_group: Optional[ReferenceWritable] = None

A certificate group containing CA certificates that can be used to validate the authenticity of the configured Identity Provider server.

field sign_request_enabled: Optional[StrictBool] = None

If set to true, SAML requests will be signed by the service provider.

Constraints

• type = boolean

field url: Optional[StrictStr] = None

The URL of the identity provider.

field verification_certificate: Optional[ReferenceWritable] = None

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.

Saml2SsoPost

pydantic model pypureclient.flashblade.Saml2SsoPost(*, array_url: Optional[StrictStr] = None, binding: Optional[StrictStr] = None, enabled: Optional[StrictBool] = None, idp: Optional[Saml2SsoIdp] = None, prn: Optional[StrictStr] = None, services: Optional[ConstrainedListValue[StrictStr]] = None, sp: Optional[Saml2SsoSp] = None)

field array_url: Optional[StrictStr] = None

The URL of the array.

field binding: Optional[StrictStr] = None

SAML2 binding to use for the request from Flashblade to the Identity Provider. Valid values: http-redirect, none. Defaults to http-redirect.

field enabled: Optional[StrictBool] = None

If set to true, the SAML2 SSO configuration is enabled.

Constraints

• type = boolean

field idp: Optional[Saml2SsoIdp] = None

field prn: Optional[StrictStr] = None

Pure Resource Name of the identity provider

field services: Optional[ConstrainedListValue[StrictStr]] = None

Services that the SAML2 SSO authentication is used for. Valid values: management, object. Defaults to management.

field sp: Optional[Saml2SsoSp] = None

Saml2SsoResponse

pydantic model pypureclient.flashblade.Saml2SsoResponse(*, items: Optional[ConstrainedListValue[Saml2Sso]] = None)

field items: Optional[ConstrainedListValue[Saml2Sso]] = None

Saml2SsoSp

pydantic model pypureclient.flashblade.Saml2SsoSp(*, decryption_credential: Optional[ReferenceWritable] = None, signing_credential: Optional[ReferenceWritable] = None, assertion_consumer_url: Optional[StrictStr] = None, entity_id: Optional[StrictStr] = None, metadata_url: Optional[StrictStr] = None)

field assertion_consumer_url: Optional[StrictStr] = None

The URL where the identity provider will send its SAML response after authenticating a user.

field decryption_credential: Optional[ReferenceWritable] = None

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.

field entity_id: Optional[StrictStr] = None

A globally unique name for the service provider.

field metadata_url: Optional[StrictStr] = None

The URL of the service provider metadata.

field signing_credential: Optional[ReferenceWritable] = None

The credential used by the service provider to sign SAML requests. The credential is managed by the certificates endpoint and purecert CLI commands.

Saml2SsoSpCredential

pydantic model pypureclient.flashblade.Saml2SsoSpCredential(*, decryption_credential: Optional[ReferenceWritable] = None, signing_credential: Optional[ReferenceWritable] = None)

field decryption_credential: Optional[ReferenceWritable] = None

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.

field signing_credential: Optional[ReferenceWritable] = None

The credential used by the service provider to sign SAML requests. The credential is managed by the certificates endpoint and purecert CLI commands.

Server

pydantic model pypureclient.flashblade.Server(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, directory_services: Optional[ConstrainedListValue[Reference]] = None, dns: Optional[ConstrainedListValue[Reference]] = None, created: Optional[StrictInt] = None)

field created: Optional[StrictInt] = None

Creation timestamp of the server.

field directory_services: Optional[ConstrainedListValue[Reference]] = None

The directory service config to be used by this server.

Constraints

• maxItems = 1

field dns: Optional[ConstrainedListValue[Reference]] = None

The DNS config to be used by this server.

Constraints

• maxItems = 1

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

A name chosen by the user. Can be changed. Must be locally unique.

ServerContext

pydantic model pypureclient.flashblade.ServerContext(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, directory_services: Optional[ConstrainedListValue[Reference]] = None, dns: Optional[ConstrainedListValue[Reference]] = None, created: Optional[StrictInt] = None, context: Optional[Reference] = None)

field context: Optional[Reference] = None

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.

field created: Optional[StrictInt] = None

Creation timestamp of the server.

field directory_services: Optional[ConstrainedListValue[Reference]] = None

The directory service config to be used by this server.

Constraints

• maxItems = 1

field dns: Optional[ConstrainedListValue[Reference]] = None

The DNS config to be used by this server.

Constraints

• maxItems = 1

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

A name chosen by the user. Can be changed. Must be locally unique.

ServerGetResponse

pydantic model pypureclient.flashblade.ServerGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[ServerContext]] = None, errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[ServerContext]] = None

A list of server objects.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

ServerPost

pydantic model pypureclient.flashblade.ServerPost(*, directory_services: Optional[ConstrainedListValue[Reference]] = None, dns: Optional[ConstrainedListValue[Reference]] = None)

field directory_services: Optional[ConstrainedListValue[Reference]] = None

The directory service config to be used by this server.

Constraints

• maxItems = 1

field dns: Optional[ConstrainedListValue[Reference]] = None

The DNS config to be used by this server.

Constraints

• maxItems = 1

ServerResponse

pydantic model pypureclient.flashblade.ServerResponse(*, items: Optional[ConstrainedListValue[Server]] = None)

field items: Optional[ConstrainedListValue[Server]] = None

A list of server objects.

ServerResponseContext

pydantic model pypureclient.flashblade.ServerResponseContext(*, items: Optional[ConstrainedListValue[ServerContext]] = None)

field items: Optional[ConstrainedListValue[ServerContext]] = None

A list of server objects.

Session

pydantic model pypureclient.flashblade.Session(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, end_time: Optional[StrictInt] = None, event: Optional[StrictStr] = None, event_count: Optional[StrictInt] = None, identifying_details: Optional[StrictStr] = None, location: Optional[StrictStr] = None, method: Optional[StrictStr] = None, start_time: Optional[StrictInt] = None, user: Optional[StrictStr] = None, user_interface: Optional[StrictStr] = None)

field end_time: Optional[StrictInt] = None

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.

field event: Optional[StrictStr] = None

Description of session events. Valid values include failed authentication, user session, login, logout, API token obtained, and request without session.

field event_count: Optional[StrictInt] = None

Number of session events.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field identifying_details: Optional[StrictStr] = None

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.

field location: Optional[StrictStr] = None

IP address of the user client connecting to the array or console if connected through local console.

field method: Optional[StrictStr] = None

Method by which the user attempted to log in. Valid values include API token, password, ssh certificate, and public key.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field start_time: Optional[StrictInt] = None

Date and time the user logged in to the Purity//FB interface in milliseconds since UNIX epoch.

field user: Optional[StrictStr] = None

Username of the Purity//FB user who triggered the user session event.

field user_interface: Optional[StrictStr] = None

The user interface through which the user session event was performed. Valid values include CLI, GUI, and REST.

SessionGetResponse

pydantic model pypureclient.flashblade.SessionGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Session]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[Session]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

Smb

pydantic model pypureclient.flashblade.Smb(*, client_policy: Optional[ReferenceWritable] = None, continuous_availability_enabled: Optional[StrictBool] = None, enabled: Optional[StrictBool] = None, share_policy: Optional[ReferenceWritable] = None)

field client_policy: Optional[ReferenceWritable] = None

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.

field continuous_availability_enabled: Optional[StrictBool] = None

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.

Constraints

• type = boolean

field enabled: Optional[StrictBool] = None

If set to true, enables access to the file system over the SMB protocol. If not specified, defaults to false.

Constraints

• type = boolean

field share_policy: Optional[ReferenceWritable] = None

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.

SmbClientPolicy

pydantic model pypureclient.flashblade.SmbClientPolicy(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, enabled: Optional[StrictBool] = None, is_local: Optional[StrictBool] = None, location: Optional[FixedReference] = None, policy_type: Optional[StrictStr] = None, version: Optional[StrictStr] = None, context: Optional[Reference] = None, access_based_enumeration_enabled: Optional[StrictBool] = None, rules: Optional[ConstrainedListValue[SmbClientPolicyRuleInPolicy]] = None)

field access_based_enumeration_enabled: Optional[StrictBool] = None

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.

Constraints

• type = boolean

field context: Optional[Reference] = None

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.

field enabled: Optional[StrictBool] = None

If true, the policy is enabled. If not specified, defaults to true.

Constraints

• type = boolean

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field is_local: Optional[StrictBool] = None

Whether the policy is defined on the local array.

Constraints

• type = boolean

field location: Optional[FixedReference] = None

Reference to the array where the policy is defined.

field name: Optional[StrictStr] = None

A name chosen by the user. Can be changed. Must be locally unique.

field policy_type: Optional[StrictStr] = None

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.

field rules: Optional[ConstrainedListValue[SmbClientPolicyRuleInPolicy]] = None

All of the rules that are part of this policy. The order is the evaluation order.

Constraints

• maxItems = 200

field version: Optional[StrictStr] = None

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.

SmbClientPolicyGetResponse

pydantic model pypureclient.flashblade.SmbClientPolicyGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[SmbClientPolicy]] = None, errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[SmbClientPolicy]] = None

A list of SMB Client policy objects.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

SmbClientPolicyPost

pydantic model pypureclient.flashblade.SmbClientPolicyPost(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, enabled: Optional[StrictBool] = None, is_local: Optional[StrictBool] = None, location: Optional[FixedReference] = None, policy_type: Optional[StrictStr] = None, access_based_enumeration_enabled: Optional[StrictBool] = None, rules: Optional[ConstrainedListValue[SmbClientPolicyRulePostInPolicy]] = None)

field access_based_enumeration_enabled: Optional[StrictBool] = None

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.

Constraints

• type = boolean

field enabled: Optional[StrictBool] = None

If true, the policy is enabled. If not specified, defaults to true.

Constraints

• type = boolean

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field is_local: Optional[StrictBool] = None

Whether the policy is defined on the local array.

Constraints

• type = boolean

field location: Optional[FixedReference] = None

Reference to the array where the policy is defined.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field policy_type: Optional[StrictStr] = None

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.

field rules: Optional[ConstrainedListValue[SmbClientPolicyRulePostInPolicy]] = None

All of the rules that are part of this policy. The order is the evaluation order.

Constraints

• maxItems = 200

SmbClientPolicyResponse

pydantic model pypureclient.flashblade.SmbClientPolicyResponse(*, items: Optional[ConstrainedListValue[SmbClientPolicy]] = None)

field items: Optional[ConstrainedListValue[SmbClientPolicy]] = None

A list of SMB Client policy objects.

SmbClientPolicyRule

pydantic model pypureclient.flashblade.SmbClientPolicyRule(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, client: Optional[StrictStr] = None, encryption: Optional[StrictStr] = None, permission: Optional[StrictStr] = None, policy: Optional[FixedReference] = None, policy_version: Optional[StrictStr] = None, index: Optional[StrictInt] = None, context: Optional[Reference] = None)

field client: Optional[StrictStr] = None

Specifies the clients that will be permitted to access the export. Accepted notation is a single IP address, subnet in CIDR notation, or anonymous (*).

field context: Optional[Reference] = None

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.

field encryption: Optional[StrictStr] = None

Specifies whether the remote client is required to use SMB encryption. Valid values are required, disabled, and optional.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field index: Optional[StrictInt] = None

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.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field permission: Optional[StrictStr] = None

Specifies which read-write client access permissions are allowed for the export. Valid values are rw and ro.

field policy: Optional[FixedReference] = None

The policy to which this rule belongs.

field policy_version: Optional[StrictStr] = None

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.

SmbClientPolicyRuleBase

pydantic model pypureclient.flashblade.SmbClientPolicyRuleBase(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, client: Optional[StrictStr] = None, encryption: Optional[StrictStr] = None, permission: Optional[StrictStr] = None, policy: Optional[FixedReference] = None, policy_version: Optional[StrictStr] = None)

field client: Optional[StrictStr] = None

Specifies the clients that will be permitted to access the export. Accepted notation is a single IP address, subnet in CIDR notation, or anonymous (*).

field encryption: Optional[StrictStr] = None

Specifies whether the remote client is required to use SMB encryption. Valid values are required, disabled, and optional.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field permission: Optional[StrictStr] = None

Specifies which read-write client access permissions are allowed for the export. Valid values are rw and ro.

field policy: Optional[FixedReference] = None

The policy to which this rule belongs.

field policy_version: Optional[StrictStr] = None

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.

SmbClientPolicyRuleGetResponse

pydantic model pypureclient.flashblade.SmbClientPolicyRuleGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[SmbClientPolicyRule]] = None, errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[SmbClientPolicyRule]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

SmbClientPolicyRuleInPolicy

pydantic model pypureclient.flashblade.SmbClientPolicyRuleInPolicy(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, client: Optional[StrictStr] = None, encryption: Optional[StrictStr] = None, permission: Optional[StrictStr] = None, policy: Optional[FixedReference] = None, policy_version: Optional[StrictStr] = None, index: Optional[StrictInt] = None)

field client: Optional[StrictStr] = None

Specifies the clients that will be permitted to access the export. Accepted notation is a single IP address, subnet in CIDR notation, or anonymous (*).

field encryption: Optional[StrictStr] = None

Specifies whether the remote client is required to use SMB encryption. Valid values are required, disabled, and optional.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field index: Optional[StrictInt] = None

The index within the policy. The index indicates the order the rules are evaluated.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field permission: Optional[StrictStr] = None

Specifies which read-write client access permissions are allowed for the export. Valid values are rw and ro.

field policy: Optional[FixedReference] = None

The policy to which this rule belongs.

field policy_version: Optional[StrictStr] = None

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.

SmbClientPolicyRulePost

pydantic model pypureclient.flashblade.SmbClientPolicyRulePost(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, client: Optional[StrictStr] = None, encryption: Optional[StrictStr] = None, permission: Optional[StrictStr] = None, index: Optional[StrictInt] = None)

field client: Optional[StrictStr] = None

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.

field encryption: Optional[StrictStr] = None

Specifies whether the remote client is required to use SMB encryption. Valid values are required, disabled, and optional. If not specified, defaults to optional.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field index: Optional[StrictInt] = None

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.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field permission: Optional[StrictStr] = None

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.

SmbClientPolicyRulePostBase

pydantic model pypureclient.flashblade.SmbClientPolicyRulePostBase(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, client: Optional[StrictStr] = None, encryption: Optional[StrictStr] = None, permission: Optional[StrictStr] = None)

field client: Optional[StrictStr] = None

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.

field encryption: Optional[StrictStr] = None

Specifies whether the remote client is required to use SMB encryption. Valid values are required, disabled, and optional. If not specified, defaults to optional.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field permission: Optional[StrictStr] = None

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.

SmbClientPolicyRulePostInPolicy

pydantic model pypureclient.flashblade.SmbClientPolicyRulePostInPolicy(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, client: Optional[StrictStr] = None, encryption: Optional[StrictStr] = None, permission: Optional[StrictStr] = None, index: Optional[StrictInt] = None)

field client: Optional[StrictStr] = None

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.

field encryption: Optional[StrictStr] = None

Specifies whether the remote client is required to use SMB encryption. Valid values are required, disabled, and optional. If not specified, defaults to optional.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field index: Optional[StrictInt] = None

The index within the policy. The index indicates the order the rules are evaluated.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field permission: Optional[StrictStr] = None

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.

SmbClientPolicyRuleResponse

pydantic model pypureclient.flashblade.SmbClientPolicyRuleResponse(*, items: Optional[ConstrainedListValue[SmbClientPolicyRule]] = None)

field items: Optional[ConstrainedListValue[SmbClientPolicyRule]] = None

SmbPost

pydantic model pypureclient.flashblade.SmbPost(*, client_policy: Optional[ReferenceWritable] = None, continuous_availability_enabled: Optional[StrictBool] = None, enabled: Optional[StrictBool] = None, share_policy: Optional[ReferenceWritable] = None)

field client_policy: Optional[ReferenceWritable] = None

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.

field continuous_availability_enabled: Optional[StrictBool] = None

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.

Constraints

• type = boolean

field enabled: Optional[StrictBool] = None

If set to true, enables access to the file system over the SMB protocol. If not specified, defaults to false.

Constraints

• type = boolean

field share_policy: Optional[ReferenceWritable] = None

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.

SmbSharePolicy

pydantic model pypureclient.flashblade.SmbSharePolicy(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, enabled: Optional[StrictBool] = None, is_local: Optional[StrictBool] = None, location: Optional[FixedReference] = None, policy_type: Optional[StrictStr] = None, context: Optional[Reference] = None, rules: Optional[ConstrainedListValue[SmbSharePolicyRule]] = None)

field context: Optional[Reference] = None

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.

field enabled: Optional[StrictBool] = None

If true, the policy is enabled. If not specified, defaults to true.

Constraints

• type = boolean

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field is_local: Optional[StrictBool] = None

Whether the policy is defined on the local array.

Constraints

• type = boolean

field location: Optional[FixedReference] = None

Reference to the array where the policy is defined.

field name: Optional[StrictStr] = None

A name chosen by the user. Can be changed. Must be locally unique.

field policy_type: Optional[StrictStr] = None

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.

field rules: Optional[ConstrainedListValue[SmbSharePolicyRule]] = None

All of the rules that are part of this policy.

Constraints

• maxItems = 200

SmbSharePolicyGetResponse

pydantic model pypureclient.flashblade.SmbSharePolicyGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[SmbSharePolicy]] = None, errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[SmbSharePolicy]] = None

A list of SMB Share policy objects.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

SmbSharePolicyPost

pydantic model pypureclient.flashblade.SmbSharePolicyPost(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, enabled: Optional[StrictBool] = None, is_local: Optional[StrictBool] = None, location: Optional[FixedReference] = None, policy_type: Optional[StrictStr] = None, rules: Optional[ConstrainedListValue[SmbSharePolicyRulePost]] = None)

field enabled: Optional[StrictBool] = None

If true, the policy is enabled. If not specified, defaults to true.

Constraints

• type = boolean

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field is_local: Optional[StrictBool] = None

Whether the policy is defined on the local array.

Constraints

• type = boolean

field location: Optional[FixedReference] = None

Reference to the array where the policy is defined.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field policy_type: Optional[StrictStr] = None

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.

field rules: Optional[ConstrainedListValue[SmbSharePolicyRulePost]] = None

All of the rules that are part of this policy.

Constraints

• maxItems = 200

SmbSharePolicyResponse

pydantic model pypureclient.flashblade.SmbSharePolicyResponse(*, items: Optional[ConstrainedListValue[SmbSharePolicy]] = None)

field items: Optional[ConstrainedListValue[SmbSharePolicy]] = None

A list of SMB Share policy objects.

SmbSharePolicyRule

pydantic model pypureclient.flashblade.SmbSharePolicyRule(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, change: Optional[StrictStr] = None, full_control: Optional[StrictStr] = None, policy: Optional[FixedReference] = None, principal: Optional[StrictStr] = None, read: Optional[StrictStr] = None)

field change: Optional[StrictStr] = None

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.

field full_control: Optional[StrictStr] = None

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.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field policy: Optional[FixedReference] = None

The policy to which this rule belongs.

field principal: Optional[StrictStr] = None

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.

field read: Optional[StrictStr] = None

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.

SmbSharePolicyRuleGetResponse

pydantic model pypureclient.flashblade.SmbSharePolicyRuleGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[SmbSharePolicyRuleWithContext]] = None, errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[SmbSharePolicyRuleWithContext]] = None

A list of SMB Share policy rule objects.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

SmbSharePolicyRulePost

pydantic model pypureclient.flashblade.SmbSharePolicyRulePost(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, change: Optional[StrictStr] = None, full_control: Optional[StrictStr] = None, principal: Optional[StrictStr] = None, read: Optional[StrictStr] = None)

field change: Optional[StrictStr] = None

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.

field full_control: Optional[StrictStr] = None

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.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field principal: Optional[StrictStr] = None

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.

field read: Optional[StrictStr] = None

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.

SmbSharePolicyRuleResponse

pydantic model pypureclient.flashblade.SmbSharePolicyRuleResponse(*, items: Optional[ConstrainedListValue[SmbSharePolicyRuleWithContext]] = None)

field items: Optional[ConstrainedListValue[SmbSharePolicyRuleWithContext]] = None

A list of SMB Share policy rule objects.

SmbSharePolicyRuleWithContext

pydantic model pypureclient.flashblade.SmbSharePolicyRuleWithContext(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, change: Optional[StrictStr] = None, full_control: Optional[StrictStr] = None, policy: Optional[FixedReference] = None, principal: Optional[StrictStr] = None, read: Optional[StrictStr] = None, context: Optional[Reference] = None)

field change: Optional[StrictStr] = None

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.

field context: Optional[Reference] = None

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.

field full_control: Optional[StrictStr] = None

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.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field policy: Optional[FixedReference] = None

The policy to which this rule belongs.

field principal: Optional[StrictStr] = None

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.

field read: Optional[StrictStr] = None

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.

SmtpServer

pydantic model pypureclient.flashblade.SmtpServer(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, encryption_mode: Optional[StrictStr] = None, relay_host: Optional[StrictStr] = None, sender_domain: Optional[StrictStr] = None)

field encryption_mode: Optional[StrictStr] = None

Enforces an encryption mode when sending alert email messages. Valid values include starttls. Use “” to clear.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field relay_host: Optional[StrictStr] = None

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.

field sender_domain: Optional[StrictStr] = None

Domain name appended to alert email messages.

SmtpServerGetResponse

pydantic model pypureclient.flashblade.SmtpServerGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[SmtpServer]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[SmtpServer]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

SmtpServerResponse

pydantic model pypureclient.flashblade.SmtpServerResponse(*, items: Optional[ConstrainedListValue[SmtpServer]] = None)

field items: Optional[ConstrainedListValue[SmtpServer]] = None

SnmpAgent

pydantic model pypureclient.flashblade.SnmpAgent(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, engine_id: Optional[ConstrainedStrValue] = None, v2c: Optional[SnmpV2c] = None, v3: Optional[SnmpV3] = None, version: Optional[StrictStr] = None)

field engine_id: Optional[ConstrainedStrValue] = None

An SNMP agent’s adminstration domain unique name.

Constraints

• maxLength = 32

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field v2c: Optional[SnmpV2c] = None

field v3: Optional[SnmpV3] = None

field version: Optional[StrictStr] = None

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.

SnmpAgentGetResponse

pydantic model pypureclient.flashblade.SnmpAgentGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[SnmpAgent]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[SnmpAgent]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

SnmpAgentMib

pydantic model pypureclient.flashblade.SnmpAgentMib(*, mib: Optional[StrictStr] = None)

field mib: Optional[StrictStr] = None

MIB text.

SnmpAgentMibResponse

pydantic model pypureclient.flashblade.SnmpAgentMibResponse(*, items: Optional[ConstrainedListValue[SnmpAgentMib]] = None)

field items: Optional[ConstrainedListValue[SnmpAgentMib]] = None

SnmpAgentResponse

pydantic model pypureclient.flashblade.SnmpAgentResponse(*, items: Optional[ConstrainedListValue[SnmpAgent]] = None)

field items: Optional[ConstrainedListValue[SnmpAgent]] = None

SnmpManager

pydantic model pypureclient.flashblade.SnmpManager(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, host: Optional[StrictStr] = None, notification: Optional[StrictStr] = None, v2c: Optional[SnmpV2c] = None, v3: Optional[SnmpV3] = None, version: Optional[StrictStr] = None)

field host: Optional[StrictStr] = None

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.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

A name chosen by the user. Can be changed. Must be locally unique.

field notification: Optional[StrictStr] = None

The type of notification the agent will send. Valid values are inform and trap.

field v2c: Optional[SnmpV2c] = None

field v3: Optional[SnmpV3] = None

field version: Optional[StrictStr] = None

Version of the SNMP protocol to be used by Purity in communications with the specified manager. Valid values are v2c and v3.

SnmpManagerGetResponse

pydantic model pypureclient.flashblade.SnmpManagerGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[SnmpManager]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[SnmpManager]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

SnmpManagerPost

pydantic model pypureclient.flashblade.SnmpManagerPost(*, host: Optional[StrictStr] = None, notification: Optional[StrictStr] = None, v2c: Optional[SnmpV2c] = None, v3: Optional[SnmpV3Post] = None, version: Optional[StrictStr] = None)

field host: Optional[StrictStr] = None

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.

field notification: Optional[StrictStr] = None

The type of notification the agent will send. Valid values are inform and trap.

field v2c: Optional[SnmpV2c] = None

field v3: Optional[SnmpV3Post] = None

field version: Optional[StrictStr] = None

Version of the SNMP protocol to be used by Purity in communications with the specified manager. Valid values are v2c and v3.

SnmpManagerResponse

pydantic model pypureclient.flashblade.SnmpManagerResponse(*, items: Optional[ConstrainedListValue[SnmpManager]] = None)

field items: Optional[ConstrainedListValue[SnmpManager]] = None

SnmpManagerTest

pydantic model pypureclient.flashblade.SnmpManagerTest(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, error: Optional[StrictStr] = None, sent: Optional[StrictBool] = None)

field error: Optional[StrictStr] = None

Error message (if failed).

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field sent: Optional[StrictBool] = None

Is the test trap or inform sent?

Constraints

• type = boolean

SnmpV2c

pydantic model pypureclient.flashblade.SnmpV2c(*, community: Optional[ConstrainedStrValue] = None)

The v2c configurations of SNMP.

field community: Optional[ConstrainedStrValue] = None

Manager community ID under which Purity is to communicate with the specified managers.

Constraints

• maxLength = 32

SnmpV3

pydantic model pypureclient.flashblade.SnmpV3(*, auth_passphrase: Optional[StrictStr] = None, auth_protocol: Optional[StrictStr] = None, privacy_passphrase: Optional[StrictStr] = None, privacy_protocol: Optional[StrictStr] = None, user: Optional[StrictStr] = None)

The v3 configurations of SNMP.

field auth_passphrase: Optional[StrictStr] = None

Passphrase used by Purity to authenticate the array with the specified managers.

field auth_protocol: Optional[StrictStr] = None

Hash algorithm used to validate the authentication passphrase. Valid values are MD5 and SHA.

field privacy_passphrase: Optional[StrictStr] = None

Passphrase used to encrypt SNMP messages.

field privacy_protocol: Optional[StrictStr] = None

Encryption protocol for SNMP messages. Valid values are AES and DES.

field user: Optional[StrictStr] = None

User ID recognized by the specified SNMP managers which Purity is to use in communications with them.

SnmpV3Post

pydantic model pypureclient.flashblade.SnmpV3Post(*, auth_passphrase: Optional[ConstrainedStrValue] = None, auth_protocol: Optional[StrictStr] = None, privacy_passphrase: Optional[ConstrainedStrValue] = None, privacy_protocol: Optional[StrictStr] = None, user: Optional[StrictStr] = None)

The v3 configurations of SNMP.

field auth_passphrase: Optional[ConstrainedStrValue] = None

Passphrase used by Purity to authenticate the array with the specified managers.

Constraints

• maxLength = 32

field auth_protocol: Optional[StrictStr] = None

Hash algorithm used to validate the authentication passphrase. Valid values are MD5 and SHA.

field privacy_passphrase: Optional[ConstrainedStrValue] = None

Passphrase used to encrypt SNMP messages.

Constraints

• minLength = 8

• maxLength = 63

field privacy_protocol: Optional[StrictStr] = None

Encryption protocol for SNMP messages. Valid values are AES and DES.

field user: Optional[StrictStr] = None

User ID recognized by the specified SNMP managers which Purity is to use in communications with them.

SoftwareCheck

pydantic model pypureclient.flashblade.SoftwareCheck(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, end_time: Optional[StrictInt] = None, start_time: Optional[StrictInt] = None, checks: Optional[ConstrainedListValue[SoftwareChecksChecks]] = None, details: Optional[StrictStr] = None, software_name: Optional[StrictStr] = None, software_upgrade_hops: Optional[ConstrainedListValue[StrictStr]] = None, software_version: Optional[StrictStr] = None, status: Optional[StrictStr] = None)

field checks: Optional[ConstrainedListValue[SoftwareChecksChecks]] = None

A list of checks in this check task.

field details: Optional[StrictStr] = None

The detailed reason for the status.

field end_time: Optional[StrictInt] = None

End time in milliseconds since the UNIX epoch.

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified.

field name: Optional[StrictStr] = None

Name of the resource. The name cannot be modified.

field software_name: Optional[StrictStr] = None

The name of the software the upgrade checks will test.

field software_upgrade_hops: Optional[ConstrainedListValue[StrictStr]] = None

The list of software versions the upgrade goes through. The upgrade checks also test this particular path.

field software_version: Optional[StrictStr] = None

The version of the software that the upgrade checks will test.

field start_time: Optional[StrictInt] = None

Start time in milliseconds since the UNIX epoch.

field status: Optional[StrictStr] = None

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.

SoftwareChecksChecks

pydantic model pypureclient.flashblade.SoftwareChecksChecks(*, details: Optional[StrictStr] = None, name: Optional[StrictStr] = None, status: Optional[StrictStr] = None)

field details: Optional[StrictStr] = None

Detailed result of the check used to diagnose check failures.

field name: Optional[StrictStr] = None

Name of the upgrade check.

field status: Optional[StrictStr] = None

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.

SoftwareChecksGetResponse

pydantic model pypureclient.flashblade.SoftwareChecksGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[SoftwareCheck]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[SoftwareCheck]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

SoftwareChecksResponse

pydantic model pypureclient.flashblade.SoftwareChecksResponse(*, items: Optional[ConstrainedListValue[SoftwareCheck]] = None)

field items: Optional[ConstrainedListValue[SoftwareCheck]] = None

Space

pydantic model pypureclient.flashblade.Space(*, available_provisioned: Optional[ConstrainedIntValue] = None, available_ratio: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, data_reduction: Optional[Union[StrictFloat, StrictInt]] = None, destroyed: Optional[StrictInt] = None, destroyed_virtual: Optional[StrictInt] = None, shared: Optional[StrictInt] = None, snapshots: Optional[StrictInt] = None, total_physical: Optional[ConstrainedIntValue] = None, total_provisioned: Optional[ConstrainedIntValue] = None, total_used: Optional[ConstrainedIntValue] = None, unique: Optional[StrictInt] = None, virtual: Optional[StrictInt] = None)

field available_provisioned: Optional[ConstrainedIntValue] = None

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.

Constraints

• minimum = 0

field available_ratio: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

The ratio of the available space versus the total provisioned space.

field data_reduction: Optional[Union[StrictFloat, StrictInt]] = None

Reduction of data.

field destroyed: Optional[StrictInt] = None

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.

field destroyed_virtual: Optional[StrictInt] = None

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.

field shared: Optional[StrictInt] = None

The space contributed by data that is not unique to a managed directory, or snapshot, measured in bytes.

field snapshots: Optional[StrictInt] = None

Physical usage by snapshots, other than unique in bytes.

field total_physical: Optional[ConstrainedIntValue] = None

Deprecated. See total_used for the newer functionality. The total physical space consumed by the file system, measured in bytes.

Constraints

• minimum = 0

field total_provisioned: Optional[ConstrainedIntValue] = None

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.

Constraints

• minimum = 0

field total_used: Optional[ConstrainedIntValue] = None

The total space consumed by customer data, measured in bytes.

Constraints

• minimum = 0

field unique: Optional[StrictInt] = None

Unique physical space occupied by customer data, in bytes. Excludes snapshots, destroyed.

field virtual: Optional[StrictInt] = None

The amount of logically written data, in bytes. Excludes destroyed data.

SshCertificateAuthorityPolicy

pydantic model pypureclient.flashblade.SshCertificateAuthorityPolicy(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, enabled: Optional[StrictBool] = None, is_local: Optional[StrictBool] = None, location: Optional[FixedReference] = None, policy_type: Optional[StrictStr] = None, signing_authority: Optional[ReferenceWritable] = None, static_authorized_principals: Optional[ConstrainedListValue[ConstrainedStrValue]] = None)

field enabled: Optional[StrictBool] = None

If true, the policy is enabled. If not specified, defaults to true.

Constraints

• type = boolean

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field is_local: Optional[StrictBool] = None

Whether the policy is defined on the local array.

Constraints

• type = boolean

field location: Optional[FixedReference] = None

Reference to the array where the policy is defined.

field name: Optional[StrictStr] = None

A name chosen by the user. Can be changed. Must be locally unique.

field policy_type: Optional[StrictStr] = None

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.

field signing_authority: Optional[ReferenceWritable] = None

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.

field static_authorized_principals: Optional[ConstrainedListValue[ConstrainedStrValue]] = None

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.

Constraints

• maxItems = 16

SshCertificateAuthorityPolicyGetResponse

pydantic model pypureclient.flashblade.SshCertificateAuthorityPolicyGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[SshCertificateAuthorityPolicy]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[SshCertificateAuthorityPolicy]] = None

A list of SSH certificate authority policy objects.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

SshCertificateAuthorityPolicyPost

pydantic model pypureclient.flashblade.SshCertificateAuthorityPolicyPost(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, enabled: Optional[StrictBool] = None, is_local: Optional[StrictBool] = None, location: Optional[FixedReference] = None, policy_type: Optional[StrictStr] = None, signing_authority: Optional[ReferenceWritable] = None, static_authorized_principals: Optional[ConstrainedListValue[ConstrainedStrValue]] = None)

field enabled: Optional[StrictBool] = None

If true, the policy is enabled. If not specified, defaults to true.

Constraints

• type = boolean

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field is_local: Optional[StrictBool] = None

Whether the policy is defined on the local array.

Constraints

• type = boolean

field location: Optional[FixedReference] = None

Reference to the array where the policy is defined.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field policy_type: Optional[StrictStr] = None

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.

field signing_authority: Optional[ReferenceWritable] = None

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.

field static_authorized_principals: Optional[ConstrainedListValue[ConstrainedStrValue]] = None

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.

Constraints

• maxItems = 16

SshCertificateAuthorityPolicyResponse

pydantic model pypureclient.flashblade.SshCertificateAuthorityPolicyResponse(*, items: Optional[ConstrainedListValue[SshCertificateAuthorityPolicy]] = None)

field items: Optional[ConstrainedListValue[SshCertificateAuthorityPolicy]] = None

A list of SSH certificate authority policy objects.

StartEndTime

pydantic model pypureclient.flashblade.StartEndTime(*, end_time: Optional[StrictInt] = None, start_time: Optional[StrictInt] = None)

A resource with a start time and end time.

field end_time: Optional[StrictInt] = None

End time in milliseconds since the UNIX epoch.

field start_time: Optional[StrictInt] = None

Start time in milliseconds since the UNIX epoch.

StorageClassInfo

pydantic model pypureclient.flashblade.StorageClassInfo(*, name: Optional[StrictStr] = None, status: Optional[StrictStr] = None, status_details: Optional[StrictStr] = None)

field name: Optional[StrictStr] = None

field status: Optional[StrictStr] = None

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.

field status_details: Optional[StrictStr] = None

Additional details about the status of the transition. If there is no transition ongoing, this field will be null.

StorageClassSpace

pydantic model pypureclient.flashblade.StorageClassSpace(*, name: Optional[StrictStr] = None, capacity: Optional[StrictInt] = None, space: Optional[Space] = None, time: Optional[StrictInt] = None)

field capacity: Optional[StrictInt] = None

Usable capacity in bytes.

field name: Optional[StrictStr] = None

field space: Optional[Space] = None

field time: Optional[StrictInt] = None

Sample time in milliseconds since UNIX epoch.

Subnet

pydantic model pypureclient.flashblade.Subnet(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, enabled: Optional[StrictBool] = None, gateway: Optional[StrictStr] = None, interfaces: Optional[ConstrainedListValue[FixedReference]] = None, link_aggregation_group: Optional[Reference] = None, mtu: Optional[ConstrainedIntValue] = None, prefix: Optional[StrictStr] = None, services: Optional[ConstrainedListValue[StrictStr]] = None, vlan: Optional[StrictInt] = None)

field enabled: Optional[StrictBool] = None

Indicates if subnet is enabled (true) or disabled (false). If not specified, defaults to true.

Constraints

• type = boolean

field gateway: Optional[StrictStr] = None

The IPv4 or IPv6 address of the gateway through which the specified subnet is to communicate with the network.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field interfaces: Optional[ConstrainedListValue[FixedReference]] = None

List of network interfaces associated with this subnet.

field link_aggregation_group: Optional[Reference] = None

Reference to the associated LAG.

field mtu: Optional[ConstrainedIntValue] = None

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.

Constraints

• minimum = 1280

• maximum = 9216

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field prefix: Optional[StrictStr] = None

The IPv4 or IPv6 address to be associated with the specified subnet.

field services: Optional[ConstrainedListValue[StrictStr]] = None

The services provided by this subnet, as inherited from all of its interfaces.

field vlan: Optional[StrictInt] = None

VLAN ID.

SubnetGetResponse

pydantic model pypureclient.flashblade.SubnetGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Subnet]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[Subnet]] = None

A list of subnet objects.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

SubnetResponse

pydantic model pypureclient.flashblade.SubnetResponse(*, items: Optional[ConstrainedListValue[Subnet]] = None)

field items: Optional[ConstrainedListValue[Subnet]] = None

A list of subnet objects.

Support

pydantic model pypureclient.flashblade.Support(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, phonehome_enabled: Optional[StrictBool] = None, proxy: Optional[StrictStr] = None, remote_assist_active: Optional[StrictBool] = None, remote_assist_duration: Optional[StrictInt] = None, remote_assist_expires: Optional[StrictStr] = None, remote_assist_opened: Optional[StrictStr] = None, remote_assist_paths: Optional[ConstrainedListValue[SupportRemoteAssistPaths]] = None, remote_assist_status: Optional[StrictStr] = None)

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field phonehome_enabled: Optional[StrictBool] = None

Constraints

• type = boolean

field proxy: Optional[StrictStr] = None

field remote_assist_active: Optional[StrictBool] = None

The switch to open all remote-assist sessions.

Constraints

• type = boolean

field remote_assist_duration: Optional[StrictInt] = None

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.

field remote_assist_expires: Optional[StrictStr] = None

The time when the session expires.

field remote_assist_opened: Optional[StrictStr] = None

The time when the session opened.

field remote_assist_paths: Optional[ConstrainedListValue[SupportRemoteAssistPaths]] = None

field remote_assist_status: Optional[StrictStr] = None

The status of the remote-assist sessions. Valid values are connected, partially_connected, reconnecting, and disconnected.

SupportDiagnostics

pydantic model pypureclient.flashblade.SupportDiagnostics(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, analysis_period: Optional[StartEndTime] = None, index: Optional[StrictInt] = None, severity_count: Optional[ConstrainedListValue[SupportDiagnosticsSeverityCount]] = None, start_time: Optional[StrictInt] = None, status: Optional[StrictStr] = None, task_id: Optional[StrictStr] = None, version: Optional[StrictStr] = None)

field analysis_period: Optional[StartEndTime] = None

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field index: Optional[StrictInt] = None

The unique index of the task.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field severity_count: Optional[ConstrainedListValue[SupportDiagnosticsSeverityCount]] = None

List of severity counts.

field start_time: Optional[StrictInt] = None

Start time in milliseconds since the UNIX epoch.

field status: Optional[StrictStr] = None

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.

field task_id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified.

field version: Optional[StrictStr] = None

Version of diagnostics tool.

SupportDiagnosticsDetails

pydantic model pypureclient.flashblade.SupportDiagnosticsDetails(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, index: Optional[Union[StrictFloat, StrictInt]] = None, result_details: Optional[StrictStr] = None, severity: Optional[StrictStr] = None, task_id: Optional[StrictStr] = None, test_name: Optional[StrictStr] = None, test_type: Optional[StrictStr] = None)

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field index: Optional[Union[StrictFloat, StrictInt]] = None

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.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field result_details: Optional[StrictStr] = None

More details related to the test. This field can provide remediation information as well.

field severity: Optional[StrictStr] = None

Severity level of the test. Valid values include info, warning, critical.

field task_id: Optional[StrictStr] = None

The task ID of the diagnostics for which this refers to.

field test_name: Optional[StrictStr] = None

Name of the test that was performed.

field test_type: Optional[StrictStr] = None

Category to which the test belongs to.

SupportDiagnosticsDetailsGetResponse

pydantic model pypureclient.flashblade.SupportDiagnosticsDetailsGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[SupportDiagnosticsDetails]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[SupportDiagnosticsDetails]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

SupportDiagnosticsDetailsResponse

pydantic model pypureclient.flashblade.SupportDiagnosticsDetailsResponse(*, items: Optional[ConstrainedListValue[SupportDiagnosticsDetails]] = None)

field items: Optional[ConstrainedListValue[SupportDiagnosticsDetails]] = None

SupportDiagnosticsGetResponse

pydantic model pypureclient.flashblade.SupportDiagnosticsGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[SupportDiagnostics]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[SupportDiagnostics]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

SupportDiagnosticsResponse

pydantic model pypureclient.flashblade.SupportDiagnosticsResponse(*, items: Optional[ConstrainedListValue[SupportDiagnostics]] = None)

field items: Optional[ConstrainedListValue[SupportDiagnostics]] = None

SupportDiagnosticsSeverityCount

pydantic model pypureclient.flashblade.SupportDiagnosticsSeverityCount(*, count: Optional[StrictInt] = None, severity: Optional[StrictStr] = None)

field count: Optional[StrictInt] = None

Count of the corresponding severity.

field severity: Optional[StrictStr] = None

Severity level of the test. Valid values include info, warning, critical.

SupportGetResponse

pydantic model pypureclient.flashblade.SupportGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Support]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[Support]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

SupportRemoteAssistPaths

pydantic model pypureclient.flashblade.SupportRemoteAssistPaths(*, component_name: Optional[StrictStr] = None, status: Optional[StrictStr] = None)

field component_name: Optional[StrictStr] = None

The name of the FM.

field status: Optional[StrictStr] = None

The status of the remote-assist session on the local FM. Valid values are reconnecting, connected, disconnected, and unknown.

SupportResponse

pydantic model pypureclient.flashblade.SupportResponse(*, items: Optional[ConstrainedListValue[Support]] = None)

field items: Optional[ConstrainedListValue[Support]] = None

SyslogServer

pydantic model pypureclient.flashblade.SyslogServer(*, uri: Optional[StrictStr] = None, services: Optional[ConstrainedListValue[StrictStr]] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None)

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

A name chosen by the user. Can be changed. Must be locally unique.

field services: Optional[ConstrainedListValue[StrictStr]] = None

Valid values are data-audit and management. If not specified, defaults to management.

field uri: Optional[StrictStr] = None

The URI of the syslog server in the format PROTOCOL://HOSTNAME:PORT.

SyslogServerContext

pydantic model pypureclient.flashblade.SyslogServerContext(*, uri: Optional[StrictStr] = None, services: Optional[ConstrainedListValue[StrictStr]] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, context: Optional[Reference] = None)

field context: Optional[Reference] = None

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.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

A name chosen by the user. Can be changed. Must be locally unique.

field services: Optional[ConstrainedListValue[StrictStr]] = None

Valid values are data-audit and management. If not specified, defaults to management.

field uri: Optional[StrictStr] = None

The URI of the syslog server in the format PROTOCOL://HOSTNAME:PORT.

SyslogServerContextResponse

pydantic model pypureclient.flashblade.SyslogServerContextResponse(*, items: Optional[ConstrainedListValue[SyslogServerContext]] = None)

field items: Optional[ConstrainedListValue[SyslogServerContext]] = None

SyslogServerGetResponse

pydantic model pypureclient.flashblade.SyslogServerGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[SyslogServerContext]] = None, errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[SyslogServerContext]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

SyslogServerPatch

pydantic model pypureclient.flashblade.SyslogServerPatch(*, uri: Optional[StrictStr] = None, services: Optional[ConstrainedListValue[StrictStr]] = None)

field services: Optional[ConstrainedListValue[StrictStr]] = None

Valid values are data-audit and management.

field uri: Optional[StrictStr] = None

The URI of the syslog server in the format PROTOCOL://HOSTNAME:PORT.

SyslogServerPost

pydantic model pypureclient.flashblade.SyslogServerPost(*, uri: Optional[StrictStr] = None, services: Optional[ConstrainedListValue[StrictStr]] = None)

field services: Optional[ConstrainedListValue[StrictStr]] = None

Valid values are data-audit and management. If not specified, defaults to management.

field uri: Optional[StrictStr] = None

The URI of the syslog server in the format PROTOCOL://HOSTNAME:PORT.

SyslogServerPostOrPatch

pydantic model pypureclient.flashblade.SyslogServerPostOrPatch(*, uri: Optional[StrictStr] = None)

A syslog server

field uri: Optional[StrictStr] = None

The URI of the syslog server in the format PROTOCOL://HOSTNAME:PORT.

SyslogServerResponse

pydantic model pypureclient.flashblade.SyslogServerResponse(*, items: Optional[ConstrainedListValue[SyslogServer]] = None)

field items: Optional[ConstrainedListValue[SyslogServer]] = None

SyslogServerSettings

pydantic model pypureclient.flashblade.SyslogServerSettings(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, ca_certificate: Optional[Dict[str, Any]] = None, ca_certificate_group: Optional[Dict[str, Any]] = None)

field ca_certificate: Optional[Dict[str, Any]] = None

field ca_certificate_group: Optional[Dict[str, Any]] = None

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

SyslogServerSettingsGetResponse

pydantic model pypureclient.flashblade.SyslogServerSettingsGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[SyslogServerSettings]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[SyslogServerSettings]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

SyslogServerSettingsResponse

pydantic model pypureclient.flashblade.SyslogServerSettingsResponse(*, items: Optional[ConstrainedListValue[SyslogServerSettings]] = None)

field items: Optional[ConstrainedListValue[SyslogServerSettings]] = None

Target

pydantic model pypureclient.flashblade.Target(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, address: Optional[StrictStr] = None, ca_certificate_group: Optional[FixedReference] = None, status: Optional[StrictStr] = None, status_details: Optional[StrictStr] = None)

field address: Optional[StrictStr] = None

IP address or FQDN of the target system.

field ca_certificate_group: Optional[FixedReference] = None

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.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

A name chosen by the user. Can be changed. Must be locally unique.

field status: Optional[StrictStr] = None

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.

field status_details: Optional[StrictStr] = None

Additional information describing any issues encountered when connecting, or null if the status is connected.

TargetGetResponse

pydantic model pypureclient.flashblade.TargetGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[TargetWithContext]] = None, errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[TargetWithContext]] = None

A list of target objects.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

TargetPost

pydantic model pypureclient.flashblade.TargetPost(*, address: Optional[StrictStr] = None)

field address: Optional[StrictStr] = None

IP address or FQDN of the target system.

TargetResponse

pydantic model pypureclient.flashblade.TargetResponse(*, items: Optional[ConstrainedListValue[Target]] = None)

field items: Optional[ConstrainedListValue[Target]] = None

A list of target objects.

TargetResponseContext

pydantic model pypureclient.flashblade.TargetResponseContext(*, items: Optional[ConstrainedListValue[TargetWithContext]] = None)

field items: Optional[ConstrainedListValue[TargetWithContext]] = None

A list of target objects.

TargetWithContext

pydantic model pypureclient.flashblade.TargetWithContext(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, address: Optional[StrictStr] = None, ca_certificate_group: Optional[FixedReference] = None, status: Optional[StrictStr] = None, status_details: Optional[StrictStr] = None, context: Optional[Reference] = None)

field address: Optional[StrictStr] = None

IP address or FQDN of the target system.

field ca_certificate_group: Optional[FixedReference] = None

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.

field context: Optional[Reference] = None

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.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field name: Optional[StrictStr] = None

A name chosen by the user. Can be changed. Must be locally unique.

field status: Optional[StrictStr] = None

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.

field status_details: Optional[StrictStr] = None

Additional information describing any issues encountered when connecting, or null if the status is connected.

TestResult

pydantic model pypureclient.flashblade.TestResult(*, component_address: Optional[StrictStr] = None, component_name: Optional[StrictStr] = None, description: Optional[StrictStr] = None, destination: Optional[StrictStr] = None, enabled: Optional[StrictBool] = None, resource: Optional[FixedReference] = None, result_details: Optional[StrictStr] = None, success: Optional[StrictBool] = None, test_type: Optional[StrictStr] = None)

field component_address: Optional[StrictStr] = None

Address of the component running the test.

field component_name: Optional[StrictStr] = None

Name of the component running the test.

field description: Optional[StrictStr] = None

What the test is doing.

field destination: Optional[StrictStr] = None

The URI of the target server being tested.

field enabled: Optional[StrictBool] = None

Is the service enabled or not?

Constraints

• type = boolean

field resource: Optional[FixedReference] = None

A reference to the object being tested.

field result_details: Optional[StrictStr] = None

Additional information about the test result.

field success: Optional[StrictBool] = None

Returns a value of true if the specified test succeeded. Returns a value of false if the specified test failed.

Constraints

• type = boolean

field test_type: Optional[StrictStr] = None

Displays the type of test being performed. The returned values are determined by the resource being tested and its configuration.

TestResultGetResponse

pydantic model pypureclient.flashblade.TestResultGetResponse(*, items: Optional[ConstrainedListValue[TestResult]] = None, total_item_count: Optional[StrictInt] = None)

field items: Optional[ConstrainedListValue[TestResult]] = None

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

TestResultResponse

pydantic model pypureclient.flashblade.TestResultResponse(*, items: Optional[ConstrainedListValue[TestResult]] = None)

field items: Optional[ConstrainedListValue[TestResult]] = None

Throttle

pydantic model pypureclient.flashblade.Throttle(*, default_limit: Optional[StrictInt] = None, window: Optional[TimeWindow] = None, window_limit: Optional[StrictInt] = None)

The bandwidth throttling for an array connection or target.

field default_limit: Optional[StrictInt] = None

Default maximum bandwidth threshold for outbound traffic in bytes. Once exceeded, bandwidth throttling occurs.

field window: Optional[TimeWindow] = None

The time during which the window_limit threshold is in effect.

field window_limit: Optional[StrictInt] = None

Maximum bandwidth threshold for outbound traffic during the specified window_limit time range in bytes. Once exceeded, bandwidth throttling occurs.

TimeWindow

pydantic model pypureclient.flashblade.TimeWindow(*, end: Optional[StrictInt] = None, start: Optional[StrictInt] = None)

field end: Optional[StrictInt] = None

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).

field start: Optional[StrictInt] = None

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).

TimeZone

pydantic model pypureclient.flashblade.TimeZone(*, name: Optional[StrictStr] = None)

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

TlsPolicy

pydantic model pypureclient.flashblade.TlsPolicy(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, enabled: Optional[StrictBool] = None, is_local: Optional[StrictBool] = None, location: Optional[FixedReference] = None, policy_type: Optional[StrictStr] = None, appliance_certificate: Optional[ReferenceWritable] = None, disabled_tls_ciphers: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, enabled_tls_ciphers: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, min_tls_version: Optional[StrictStr] = None)

field appliance_certificate: Optional[ReferenceWritable] = None

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.

field disabled_tls_ciphers: Optional[ConstrainedListValue[ConstrainedStrValue]] = None

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.

Constraints

• maxItems = 16

field enabled: Optional[StrictBool] = None

If true, the policy is enabled. If not specified, defaults to true.

Constraints

• type = boolean

field enabled_tls_ciphers: Optional[ConstrainedListValue[ConstrainedStrValue]] = None

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.

Constraints

• maxItems = 16

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field is_local: Optional[StrictBool] = None

Whether the policy is defined on the local array.

Constraints

• type = boolean

field location: Optional[FixedReference] = None

Reference to the array where the policy is defined.

field min_tls_version: Optional[StrictStr] = None

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.

field name: Optional[StrictStr] = None

A name chosen by the user. Can be changed. Must be locally unique.

field policy_type: Optional[StrictStr] = None

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.

TlsPolicyGetResponse

pydantic model pypureclient.flashblade.TlsPolicyGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[TlsPolicy]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[TlsPolicy]] = None

A list of TLS policy objects.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

TlsPolicyPost

pydantic model pypureclient.flashblade.TlsPolicyPost(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, enabled: Optional[StrictBool] = None, is_local: Optional[StrictBool] = None, location: Optional[FixedReference] = None, policy_type: Optional[StrictStr] = None, appliance_certificate: Optional[ReferenceWritable] = None, disabled_tls_ciphers: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, enabled_tls_ciphers: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, min_tls_version: Optional[StrictStr] = None)

field appliance_certificate: Optional[ReferenceWritable] = None

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.

field disabled_tls_ciphers: Optional[ConstrainedListValue[ConstrainedStrValue]] = None

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.

Constraints

• maxItems = 16

field enabled: Optional[StrictBool] = None

If true, the policy is enabled. If not specified, defaults to true.

Constraints

• type = boolean

field enabled_tls_ciphers: Optional[ConstrainedListValue[ConstrainedStrValue]] = None

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.

Constraints

• maxItems = 16

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field is_local: Optional[StrictBool] = None

Whether the policy is defined on the local array.

Constraints

• type = boolean

field location: Optional[FixedReference] = None

Reference to the array where the policy is defined.

field min_tls_version: Optional[StrictStr] = None

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.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field policy_type: Optional[StrictStr] = None

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.

TlsPolicyResponse

pydantic model pypureclient.flashblade.TlsPolicyResponse(*, items: Optional[ConstrainedListValue[TlsPolicy]] = None)

field items: Optional[ConstrainedListValue[TlsPolicy]] = None

A list of TLS policy objects.

TrustPolicyRule

pydantic model pypureclient.flashblade.TrustPolicyRule(*, name: Optional[StrictStr] = None, index: Optional[StrictInt] = None, actions: Optional[ConstrainedListValue[StrictStr]] = None, conditions: Optional[ConstrainedListValue[TrustPolicyRuleCondition]] = None, effect: Optional[StrictStr] = None, policy: Optional[FixedReference] = None, principals: Optional[ConstrainedListValue[ReferenceWritable]] = None)

field actions: Optional[ConstrainedListValue[StrictStr]] = None

The list of role-assumption actions granted by this rule to the respective role. Currently we support sts:AssumeRoleWithSAML and sts:AssumeRoleWithWebIdentity actions.

field conditions: Optional[ConstrainedListValue[TrustPolicyRuleCondition]] = None

Conditions used to limit the scope which this rule applies to.

field effect: Optional[StrictStr] = None

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.

field index: Optional[StrictInt] = None

Index of the object in the containing array.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field policy: Optional[FixedReference] = None

The policy to which this rule belongs.

field principals: Optional[ConstrainedListValue[ReferenceWritable]] = None

List of Identity Providers

TrustPolicyRuleCondition

pydantic model pypureclient.flashblade.TrustPolicyRuleCondition(*, key: Optional[StrictStr] = None, operator: Optional[StrictStr] = None, values: Optional[ConstrainedListValue[StrictStr]] = None)

Identity-provider-specific condition that specifies who can assume the role.

field key: Optional[StrictStr] = None

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.

field operator: Optional[StrictStr] = None

Operator specifying the comparison to be done between the values from the request context and the values provided in this condition. Valid values: StringEquals.

field values: Optional[ConstrainedListValue[StrictStr]] = None

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.

TrustPolicyRulePost

pydantic model pypureclient.flashblade.TrustPolicyRulePost(*, actions: Optional[ConstrainedListValue[StrictStr]] = None, conditions: Optional[ConstrainedListValue[TrustPolicyRuleCondition]] = None, effect: Optional[StrictStr] = None, policy: Optional[FixedReference] = None, principals: Optional[ConstrainedListValue[ReferenceWritable]] = None)

field actions: Optional[ConstrainedListValue[StrictStr]] = None

The list of role-assumption actions granted by this rule to the respective role. Currently we support sts:AssumeRoleWithSAML and sts:AssumeRoleWithWebIdentity actions.

field conditions: Optional[ConstrainedListValue[TrustPolicyRuleCondition]] = None

Conditions used to limit the scope which this rule applies to.

field effect: Optional[StrictStr] = None

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.

field policy: Optional[FixedReference] = None

The policy to which this rule belongs.

field principals: Optional[ConstrainedListValue[ReferenceWritable]] = None

List of Identity Providers

TrustPolicyRuleWithContext

pydantic model pypureclient.flashblade.TrustPolicyRuleWithContext(*, name: Optional[StrictStr] = None, index: Optional[StrictInt] = None, actions: Optional[ConstrainedListValue[StrictStr]] = None, conditions: Optional[ConstrainedListValue[TrustPolicyRuleCondition]] = None, effect: Optional[StrictStr] = None, policy: Optional[FixedReference] = None, principals: Optional[ConstrainedListValue[ReferenceWritable]] = None, context: Optional[Reference] = None)

field actions: Optional[ConstrainedListValue[StrictStr]] = None

The list of role-assumption actions granted by this rule to the respective role. Currently we support sts:AssumeRoleWithSAML and sts:AssumeRoleWithWebIdentity actions.

field conditions: Optional[ConstrainedListValue[TrustPolicyRuleCondition]] = None

Conditions used to limit the scope which this rule applies to.

field context: Optional[Reference] = None

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.

field effect: Optional[StrictStr] = None

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.

field index: Optional[StrictInt] = None

Index of the object in the containing array.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field policy: Optional[FixedReference] = None

The policy to which this rule belongs.

field principals: Optional[ConstrainedListValue[ReferenceWritable]] = None

List of Identity Providers

User

pydantic model pypureclient.flashblade.User(*, id: Optional[StrictInt] = None, name: Optional[StrictStr] = None)

field id: Optional[StrictInt] = None

The numeric user id that represents the user’s identity in a POSIX system.

field name: Optional[StrictStr] = None

The user name that represents the user’s identity, and which resolves to the user’s id in a configured directory service.

UserNoId

pydantic model pypureclient.flashblade.UserNoId(*, name: Optional[StrictStr] = None)

field name: Optional[StrictStr] = None

The user name that represents the user’s identity, and which resolves to the user’s id in a configured directory service.

UserQuota

pydantic model pypureclient.flashblade.UserQuota(*, name: Optional[StrictStr] = None, context: Optional[Reference] = None, file_system: Optional[FixedReference] = None, file_system_default_quota: Optional[StrictInt] = None, quota: Optional[StrictInt] = None, usage: Optional[StrictInt] = None, user: Optional[User] = None)

field context: Optional[Reference] = None

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.

field file_system: Optional[FixedReference] = None

field file_system_default_quota: Optional[StrictInt] = None

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.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field quota: Optional[StrictInt] = None

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.

field usage: Optional[StrictInt] = None

The usage of the file system (in bytes) by the specified user.

field user: Optional[User] = None

The user on which this quota is enforced.

UserQuotaGetResponse

pydantic model pypureclient.flashblade.UserQuotaGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[UserQuota]] = None, errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[UserQuota]] = None

A list of quota objects.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

UserQuotaPatch

pydantic model pypureclient.flashblade.UserQuotaPatch(*, name: Optional[StrictStr] = None, quota: StrictInt)

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field quota: StrictInt [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.

UserQuotaPost

pydantic model pypureclient.flashblade.UserQuotaPost(*, name: Optional[StrictStr] = None, quota: StrictInt)

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field quota: StrictInt [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.

UserQuotaResponse

pydantic model pypureclient.flashblade.UserQuotaResponse(*, items: Optional[ConstrainedListValue[UserQuota]] = None)

field items: Optional[ConstrainedListValue[UserQuota]] = None

A list of quota objects.

VerificationKey

pydantic model pypureclient.flashblade.VerificationKey(*, key_id: Optional[StrictInt] = None, name: Optional[StrictStr] = None, verification_key: Optional[StrictStr] = None)

field key_id: Optional[StrictInt] = None

The key id of the verification key.

field name: Optional[StrictStr] = None

Name of the verification key. Possible values include access.

field verification_key: Optional[StrictStr] = None

The text of the verification key.

VerificationKeyGetResponse

pydantic model pypureclient.flashblade.VerificationKeyGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[VerificationKey]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field items: Optional[ConstrainedListValue[VerificationKey]] = None

A list of verification key objects.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

VerificationKeyPatch

pydantic model pypureclient.flashblade.VerificationKeyPatch(*, signed_verification_key: Optional[StrictStr] = None)

field signed_verification_key: Optional[StrictStr] = None

The text of the signed verification key.

VerificationKeyResponse

pydantic model pypureclient.flashblade.VerificationKeyResponse(*, items: Optional[ConstrainedListValue[VerificationKey]] = None)

field items: Optional[ConstrainedListValue[VerificationKey]] = None

A list of verification key objects.

Version

pydantic model pypureclient.flashblade.Version(*, version: Optional[StrictStr] = None)

field version: Optional[StrictStr] = None

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.

WormDataPoliciesGetResponse

pydantic model pypureclient.flashblade.WormDataPoliciesGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[WormDataPolicy]] = None, errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[WormDataPolicy]] = None

A list of worm data policy objects.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

WormDataPoliciesMembersGetResponse

pydantic model pypureclient.flashblade.WormDataPoliciesMembersGetResponse(*, continuation_token: Optional[StrictStr] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[PolicyMemberContext]] = None, errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None)

field continuation_token: Optional[StrictStr] = None

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).

field errors: Optional[ConstrainedListValue[ErrorContextResponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[PolicyMemberContext]] = None

A list of members for worm data policies.

field total_item_count: Optional[StrictInt] = None

Total number of items after applying filter params.

WormDataPoliciesMembersResponse

pydantic model pypureclient.flashblade.WormDataPoliciesMembersResponse(*, items: Optional[ConstrainedListValue[PolicyMemberContext]] = None)

field items: Optional[ConstrainedListValue[PolicyMemberContext]] = None

A list of members for worm data policies.

WormDataPoliciesResponse

pydantic model pypureclient.flashblade.WormDataPoliciesResponse(*, items: Optional[ConstrainedListValue[WormDataPolicy]] = None)

field items: Optional[ConstrainedListValue[WormDataPolicy]] = None

A list of worm data policy objects.

WormDataPolicy

pydantic model pypureclient.flashblade.WormDataPolicy(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, enabled: Optional[StrictBool] = None, is_local: Optional[StrictBool] = None, location: Optional[FixedReference] = None, policy_type: Optional[StrictStr] = None, default_retention: Optional[StrictInt] = None, max_retention: Optional[StrictInt] = None, min_retention: Optional[StrictInt] = None, mode: Optional[StrictStr] = None, retention_lock: Optional[StrictStr] = None, context: Optional[Reference] = None)

field context: Optional[Reference] = None

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.

field default_retention: Optional[StrictInt] = None

Default retention period, in milliseconds. If the access time is not specified when committing a file, then the default retention period is applied.

field enabled: Optional[StrictBool] = None

If true, the policy is enabled. If not specified, defaults to true.

Constraints

• type = boolean

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field is_local: Optional[StrictBool] = None

Whether the policy is defined on the local array.

Constraints

• type = boolean

field location: Optional[FixedReference] = None

Reference to the array where the policy is defined.

field max_retention: Optional[StrictInt] = None

Maximum retention period, in milliseconds.

field min_retention: Optional[StrictInt] = None

Minimum retention period, in milliseconds.

field mode: Optional[StrictStr] = None

The type of the retention lock. Valid values is compliance.

field name: Optional[StrictStr] = None

Name of the object (e.g., a file system or snapshot).

field policy_type: Optional[StrictStr] = None

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.

field retention_lock: Optional[StrictStr] = None

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.

WormDataPolicyRetentionConfig

pydantic model pypureclient.flashblade.WormDataPolicyRetentionConfig(*, default_retention: Optional[StrictInt] = None, max_retention: Optional[StrictInt] = None, min_retention: Optional[StrictInt] = None, mode: Optional[StrictStr] = None, retention_lock: Optional[StrictStr] = None)

field default_retention: Optional[StrictInt] = None

Default retention period, in milliseconds. If the access time is not specified when committing a file, then the default retention period is applied.

field max_retention: Optional[StrictInt] = None

Maximum retention period, in milliseconds.

field min_retention: Optional[StrictInt] = None

Minimum retention period, in milliseconds.

field mode: Optional[StrictStr] = None

The type of the retention lock. Valid values is compliance.

field retention_lock: Optional[StrictStr] = None

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.

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.

Apiclientsap

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))

Activedirectoryap

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

Administratorsap

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))

Alertwatchersap

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

Alertsap

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

Arrayconnectionsap

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
# 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: 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: 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: 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))

Arraysap

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))

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)

patch_arrays

from pypureclient.flashblade import Array

# 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"
array_settings = Array(banner="example-banner",
                       name="example-name",
                       ntp_servers=["0.example.ntp.server"],
                       time_zone="America/Los_Angeles")
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))

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))

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))

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))

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

Auditsap

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

Authorizationap

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

Bladesap

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

Bucketreplicalinksap

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

delete_bucket_replica_links

# delete the replica link on the local bucket with the name 'my-connected-array'
client.delete_bucket_replica_links(local_bucket_names=['localbucket'],
                                   remote_bucket_names=['remotebucket'],
                                   remote_names=['my-connected-array'])

# delete the replica link on the local bucket with id '10314f42-020d-7080-8013-000ddt400090'
client.delete_bucket_replica_links(local_bucket_ids=['10314f42-020d-7080-8013-000ddt400090'],
                                   remote_bucket_names=['remotebucket'],
                                   remote_ids=['10314f42-020d-7080-8013-000ddt400012'])

# Other valid fields: ids
# See section "Common Fields" for examples

get_bucket_replica_links

# list all replica links
res = client.get_bucket_replica_links()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list first five replica links using default sort
res = client.get_bucket_replica_links(limit=5)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list first five replica links and sort by remote
res = client.get_bucket_replica_links(limit=5, sort='remote')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list replica links on the remote 's3target'
res = client.get_bucket_replica_links(remote_names=['s3target'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list all remaining replica links
res = client.get_bucket_replica_links(continuation_token=res.continuation_token)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list with filter to see only replica links that are paused
res = client.get_bucket_replica_links(filter='paused')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: ids, local_bucket_ids, local_bucket_names, offset, 
#    remote_bucket_names, remote_ids, total_only
# See section "Common Fields" for examples

patch_bucket_replica_links

from pypureclient.flashblade import BucketReplicaLink, ObjectStoreRemoteCredentials

# Pause an existing bucket replica link
# Also change the remote credentials we're using for replication to the credentials named "remote/name"
new_attr = BucketReplicaLink(paused=True, remote_credentials=ObjectStoreRemoteCredentials(name="remote/name"))
# Update the existing replica link on the specified local bucket, to the specified remote bucket on the remote
# Use the attribute map from before to pause the link and change credentials
res = client.patch_bucket_replica_links(local_bucket_names=['localbucket'],
                                        remote_names=['remote'],
                                        remote_bucket_names=['remotebucket'],
                                        bucket_replica_link=new_attr)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Update the existing replica link on the specified local bucket, to the specified remote bucket on the remote (by ids)
# Use the attribute map from before to pause the link and change credentials
res = client.patch_bucket_replica_links(local_bucket_ids=['10314f42-020d-7080-8013-000ddt400090'],
                                        remote_ids=['10314f42-020d-7080-8013-000ddt400045'],
                                        remote_bucket_names=['remotebucket'],
                                        bucket_replica_link=new_attr)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: ids
# See section "Common Fields" for examples

post_bucket_replica_links

from pypureclient.flashblade import BucketReplicaLinkPost

# create a replica link from a specified local bucket, to a specified remote bucket
# on the remote corresponding to the remote credentials
local_bucket_names = ["localbucket"]
remote_bucket_names = ["remotebucket"]
remote_credentials_names = ["remote/credentials"]
# We can specify if we want to enable cascading and if we want to pause the replica link immediately at creation
my_replica_link = BucketReplicaLinkPost(cascading_enabled=True, paused=False)
# post the bucket replica link object on the local array
res = client.post_bucket_replica_links(local_bucket_names=local_bucket_names,
                                       remote_bucket_names=remote_bucket_names,
                                       remote_credentials_names=remote_credentials_names,
                                       bucket_replica_link=my_replica_link)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: local_bucket_ids, remote_credentials_ids
# See ids in section "Common Fields" for examples

Bucketsap

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"])

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: 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))

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"])

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: 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))

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"])

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: 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))

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"])

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: 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))

delete_buckets

# delete the bucket object mybucket on the array
client.delete_buckets(names=["mybucket"])

# Other valid fields: 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: 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: 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))

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

Certificategroupsap

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

Certificatesap

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

Clientsap

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

Dnsap

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

Directoryservicesap

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

Drivesap

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

Filesystemexportsap

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))

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: filter, limit, offset, sort, continuation_token
# See section "Common Fields" for examples

patch_file_system_exports

from pypureclient.flashblade.FB_2_16 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))

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))

Filesystemreplicalinksap

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

delete_file_system_replica_links

# delete replica link defined by local file system 'local_fs', remote array 'my_remote' and
# optionally remote file system 'remote_fs'
res = client.delete_file_system_replica_links(local_file_system_names=['local_fs'],
                                              remote_file_system_names=['remote_fs'],
                                              remote_names=['my_remote'],
                                              cancel_in_progress_transfers=True)

print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# delete replica link defined by id
res = client.delete_file_system_replica_links(ids=['10314f42-020d-7080-8013-000ddt400092'],
                                              cancel_in_progress_transfers=True)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

# Other valid fields: local_file_system_ids, remote_ids, remote_file_system_ids
# See section "Common Fields" for examples

get_file_system_replica_links

# list all replica links
res = client.get_file_system_replica_links()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list first five replica links and sort by local file system
res = client.get_file_system_replica_links(limit=5, sort='local_file_system.name')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list remaining replica links
res = client.get_file_system_replica_links(continuation_token = res.continuation_token)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list replica links on the remote
res = client.get_file_system_replica_links(remote_names=['myremote'])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list with filter to see only replica links that are paused
res = client.get_file_system_replica_links(filter='paused')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: ids, local_file_system_ids, local_file_system_names, offset,
#                     remote_file_system_ids, remote_file_system_names, remote_ids
# See section "Common Fields" for examples

delete_file_system_replica_links_policies

client.delete_file_system_replica_links_policies(
    policy_names=['policy_1'],
    local_file_system_names=['local_fs'],
    remote_names=['myremote'])

# Other valid fields: local_file_system_ids, member_ids, policy_ids, remote_ids
# See section "Common Fields" for examples

get_file_system_replica_links_policies

# list all replica link and policy connections
res = client.get_file_system_replica_links_policies()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list first five replica link and policy connections and sort by local file system
res = client.get_file_system_replica_links_policies(limit=5, sort='member.name')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list remaining replica link and policies
res = client.get_file_system_replica_links_policies(
    continuation_token=res.continuation_token)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list a specific replica link and policy connection
res = client.get_file_system_replica_links_policies(
    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: filter, local_file_system_ids,
#                     member_ids, offset, policy_ids, remote_ids, remote_file_system_ids,
#                     remote_file_system_names
# See section "Common Fields" for examples

post_file_system_replica_links_policies

res = client.post_file_system_replica_links_policies(
    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: policy_ids, local_file_system_ids, remote_ids, member_ids
# See section "Common Fields" for examples

post_file_system_replica_links

from pypureclient.flashblade import FileSystemReplicaLink, LocationReference

res = client.post_file_system_replica_links(
    local_file_system_names=["local_fs"],
    remote_file_system_names=["remote_fs"],
    remote_names=['myremote'],
    file_system_replica_link=FileSystemReplicaLink(policies=[LocationReference(name=POLICY_NAME)]))
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: ids, local_file_system_ids, remote_ids
# See section "Common Fields" for examples

get_file_system_replica_links_transfer

FS_NAME = 'local_file'
# list all incoming or outgoing replica link transfers for filesystem local_file
res = client.get_file_system_replica_links_transfer(names_or_owner_names=[FS_NAME])
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: continuation_token, filter, ids, limit, offset, remote_ids, remote_names, sort, total_only
# See section "Common Fields" for examples

Filesystemsnapshotsap

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: 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: 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: 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: 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: 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: 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: 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: continuation_token, filter, ids, limit, offset, sort, total_only
# See section "Common Fields" for examples

Filesystemsap

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: 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: 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: 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: 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: 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))

patch_file_systems

from pypureclient.flashblade.FB_2_16 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 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),
                           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))

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: 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: 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: 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: 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, and smb share
# policy "share_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")
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),
                      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))

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: filter, limit, offset, sort, continuation_token
# See section "Common Fields" for examples

Fleetsap

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

Hardwareap

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

Hardwareconnectorsap

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

Kmipap

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

Keytabsap

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))

Legalholdsap

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

Lifecyclerulesap

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'])

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: 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))

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))

Linkaggregationgroupsap

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

delete_link_aggregation_groups

# delete a link aggregation group with name mylag
client.delete_link_aggregation_groups(names=["mylag"])

# Other valid fields: ids
# See section "Common Fields" for examples

get_link_aggregation_groups

# list all link aggregation groups
res = client.get_link_aggregation_groups()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list and sort by name in descendant order
res = client.get_link_aggregation_groups(limit=5, sort="name-")
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list with page size 5
res = client.get_link_aggregation_groups(limit=5)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list all remaining link aggregation groups
res = client.get_link_aggregation_groups(continuation_token=res.continuation_token)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list with filter
res = client.get_link_aggregation_groups(filter='mac_address=\'24:a9:37:11:f5:21\'')
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_link_aggregation_groups

from pypureclient.flashblade import LinkAggregationGroup

res = client.patch_link_aggregation_groups(
    names=["mylag"], link_aggregation_group=LinkAggregationGroup(
        ports=[{"name": "CH1.FM1.ETH4"}, {"name": "CH1.FM2.ETH4"}]))
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# Other valid fields: ids
# See section "Common Fields" for examples

post_link_aggregation_groups

from pypureclient.flashblade import LinkAggregationGroup

# create lag named "mylag" with ports 'CH1.FM1.ETH4' and 'CH1.FM2.ETH4'
res = client.post_link_aggregation_groups(
    names=["mylag"],
    link_aggregation_group=LinkAggregationGroup(ports=[{'name': 'CH1.FM1.ETH4'},
                                                       {'name': 'CH1.FM2.ETH4'}]))
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))

Logsap

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))

Maintenancewindowsap

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))

Networkinterfacesap

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

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))

Oidcssoap

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

Objectstoreaccesskeysap

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"])

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: 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))

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))

Objectstoreaccountsap

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: 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: 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: 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))

Objectstoreremotecredentialsap

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'])

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: 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)

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)

Objectstorerolesap

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

Objectstoreusersap

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: 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: 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"])

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: 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))

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))

Objectstorevirtualhostsap

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"])

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: 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))

Policiesallap

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: 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: 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

Policiesauditforfilesystemsap

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'])

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: 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: 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: 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: member_ids, policy_ids
# See section "Common Fields" for examples

patch_audit_file_systems_policies

from pypureclient.flashblade.FB_2_14 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: ids
# See section "Common Fields" for examples

post_audit_file_systems_policies

from pypureclient.flashblade.FB_2_14 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))

Policiesnfsap

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"])

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: 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: 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))

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'])

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: 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: 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: policy_ids
# See section "Common Fields" for examples

Policiesnetworkaccessap

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

Policiesobjectstoreaccessap

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"])

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))
# Valid fields: continuation_token, filter, ids, limit, names, offset, sort
# See 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"])

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: 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))

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))

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))

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"])

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: 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))

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))

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: continuation_token, filter, limit, names, offset, sort
# See section "Common Fields" for examples

Policiespasswordap

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

Policiesqosap

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

Policiessmbclientap

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"])

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: 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)
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: 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))

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'])

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: 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: 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: policy_ids
# See section "Common Fields" for examples

Policiessmbshareap

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"])

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: 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: 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))

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'])

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: 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: 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: policy_ids
# See section "Common Fields" for examples

Policiessshcertificateauthorityap

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)

Policiessnapshotap

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: ids
# See section "Common Fields" for examples

delete_policies_file_system_replica_links

client.delete_policies_file_system_replica_links(
    policy_names=['policy_1'],
    local_file_system_names=['local_fs'],
    remote_names=['myremote'])

# Other valid fields: policy_ids, local_file_system_ids, remote_ids, member_ids
# See section "Common Fields" for examples

get_policies_file_system_replica_links

# list all replica link and policy connections
res = client.get_policies_file_system_replica_links()
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list first five replica link and policy connections and sort by policy name
res = client.get_policies_file_system_replica_links(limit=5, sort='policy.name')
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list remaining replica link and policies connections
res = client.get_policies_file_system_replica_links(
    continuation_token=res.continuation_token)
print(res)
if type(res) == pypureclient.responses.ValidResponse:
    print(list(res.items))
# list a specific replica link and policy connection
res = client.get_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: filter, local_file_system_ids, member_ids, offset, policy_ids, remote_ids,
#                     remote_file_system_ids, remote_file_system_names
# 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: 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: 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: 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: 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: 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: 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: 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: 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: 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))

Policiestlsap

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

Policieswormdataap

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: 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: 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: filter, limit, offset, sort, continuation_token
# See section "Common Fields" for examples

patch_worm_data_policies

from pypureclient.flashblade.FB_2_15 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: ids
# See section "Common Fields" for examples

post_worm_data_policies

from pypureclient.flashblade.FB_2_15 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)

Publickeysap

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

Quotasap

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: 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: 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: 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: 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: 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: 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: 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: file_system_ids
# See section "Common Fields" for examples

Rdlap

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))

Remotearraysap

The following examples assume that client is an instantiated flashblade.Client object as shown in Instantiating a Client.

Rolesap

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

Saml2ssoap

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_15 import Saml2Sso, Saml2SsoIdp, Saml2SsoSp, Reference

# Update an SSO SAML2 configuration
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(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_15 import Saml2SsoPost, Saml2SsoIdp, Saml2SsoSp, Reference

# Create an SSO SAML2 configuration
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 = Saml2SsoPost(enabled=True, array_url='https://test-array-url', idp=idp, sp=sp)
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

Smtpap

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))

Snmpagentsap

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))

Snmpmanagersap

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

Serversap

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: 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))

Sessionsap

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

Softwareap

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

Subnetsap

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))

Supportap

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

Supportdiagnosticsap

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

Syslogap

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: continuation_token, filter, ids, offset
# See section "Common Fields" for examples

patch_syslog_servers

from pypureclient.flashblade.FB_2_14 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_14 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

Targetsap

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: 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))

Usageap

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: 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: continuation_token, file_system_ids, filter, uids, user_names, limit,
#                     offset, sort
# See section "Common Fields" for examples

Verificationkeysap

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))