FlashArray Reference

Client

FlashArray REST Client Factory Method

Importable as

from pypureclient.flasharray import Client

pypureclient.flasharray.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, model_attribute_error_on_none: bool = True)

Initialize a FlashArray 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.

• model_attribute_error_on_none (bool, optional) – Controls model instance behaviour with regard to accessing attributes with None value. raise an AttributeError if attribute value is None, otherwise returns None. Defaults to True for backward compatibility with older versions of the SDK.

Raises

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

FlashArray REST 2.0 Client

class pypureclient.flasharray.FA_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)

FlashArray REST 2.1 Client

class pypureclient.flasharray.FA_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)

FlashArray REST 2.2 Client

class pypureclient.flasharray.FA_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)

FlashArray REST 2.3 Client

class pypureclient.flasharray.FA_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)

FlashArray REST 2.4 Client

class pypureclient.flasharray.FA_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)

FlashArray REST 2.5 Client

class pypureclient.flasharray.FA_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)

FlashArray REST 2.6 Client

class pypureclient.flasharray.FA_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)

FlashArray REST 2.7 Client

class pypureclient.flasharray.FA_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)

FlashArray REST 2.8 Client

class pypureclient.flasharray.FA_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)

FlashArray REST 2.9 Client

class pypureclient.flasharray.FA_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)

FlashArray REST 2.10 Client

class pypureclient.flasharray.FA_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)

FlashArray REST 2.11 Client

class pypureclient.flasharray.FA_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)

FlashArray REST 2.13 Client

class pypureclient.flasharray.FA_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)

FlashArray REST 2.14 Client

class pypureclient.flasharray.FA_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)

FlashArray REST 2.15 Client

class pypureclient.flasharray.FA_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)

FlashArray REST 2.16 Client

class pypureclient.flasharray.FA_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)

FlashArray REST 2.17 Client

class pypureclient.flasharray.FA_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)

FlashArray REST 2.19 Client

class pypureclient.flasharray.FA_2_19.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)

FlashArray REST 2.20 Client

class pypureclient.flasharray.FA_2_20.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)

FlashArray REST 2.21 Client

class pypureclient.flasharray.FA_2_21.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)

FlashArray REST 2.22 Client

class pypureclient.flasharray.FA_2_22.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)

FlashArray REST 2.23 Client

class pypureclient.flasharray.FA_2_23.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)

FlashArray REST 2.24 Client

class pypureclient.flasharray.FA_2_24.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)

FlashArray REST 2.25 Client

class pypureclient.flasharray.FA_2_25.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)

FlashArray REST 2.26 Client

class pypureclient.flasharray.FA_2_26.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)

FlashArray REST 2.27 Client

class pypureclient.flasharray.FA_2_27.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)

FlashArray REST 2.28 Client

class pypureclient.flasharray.FA_2_28.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)

FlashArray REST 2.29 Client

class pypureclient.flasharray.FA_2_29.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)

FlashArray REST 2.30 Client

class pypureclient.flasharray.FA_2_30.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)

FlashArray REST 2.31 Client

class pypureclient.flasharray.FA_2_31.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)

FlashArray REST 2.32 Client

class pypureclient.flasharray.FA_2_32.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)

FlashArray REST 2.33 Client

class pypureclient.flasharray.FA_2_33.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)

FlashArray REST 2.34 Client

class pypureclient.flasharray.FA_2_34.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)

FlashArray REST 2.35 Client

class pypureclient.flasharray.FA_2_35.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)

FlashArray REST 2.36 Client

class pypureclient.flasharray.FA_2_36.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)

FlashArray REST 2.37 Client

class pypureclient.flasharray.FA_2_37.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)

FlashArray REST 2.38 Client

class pypureclient.flasharray.FA_2_38.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)

FlashArray REST 2.39 Client

class pypureclient.flasharray.FA_2_39.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)

FlashArray REST 2.40 Client

class pypureclient.flasharray.FA_2_40.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)

FlashArray REST 2.41 Client

class pypureclient.flasharray.FA_2_41.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)

FlashArray REST 2.42 Client

class pypureclient.flasharray.FA_2_42.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)

FlashArray REST 2.43 Client

class pypureclient.flasharray.FA_2_43.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)

FlashArray REST 2.44 Client

class pypureclient.flasharray.FA_2_44.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 FlashArray 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

delete_active_directory(names: ConstrainedListValue[StrictStr], references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, local_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]

Delete Active Directory account

Deletes one or more specified Active Directory accounts.

Parameters

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. The name is expected to be fully qualified, meaning if the object is contained in some context, the corresponding name would provide complete information about the containment hierarchy. For example, name01,pod01::name01. (required)

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

• authorization (str) – Deprecated. Please use Client level authorization

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

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

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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, authorization: Optional[StrictStr] = 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]

Delete an administrator

Deletes the specified administrator.

Parameters

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

• authorization (str) – Deprecated. Please use Client level authorization

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

delete_admins_api_tokens(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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]

Delete API tokens

Deletes the API tokens of the specified administrators.

Parameters

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

• authorization (str) – Deprecated. Please use Client level authorization

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

delete_admins_cache(remove_all_entries: StrictBool, authorization: Optional[StrictStr] = 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]

Delete cache entries

Deletes all entries from the administrator cache.

Parameters

• remove_all_entries (bool) – If set to true, removes all entries from the administrator cache. (required)

• authorization (str) – Deprecated. Please use Client level authorization

• 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_admins_policies_management_access(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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 a membership between an administrator and one or more management access policies

Deletes a membership between an administrator with one or more management access policies. One of policy_ids or policy_names is required, and one of member_ids or member_names is required.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy 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_alert_watchers(names: ConstrainedListValue[StrictStr], references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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]

Delete alert watcher

Delete alert watcher email address from the list of alert watchers.

Parameters

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

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

• authorization (str) – Deprecated. Please use Client level authorization

• 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_alerts_rules(code: StrictInt, parameter: StrictStr, authorization: Optional[StrictStr] = 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]

Delete a custom alert rule

Deletes a custom alert rule.

Parameters

• code (int) – The alert code that the rule applies to. Available alert codes for customization can be found in the alert rules catalog. (required)

• parameter (str) – The parameter of the custom alert rule to modify. Values include info and warning. Available parameter values can be found in the alert rules catalog. (required)

• authorization (str) – Deprecated. Please use Client level authorization

• 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_api_clients(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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 an API client

Deletes an API client. The ids or names parameter is required, but they cannot be set together.

Parameters

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

• authorization (str) – Deprecated. Please use Client level authorization

• 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. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• 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_array_connections(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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 an array connection

Deletes the connection between this array and the specified 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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• 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_arrays(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, eradicate_all_data: Optional[StrictBool] = None, factory_reset_token: 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]

Delete an array

Deletes an array. For physical appliances, deleting an array restores the hardware to factory settings. This entails deleting all data, metadata, configuration, and logs. The array returns to the state it was in prior to any configuration changes being made. If the hardware is reused, it must be as a different array with a new ID. For virtual appliances, deleting an array puts it into an unusable state. Virtual resources (e.g., virtual machines) can later be freed, which deletes any remaining data, metadata, configuration, and logs. Prior to factory reset, an array must be manually prepared (e.g., all volumes and snapshots must be eradicated) and a factory reset token must be created.

Parameters

• authorization (str) – Deprecated. Please use Client level authorization

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

• eradicate_all_data (bool) – Set to true to perform a factory reset.

• factory_reset_token (int) – A token required to perform a factory reset.

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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_cloud_provider_tags(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, keys: 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 user tags from the cloud.

Deletes user tags from deployed cloud resources of a CBS array.

Parameters

• authorization (str) – Deprecated. Please use Client level authorization

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

• keys (List[str]) – A comma-separated list of tag keys.

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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_erasures(authorization: Optional[StrictStr] = 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]

Delete factory reset

Deletes the factory reset process when it is failed.

Parameters

• authorization (str) – Deprecated. Please use Client level authorization

• 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_factory_reset_token(authorization: Optional[StrictStr] = 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]

Delete a factory reset token

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

Parameters

• authorization (str) – Deprecated. Please use Client level authorization

• 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_tags(contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, keys: Optional[ConstrainedListValue[StrictStr]] = None, namespaces: 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 tags

Deletes specified tags on array objects.

Parameters

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

• authorization (str) – Deprecated. Please use Client level authorization

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

• keys (List[str]) – A comma-separated list of tag keys.

• namespaces (List[str]) – A comma-separated list of namespaces.

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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, authorization: Optional[StrictStr] = 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

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

• authorization (str) – Deprecated. Please use Client level authorization

• 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. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• 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_certificate_groups_certificates(certificates: Optional[Union[ReferenceType, List[ReferenceType]]] = None, certificate_groups: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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 or certificates

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

• authorization (str) – Deprecated. Please use Client level authorization

• 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 no resource matches each of the elements of certificate_group_names, then an error is returned. This cannot be provided in conjunction with the certificate_group_ids parameter.

• certificate_ids (List[str]) – 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]) – The names of one or more certificates. Enter multiple names in comma-separated format. For example, cert01,cert02.

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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, authorization: Optional[StrictStr] = 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

Deletes a specific certificate object.

Parameters

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

• authorization (str) – Deprecated. Please use Client level authorization

• 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. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• 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_certificates_certificate_groups(certificates: Optional[Union[ReferenceType, List[ReferenceType]]] = None, certificate_groups: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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]

Deletes certificates/certificate-groups

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

• authorization (str) – Deprecated. Please use Client level authorization

• 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 no resource matches each of the elements of certificate_group_names, then an error is returned. This cannot be provided in conjunction with the certificate_group_ids parameter.

• certificate_ids (List[str]) – 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]) – The names of one or more certificates. Enter multiple names in comma-separated format. For example, cert01,cert02.

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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_connections(volumes: Optional[Union[ReferenceType, List[ReferenceType]]] = None, hosts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, host_groups: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, host_group_names: Optional[ConstrainedListValue[StrictStr]] = None, host_names: Optional[ConstrainedListValue[StrictStr]] = None, volume_ids: Optional[ConstrainedListValue[StrictStr]] = None, volume_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 connection between a volume and its host or host group

Deletes the connection between a volume and its associated host or host group. One of volume_names or volume_ids and one of host_names or host_group_names query parameters are required.

Parameters

• volumes (ReferenceType or List[ReferenceType], optional) – A list of volumes to query for. Overrides volume_ids and volume_names keyword arguments.

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

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

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

• authorization (str) – Deprecated. Please use Client level authorization

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

• host_group_names (List[str]) – Performs the operation on the host group specified. Enter multiple names in comma-separated format. A request cannot include a mix of multiple objects with multiple names. For example, a request cannot include a mix of multiple host group names and volume names; instead, at least one of the objects (e.g., host_group_names) must be set to only one name (e.g., hgroup01).

• host_names (List[str]) – Performs the operation on the hosts specified. Enter multiple names in comma- separated format. For example, host01,host02. A request cannot include a mix of multiple objects with multiple names. For example, a request cannot include a mix of multiple host names and volume names; instead, at least one of the objects (e.g., host_names) must be set to only one name (e.g., host01).

• volume_ids (List[str]) – Performs the operation on the specified volume. Enter multiple ids in comma- separated format. For example, vol01id,vol02id. A request cannot include a mix of multiple objects with multiple IDs. For example, a request cannot include a mix of multiple volume IDs and host names; instead, at least one of the objects (e.g., volume_ids) must be set to only one name (e.g., vol01id). Only one of the two between volume_names and volume_ids may be used at a time.

• volume_names (List[str]) – Performs the operation on the volume specified. Enter multiple names in comma- separated format. For example, vol01,vol02. A request cannot include a mix of multiple objects with multiple names. For example, a request cannot include a mix of multiple volume names and host names; instead, at least one of the objects (e.g., volume_names) must be set to only one name (e.g., vol01).

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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_directories(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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 managed directories

Deletes one or more managed directories. To be deleted, a managed directory must be empty and not attached to any enabled export policies. Deleted managed directories cannot be recovered. The ids or names parameter is required, but cannot be set together.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• 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_directories_policies_audit_file(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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 a membership between a directory and one or more audit policies

Deletes a membership between a directory and one or more audit policies. Either the policy_ids or policy_names parameter is required, but they cannot be set together. Either the member_ids or member_names parameter is required, but they cannot be set together.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy 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_directories_policies_autodir(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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 a membership between a directory and one or more auto managed directory policies

Deletes a membership between a directory with one or more auto managed directory policies. The policy_ids or policy_names parameter is required, but they cannot be set together. The member_ids or member_names parameter is required, but they cannot be set together.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy 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_directories_policies_nfs(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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 a membership between a directory and one or more NFS policies

Deletes a membership between a directory and one or more NFS policies. The policy_ids or policy_names parameter is required, but cannot be set together. The member_ids or member_names parameter is required, but cannot be set together.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy 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_directories_policies_quota(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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 a membership between a directory and one or more quota policies

Deletes a membership between a directory and one or more quota policies. The policy_ids or policy_names parameter is required, but cannot be set together. The member_ids or member_names parameter is required, but cannot be set together.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy 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_directories_policies_smb(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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 a membership between a directory and one or more SMB policies

Deletes a membership between a directory and one or more SMB policies. The policy_ids or policy_names parameter is required, but cannot be set together. The member_ids or member_names parameter is required, but cannot be set together.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy 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_directories_policies_snapshot(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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 a membership between a directory and one or more snapshot policies

Deletes a membership between a directory and one or more snapshot policies. The policy_ids or policy_names parameter is required, but cannot be set together. The member_ids or member_names parameter is required, but cannot be set together.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy 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_directories_policies_user_group_quota(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ignore_usage: Optional[StrictBool] = 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 a membership between a directory and one or more user-group-quota policies

Deletes a membership between a directory and one or more user-group-quota policies. The policy_ids or policy_names parameter is required, but cannot be set together. The member_ids or member_names parameter is required, but cannot be set together.

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.

• authorization (str) – Deprecated. Please use Client level authorization

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

• ignore_usage (bool) – Flag used to override checks for user-group-quota management operations. If set to true, user/group usage is not checked against the quota_limits of user-group-quota rules. If set to false, the impact of the user-group- quota operation is checked against the user/group usage in the managed directory and its ancestors and the operation is not allowed if the user/group usage would exceed any enforced user-group-quota limits. If not specified, defaults to false.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy 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_directory_exports(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, exports: Optional[Union[ReferenceType, List[ReferenceType]]] = None, directories: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, directory_ids: Optional[ConstrainedListValue[StrictStr]] = None, directory_names: Optional[ConstrainedListValue[StrictStr]] = None, export_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 directory exports

Deletes one or more directory exports. If any of the export_names is not unique across the system, policy_ids or policy_names must be specified to determine the exports. When server reference is not provided, the _array_server is set as effective default. The API provides two options for identifying an export object. One option is to reference it by its fully qualified export name, or alternatively, by a combination of parameters-specifically, the server_names (or server_ids) and export_names. All identifying parameters must always be provided, either explicitly or as part of the fully qualified name.

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.

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

• directories (ReferenceType or List[ReferenceType], optional) – A list of directories to query for. Overrides directory_ids and directory_names keyword arguments.

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

• authorization (str) – Deprecated. Please use Client level authorization

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

• directory_ids (List[str]) – Performs the operation on the unique managed directory IDs specified. Enter multiple managed directory IDs in comma-separated format. The directory_ids or directory_names parameter is required, but they cannot be set together.

• directory_names (List[str]) – Performs the operation on the managed directory names specified. Enter multiple full managed directory names in comma-separated format. The name is expected to be fully qualified, meaning if the object is contained in some context, the corresponding name would provide complete information about the containment hierarchy. For example, fs:dir01,pod01::fs:dir01.

• export_names (List[str]) – Performs the operation on the export names specified. Enter multiple names in comma-separated format. For example, name01,name02.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. Combines the export containment hierarchy (server), the protocol (smb or nfs) and the export_name. For example, server01::smb::export01,server01::nfs::export01.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. The name is expected to be fully qualified, meaning if the object is contained in some context, the corresponding name would provide complete information about the containment hierarchy. For example, policy01,pod01::policy01.

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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 services configuration

Deletes directory services configuration. Directory service configuration must not be referenced by any server nor enabled to be deleted. The built-in “management” directory service cannot be deleted.

Parameters

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

• authorization (str) – Deprecated. Please use Client level authorization

• 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. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. The name is expected to be fully qualified, meaning if the object is contained in some context, the corresponding name would provide complete information about the containment hierarchy. For example, name01,pod01::name01.

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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_local_directory_services(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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 local directory services

Deletes local directory services. Local directory service can’t be deleted when referenced by any server.

Parameters

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

• authorization (str) – Deprecated. Please use Client level authorization

• 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. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. The name is expected to be fully qualified, meaning if the object is contained in some context, the corresponding name would provide complete information about the containment hierarchy. For example, name01,pod01::name01.

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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_local_groups(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, local_directory_services: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, gids: Optional[ConstrainedListValue[StrictInt]] = None, local_directory_service_ids: Optional[ConstrainedListValue[StrictStr]] = None, local_directory_service_names: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, sids: 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 local groups

Deletes one or more local groups. The gids, names, or sids parameter is required, but cannot be set together.

Parameters

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

• local_directory_services (ReferenceType or List[ReferenceType], optional) – A list of local_directory_services to query for. Overrides local_directory_service_ids and local_directory_service_names keyword arguments.

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

• authorization (str) – Deprecated. Please use Client level authorization

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

• gids (List[int]) – Performs the operation on the specified GIDs. Enter multiple GIDs in comma- separated format. For example, 4234235,9681923.

• local_directory_service_ids (List[str]) – Performs the operation on the specified local directory service. Supports exactly one value. When not specified, the local directory service connected to the _array_server will be used. This cannot be provided in conjunction with the local_directory_service_names parameter.

• local_directory_service_names (List[str]) – Performs the operation on the specified local directory service. Supports exactly one value. When not specified, the local directory service connected to the _array_server will be used. This cannot be provided in conjunction with the local_directory_service_ids parameter.

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

• sids (List[str]) – Performs the operation on the object SID specified. Enter multiple SIDs in comma-separated format. For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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_local_groups_members(members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, local_directory_services: Optional[Union[ReferenceType, List[ReferenceType]]] = None, groups: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, group_gids: Optional[ConstrainedListValue[StrictInt]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, group_sids: Optional[ConstrainedListValue[StrictStr]] = None, local_directory_service_ids: Optional[ConstrainedListValue[StrictStr]] = None, local_directory_service_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictInt]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, member_sids: Optional[ConstrainedListValue[StrictStr]] = None, member_types: 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 local group membership

Deletes one or more local group memberships. The group_names, group_sids, or group_gids parameter is required, but cannot be set together. The member_names, member_sids, or member_gids parameter is required, but cannot be set together.

Parameters

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

• local_directory_services (ReferenceType or List[ReferenceType], optional) – A list of local_directory_services to query for. Overrides local_directory_service_ids and local_directory_service_names keyword arguments.

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

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

• authorization (str) – Deprecated. Please use Client level authorization

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

• group_gids (List[int]) – Performs the operation on the specified GIDs. Enter multiple GIDs in comma- separated format. For example, 4234235,9681923.

• group_names (List[str]) – Performs the operation on the group names specified. Enter multiple group names in comma-separated format. For example, group1,group2.

• group_sids (List[str]) – Performs the operation on the specified group SID. Enter multiple group SIDs in comma-separated format. For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

• local_directory_service_ids (List[str]) – Performs the operation on the specified local directory service. Supports exactly one value. When not specified, the local directory service connected to the _array_server will be used. This cannot be provided in conjunction with the local_directory_service_names parameter.

• local_directory_service_names (List[str]) – Performs the operation on the specified local directory service. Supports exactly one value. When not specified, the local directory service connected to the _array_server will be used. This cannot be provided in conjunction with the local_directory_service_ids parameter.

• member_ids (List[int]) – Performs the operation on the unique local member IDs specified. Enter multiple member IDs in comma-separated format. For local group IDs refer to group IDs (GID). For local user IDs refer to user IDs (UID). The member_ids and member_names parameters cannot be provided together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_sids (List[str]) – Performs the operation on the specified member SID. Enter multiple member SIDs in comma-separated format. For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

• member_types (List[str]) – Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include directories. Enter multiple member types in comma-separated format. For example, type01,type02.

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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_local_users(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, local_directory_services: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, local_directory_service_ids: Optional[ConstrainedListValue[StrictStr]] = None, local_directory_service_names: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, sids: Optional[ConstrainedListValue[StrictStr]] = None, uids: Optional[ConstrainedListValue[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]

Delete local users

Deletes one or more local users. The uids, names, or sids parameter is required, but cannot be set together.

Parameters

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

• local_directory_services (ReferenceType or List[ReferenceType], optional) – A list of local_directory_services to query for. Overrides local_directory_service_ids and local_directory_service_names keyword arguments.

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

• authorization (str) – Deprecated. Please use Client level authorization

• 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_directory_service_ids (List[str]) – Performs the operation on the specified local directory service. Supports exactly one value. When not specified, the local directory service connected to the _array_server will be used. This cannot be provided in conjunction with the local_directory_service_names parameter.

• local_directory_service_names (List[str]) – Performs the operation on the specified local directory service. Supports exactly one value. When not specified, the local directory service connected to the _array_server will be used. This cannot be provided in conjunction with the local_directory_service_ids parameter.

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

• sids (List[str]) – Performs the operation on the object SID specified. Enter multiple SIDs in comma-separated format. For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

• uids (List[int]) – A comma-separated list of local user IDs (UIDs). Enter multiple local user IDs in comma-separated format. For example, 423,51234.

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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_local_users_members(members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, local_directory_services: Optional[Union[ReferenceType, List[ReferenceType]]] = None, groups: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, group_gids: Optional[ConstrainedListValue[StrictInt]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, group_sids: Optional[ConstrainedListValue[StrictStr]] = None, local_directory_service_ids: Optional[ConstrainedListValue[StrictStr]] = None, local_directory_service_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictInt]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, member_sids: Optional[ConstrainedListValue[StrictStr]] = None, member_types: 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 local user membership

Deletes one or more local user memberships. The member_names, member_sids, or member_ids parameter is required, but cannot be set together.

Parameters

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

• local_directory_services (ReferenceType or List[ReferenceType], optional) – A list of local_directory_services to query for. Overrides local_directory_service_ids and local_directory_service_names keyword arguments.

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

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

• authorization (str) – Deprecated. Please use Client level authorization

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

• group_gids (List[int]) – Performs the operation on the specified GIDs. Enter multiple GIDs in comma- separated format. For example, 4234235,9681923.

• group_names (List[str]) – Performs the operation on the group names specified. Enter multiple group names in comma-separated format. For example, group1,group2.

• group_sids (List[str]) – Performs the operation on the specified group SID. Enter multiple group SIDs in comma-separated format. For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

• local_directory_service_ids (List[str]) – Performs the operation on the specified local directory service. Supports exactly one value. When not specified, the local directory service connected to the _array_server will be used. This cannot be provided in conjunction with the local_directory_service_names parameter.

• local_directory_service_names (List[str]) – Performs the operation on the specified local directory service. Supports exactly one value. When not specified, the local directory service connected to the _array_server will be used. This cannot be provided in conjunction with the local_directory_service_ids parameter.

• member_ids (List[int]) – Performs the operation on the unique local member IDs specified. Enter multiple member IDs in comma-separated format. For local group IDs refer to group IDs (GID). For local user IDs refer to user IDs (UID). The member_ids and member_names parameters cannot be provided together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_sids (List[str]) – Performs the operation on the specified member SID. Enter multiple member SIDs in comma-separated format. For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

• member_types (List[str]) – Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include directories. Enter multiple member types in comma-separated format. For example, type01,type02.

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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(names: ConstrainedListValue[StrictStr], contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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 group to management access policy mappings

Deletes one or more group to management access policy mappings.

Parameters

• names (List[str]) – Performs the operation on the unique names specified. For example, GroupRoleMappingName. Enter multiple names in comma-separated format. (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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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_directory_services_roles_policies_management_access(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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 a membership between a group to management access policy mapping and one or more management access policies

Deletes a membership between a group to management access policy mapping with one or more management access policies. One of policy_ids or policy_names is required, and one of member_ids or member_names is required.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy 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_directory_snapshots(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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 directory snapshot

Deletes a directory snapshot that has been destroyed and is pending eradication. Eradicated directory snapshots cannot be recovered. Directory snapshots are destroyed by using the PATCH method. The ids or names parameter is required, but they cannot be set together.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• 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_dns(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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]

Delete DNS configuration

Deletes DNS configuration identified by configuration name.

Parameters

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

• authorization (str) – Deprecated. Please use Client level authorization

• 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. The name is expected to be fully qualified, meaning if the object is contained in some context, the corresponding name would provide complete information about the containment hierarchy. For example, name01,pod01::name01.

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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, authorization: Optional[StrictStr] = 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

Deletes a file system that has been destroyed and is pending eradication. Eradicated file systems cannot be recovered. File systems are destroyed using the PATCH method.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• 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_fleets(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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 fleet

Deletes a fleet, permanently. 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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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. Only one value is supported.

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

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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, authorization: Optional[StrictStr] = 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]

Delete fleet members

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

• authorization (str) – Deprecated. Please use Client level authorization

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

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• 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_host_groups(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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]

Delete a host group

Deletes a host group in which the names query parameter is required.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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]) – 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_host_groups_hosts(members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, groups: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, member_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 membership from a host group

Deletes a membership from a host group. Removing a membership from a host group automatically disconnects the host from all volumes associated with the group. Hosts can be removed from host groups at any time. The group_names and member_names parameters are required and must be set together, and only one host group can be specified at a time.

Parameters

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

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

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

• authorization (str) – Deprecated. Please use Client level authorization

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

• group_names (List[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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_host_groups_protection_groups(members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, groups: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, group_ids: Optional[ConstrainedListValue[StrictStr]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, member_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 host group from a protection group

Deletes a host group member from a protection group. After the member has been removed, it is no longer protected by the group. Any protection group snapshots that were taken before the member was removed are not affected. Removing a member from a protection group does not delete the member from the array, and the member can be added back to the protection group at any time. The group_names parameter represents the name of the protection group, and the member_names parameter represents the name of the host group. The group_names and member_names parameters are required and must be set together.

Parameters

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

• groups (ReferenceType or List[ReferenceType], optional) – A list of groups to query for. Overrides group_ids and group_names keyword arguments.

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

• authorization (str) – Deprecated. Please use Client level authorization

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

• group_ids (List[str]) – A comma-separated list of group IDs.

• group_names (List[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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_host_groups_tags(resources: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, keys: Optional[ConstrainedListValue[StrictStr]] = None, namespaces: Optional[ConstrainedListValue[StrictStr]] = None, resource_ids: Optional[ConstrainedListValue[StrictStr]] = None, resource_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 tags

Deletes specified tags on host group objects.

Parameters

• resources (ReferenceType or List[ReferenceType], optional) – A list of resources to query for. Overrides resource_ids and resource_names keyword arguments.

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

• authorization (str) – Deprecated. Please use Client level authorization

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

• keys (List[str]) – A comma-separated list of tag keys.

• namespaces (List[str]) – A comma-separated list of namespaces.

• resource_ids (List[str]) – A comma-separated list of resource IDs. The resource_ids or resource_names parameter is required, but they cannot be set together.

• resource_names (List[str]) – A comma-separated list of resource names. The resource_ids or resource_names parameter is required, but they cannot be set together.

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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_hosts(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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]

Delete a host

Deletes an existing host. All volumes that are connected to the host, either through private or shared connections, must be disconnected from the host before the host can be deleted. The names query parameter is required.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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]) – 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_hosts_host_groups(members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, groups: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, member_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 membership from a host group

Deletes a membership from a host group. Deleting a membership from a host group automatically disconnects the host from all volumes associated with the group. Hosts can be deleted from host groups at any time. The group_names and member_names parameters are required and must be set together, and only one host group can be specified at a time.

Parameters

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

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

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

• authorization (str) – Deprecated. Please use Client level authorization

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

• group_names (List[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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_hosts_protection_groups(members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, groups: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, group_ids: Optional[ConstrainedListValue[StrictStr]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, member_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 host from a protection group

Deletes a host member from a protection group. After the member has been removed, it is no longer protected by the group. Any protection group snapshots that were taken before the member was removed are not affected. Removing a member from a protection group does not delete the member from the array, and the member can be added back to the protection group at any time. The group_names parameter represents the name of the protection group, and the member_names parameter represents the name of the host. The group_names and member_names parameters are required and must be set together.

Parameters

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

• groups (ReferenceType or List[ReferenceType], optional) – A list of groups to query for. Overrides group_ids and group_names keyword arguments.

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

• authorization (str) – Deprecated. Please use Client level authorization

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

• group_ids (List[str]) – A comma-separated list of group IDs.

• group_names (List[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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_hosts_tags(resources: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, keys: Optional[ConstrainedListValue[StrictStr]] = None, namespaces: Optional[ConstrainedListValue[StrictStr]] = None, resource_ids: Optional[ConstrainedListValue[StrictStr]] = None, resource_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 tags

Deletes specified tags on host objects.

Parameters

• resources (ReferenceType or List[ReferenceType], optional) – A list of resources to query for. Overrides resource_ids and resource_names keyword arguments.

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

• authorization (str) – Deprecated. Please use Client level authorization

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

• keys (List[str]) – A comma-separated list of tag keys.

• namespaces (List[str]) – A comma-separated list of namespaces.

• resource_ids (List[str]) – A comma-separated list of resource IDs. The resource_ids or resource_names parameter is required, but they cannot be set together.

• resource_names (List[str]) – A comma-separated list of resource names. The resource_ids or resource_names parameter is required, but they cannot be set together.

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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, authorization: Optional[StrictStr] = 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]

Delete KMIP server object

Deletes KMIP server objects.

Parameters

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

• authorization (str) – Deprecated. Please use Client level authorization

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

delete_log_targets_file(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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]

Delete file log target

Deletes a configured file log target.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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]) – 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_log_targets_syslog(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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]

Delete syslog server

Deletes a configured syslog server and stop forwarding syslog messages.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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]) – 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_maintenance_windows(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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]

Delete maintenance window

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

Parameters

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

• authorization (str) – Deprecated. Please use Client level authorization

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

delete_network_interfaces(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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]

Delete network interface

Deletes a network interface on a controller.

Parameters

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

• authorization (str) – Deprecated. Please use Client level authorization

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

delete_offloads(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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]

Delete offload target

Deletes an offload target.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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]) – 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_pod_replica_links(remote_pods: Optional[Union[ReferenceType, List[ReferenceType]]] = None, local_pods: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, local_pod_ids: Optional[ConstrainedListValue[StrictStr]] = None, local_pod_names: Optional[ConstrainedListValue[StrictStr]] = None, remote_pod_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_pod_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 pod replica links

Deletes pod replica links. The local_pod_names and remote_pod_names are required. Valid values are replicating, baselining, paused, unhealthy, quiescing, and quiesced. A status of replicating indicates that the source array is replicating to the target array. A status of baselining indicates that the the initial version of the dataset is being sent. During this phase, you cannot promote the target pod. In addition, changing the link direction might trigger the baselining status to recur. A status of paused ` indicates that data transfer between objects has stopped. A status of `unhealthy indicates that the link is currently unhealthy and customers must perform some health checks to determine the cause. A status of quiescing indicates that the source pod is not accepting new write requests but the most recent changes to the source have not arrived on the target. A status of quiesced indicates that the source pod has been demoted and all changes have been replicated to the target pod.

Parameters

• remote_pods (ReferenceType or List[ReferenceType], optional) – A list of remote_pods to query for. Overrides remote_pod_ids and remote_pod_names keyword arguments.

• local_pods (ReferenceType or List[ReferenceType], optional) – A list of local_pods to query for. Overrides local_pod_ids and local_pod_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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• local_pod_ids (List[str]) – A comma-separated list of local pod 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_pod_names query parameter.

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

• remote_pod_ids (List[str]) – A comma-separated list of remote pod 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_pod_names query parameter.

• remote_pod_names (List[str]) – A comma-separated list of remote pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_pod_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_pods(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, eradicate_contents: 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]

Delete a pod

Deletes a pod that has been destroyed and is pending eradication. Eradicated pods cannot be recovered. Pods are destroyed using the PATCH method. The ids or names parameter is required, but they cannot be set together.

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.

• authorization (str) – Deprecated. Please use Client level authorization

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

• eradicate_contents (bool) – Set to true to eradicate contents (e.g., volumes, protection groups, snapshots) and containers (e.g., realms, pods, volume groups). This enables you to eradicate containers with contents.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• 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_pods_arrays(members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, groups: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, group_ids: Optional[ConstrainedListValue[StrictStr]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, with_unknown: 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]

Delete a pod that was stretched to an array

Deletes a pod that was stretchd to an array, collapsing the pod to a single array. Unstretch a pod from an array when the volumes within the stretched pod no longer need to be synchronously replicated between the two arrays. After a pod has been unstretched, synchronous replication stops. A destroyed version of the pod with ‘restretch’ appended to the pod name is created on the array that no longer has the pod. The restretched pod represents a point-in-time snapshot of the pod, just before it was unstretched. The restretch pod enters an eradication pending period starting from the time that the pod was unstretched. A restretched pod can be cloned or destroyed, but it cannot be explicitly recovered. The group_names parameter represents the name of the pod to be unstretched. The member_names parameter represents the name of the array from which the pod is to be unstretched. The group_names and member_names parameters are required and must be set together. (Deprecated) Use pods/members instead.

Parameters

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

• groups (ReferenceType or List[ReferenceType], optional) – A list of groups to query for. Overrides group_ids and group_names keyword arguments.

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

• authorization (str) – Deprecated. Please use Client level authorization

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

• group_ids (List[str]) – A comma-separated list of group IDs.

• group_names (List[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• with_unknown (bool) – If set to true, unstretches the specified pod from the specified array by force. Use the with_unknown parameter in the following rare event: the local array goes offline while the pod is still stretched across two arrays, the status of the remote array becomes unknown, and there is no guarantee that the pod is online elsewhere.

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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_pods_members(pods: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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, pod_ids: Optional[ConstrainedListValue[StrictStr]] = None, pod_names: Optional[ConstrainedListValue[StrictStr]] = None, with_unknown: 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]

Delete a member from a pod

Deletes a stretched pod from an array, collapsing the pod to a member array. Unstretch a pod from an array when the volumes within the stretched pod no longer need to be synchronously replicated between the two members. After a pod has been unstretched, synchronous replication stops. A destroyed version of the pod with ‘restretch’ appended to the pod name is created on the member that no longer has the pod. The restretched pod represents a point-in-time snapshot of the pod, just before it was unstretched. The restretched pod enters an eradication pending period starting from the time that the pod was unstretched. A restretched pod can be cloned or destroyed, but it cannot be explicitly recovered. The member_names parameter represents the name of the array from which the pod is to be unstretched. Both pod and member must be specified by name or ID.

Parameters

• pods (ReferenceType or List[ReferenceType], optional) – A list of pods to query for. Overrides pod_ids and pod_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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• pod_ids (List[str]) – A comma-separated list of pod IDs.

• pod_names (List[str]) – Performs the operation on the unique pod name specified. Enter multiple names in comma-separated format. For example, pod01,pod02.

• with_unknown (bool) – If set to true, unstretches the specified pod from the specified array by force. Use the with_unknown parameter in the following rare event: the local array goes offline while the pod is still stretched across two arrays, the status of the remote array becomes unknown, and there is no guarantee that the pod is online elsewhere.

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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_pods_tags(resources: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, keys: Optional[ConstrainedListValue[StrictStr]] = None, namespaces: Optional[ConstrainedListValue[StrictStr]] = None, resource_ids: Optional[ConstrainedListValue[StrictStr]] = None, resource_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 tags

Deletes specified tags.

Parameters

• resources (ReferenceType or List[ReferenceType], optional) – A list of resources to query for. Overrides resource_ids and resource_names keyword arguments.

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

• authorization (str) – Deprecated. Please use Client level authorization

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

• keys (List[str]) – A comma-separated list of tag keys.

• namespaces (List[str]) – A comma-separated list of namespaces. Only one namespace is allowed per delete request.

• resource_ids (List[str]) – A comma-separated list of resource IDs. The resource_ids or resource_names parameter is required, but they cannot be set together.

• resource_names (List[str]) – A comma-separated list of resource names. The resource_ids or resource_names parameter is required, but they cannot be set together.

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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_alert_watcher(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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 alert-watcher policies

Deletes one or more alert-watcher policies. The ids or names parameter is required, but they cannot be set together.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• 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_policies_alert_watcher_members(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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, member_types: 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 membership between alert-watcher policies and attached object

Deletes a membership between one or more alert-watcher policies and attached object. The policy_ids or policy_names parameter is required, but cannot be set together. The member_ids or member_names parameter is required, but cannot be set together.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_types (List[str]) – Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include directories. Enter multiple member types in comma-separated format. For example, type01,type02.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy 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_policies_alert_watcher_rules(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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 alert-watcher policy rules

Deletes one or more alert-watcher policy rules. Either the ‘policy_ids’ or ‘policy_names’ parameter is required, but both parameters cannot be set together.

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.

• authorization (str) – Deprecated. Please use Client level authorization

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

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy 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_policies_audit_file(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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 policies

Deletes one or more audit policies. The ids or names parameter is required, but they cannot be set together.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• 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_policies_audit_file_members(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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, member_types: 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 membership between audit policies and managed directories

Deletes a membership between one or more audit policies and managed directories. The policy_ids or policy_names parameter is required, but cannot be set together. The member_ids or member_names parameter is required, but cannot be set together.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_types (List[str]) – Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include directories. Enter multiple member types in comma-separated format. For example, type01,type02.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy 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_policies_autodir(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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 auto managed directory policies

Deletes one or more auto managed directory policies. The ids or names parameter is required, but they cannot be set together.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• 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_policies_autodir_members(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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, member_types: 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 auto managed directory policies

Deletes one or more auto managed directory policies from resources. The policy_ids or policy_names parameter is required, but they cannot be set together. The member_ids or member_names parameter is required, but they cannot be set together.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_types (List[str]) – Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include directories. Enter multiple member types in comma-separated format. For example, type01,type02.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy 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_policies_management_access(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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 management access policies

Deletes one or more management access policies. One of ids or names is required.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• 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_policies_management_access_members(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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, member_types: 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 membership between management access policies and attached object

Deletes a membership between one or more management access policies and attached object. One of policy_ids or policy_names is required, as well as one of member_ids or member_names. member_types is required.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_types (List[str]) – Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include directories. Enter multiple member types in comma-separated format. For example, type01,type02.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in a comma-separated format.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy 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_policies_nfs(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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 NFS policies

Deletes one or more NFS policies. The ids or names parameter is required, but they cannot be set together.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• 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_policies_nfs_client_rules(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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 NFS client policy rules.

Deletes one or more NFS client policy rules. The policy_ids or policy_names parameter is required, but cannot be set together.

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.

• authorization (str) – Deprecated. Please use Client level authorization

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

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy 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_policies_nfs_members(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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, member_types: 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 NFS policies

Deletes one or more NFS policies from resources. The policy_ids or policy_names parameter is required, but cannot be set together. The member_ids or member_names parameter is required, but cannot be set together.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_types (List[str]) – Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include directories. Enter multiple member types in comma-separated format. For example, type01,type02.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy 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_policies_quota(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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 quota policies

Deletes one or more quota policies. The ids or names parameter is required, but they cannot be set together.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• 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_policies_quota_members(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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, member_types: 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 membership between quota policies and managed directories

Deletes a membership between one or more quota policies and managed directories. The policy_ids or policy_names parameter is required, but cannot be set together. The member_ids or member_names parameter is required, but cannot be set together.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_types (List[str]) – Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include directories. Enter multiple member types in comma-separated format. For example, type01,type02.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy 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_policies_quota_rules(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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 quota policy rules

Deletes one or more quota policy rules. The policy_ids or policy_names parameter is required, but they cannot be set together.

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.

• authorization (str) – Deprecated. Please use Client level authorization

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

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy 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_policies_smb(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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 policies

Deletes one or more SMB policies. The ids or names parameter is required, but they cannot be set together.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. The name is expected to be fully qualified, meaning if the object is contained in some context, the corresponding name would provide complete information about the containment hierarchy. For example, name01,pod01::name01.

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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_smb_client_rules(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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 SMB client policy rules.

Deletes one or more SMB client policy rules. The policy_ids or policy_names parameter is required, but they cannot be set together.

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.

• authorization (str) – Deprecated. Please use Client level authorization

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

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy 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_policies_smb_members(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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, member_types: 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 policies

Deletes one or more SMB policies from resources. The policy_ids or policy_names parameter is required, but cannot be set together. The member_ids or member_names parameter is required, but cannot be set together.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_types (List[str]) – Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include directories. Enter multiple member types in comma-separated format. For example, type01,type02.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy 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_policies_snapshot(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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 snapshot policies

Deletes one or more snapshot policies. The ids or names parameter is required, but they cannot be set together.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• 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_policies_snapshot_members(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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, member_types: 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 snapshot policies

Deletes one or more snapshot policies from resources. The policy_ids or policy_names parameter is required, but cannot be set together. The member_ids or member_names parameter is required, but cannot be set together.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_types (List[str]) – Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include directories. Enter multiple member types in comma-separated format. For example, type01,type02.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy 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_policies_snapshot_rules(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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 snapshot policy rules

Deletes one or more snapshot policy rules. The policy_ids or policy_names parameter is required, but cannot be set together.

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.

• authorization (str) – Deprecated. Please use Client level authorization

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

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy 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_policies_user_group_quota(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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 user-group-quota policies

Deletes one or more user-group-quota policies. The ids or names parameter is required, but they cannot be set together.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• 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_policies_user_group_quota_members(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ignore_usage: Optional[StrictBool] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, member_types: 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 membership between user-group-quota policies and managed directories

Deletes a membership between one or more user-group-quota policies and managed directories. The policy_ids or policy_names parameter is required, but cannot be set together. The member_ids or member_names parameter is required, but cannot be set together.

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.

• authorization (str) – Deprecated. Please use Client level authorization

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

• ignore_usage (bool) – Flag used to override checks for user-group-quota management operations. If set to true, user/group usage is not checked against the quota_limits of user-group-quota rules. If set to false, the impact of the user-group- quota operation is checked against the user/group usage in the managed directory and its ancestors and the operation is not allowed if the user/group usage would exceed any enforced user-group-quota limits. If not specified, defaults to false.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_types (List[str]) – Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include directories. Enter multiple member types in comma-separated format. For example, type01,type02.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy 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_policies_user_group_quota_rules(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ignore_usage: 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]

Delete quota policy rules

Deletes one or more user-group-quota policy rules. The policy_ids or policy_names parameter is required, but they cannot be set together.

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.

• authorization (str) – Deprecated. Please use Client level authorization

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

• ignore_usage (bool) – Flag used to override checks for user-group-quota management operations. If set to true, user/group usage is not checked against the quota_limits of user-group-quota rules. If set to false, the impact of the user-group- quota operation is checked against the user/group usage in the managed directory and its ancestors and the operation is not allowed if the user/group usage would exceed any enforced user-group-quota limits. If not specified, defaults to false.

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

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy 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_presets_workload(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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 a workload preset

Deletes a workload preset permanently. The ids or names parameter is required, but they cannot be set together.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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]) – Performs the operation on the unique resource IDs specified. Only one value is supported.

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

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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_protection_group_snapshots(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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 a protection group snapshot

Deletes a protection group snapshot that has been destroyed and is pending eradication. Eradicating a protection group snapshot eradicates all of its protection group snapshots and cannot be recovered. Protection group snapshots are destroyed through the PATCH method. The names or ids parameter is required, but they cannot be set together.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• 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_protection_group_snapshots_tags(resources: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, keys: Optional[ConstrainedListValue[StrictStr]] = None, namespaces: Optional[ConstrainedListValue[StrictStr]] = None, resource_ids: Optional[ConstrainedListValue[StrictStr]] = None, resource_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 tags

Deletes specified tags.

Parameters

• resources (ReferenceType or List[ReferenceType], optional) – A list of resources to query for. Overrides resource_ids and resource_names keyword arguments.

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

• authorization (str) – Deprecated. Please use Client level authorization

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

• keys (List[str]) – A comma-separated list of tag keys.

• namespaces (List[str]) – A comma-separated list of namespaces. Only one namespace is allowed per delete request.

• resource_ids (List[str]) – A comma-separated list of resource IDs. The resource_ids or resource_names parameter is required, but they cannot be set together.

• resource_names (List[str]) – A comma-separated list of resource names. The resource_ids or resource_names parameter is required, but they cannot be set together.

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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_protection_groups(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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 a protection group

Deletes a protection group that has been destroyed and is pending eradication. Eradicated protection groups cannot be recovered. Protection groups are destroyed through the PATCH method. The names parameter is required.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• 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_protection_groups_host_groups(members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, groups: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, group_ids: Optional[ConstrainedListValue[StrictStr]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, member_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 host group from a protection group

Deletes a host group member from a protection group. After the member has been removed, it is no longer protected by the group. Protection group snapshots taken before the member was removed will not be affected. Removing a member from a protection group does not delete the member from the array, and the member can be added back to the protection group at any time. The group_names parameter represents the name of the protection group, and the member_names parameter represents the name of the host group. The group_names and member_names parameters are required and must be set together.

Parameters

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

• groups (ReferenceType or List[ReferenceType], optional) – A list of groups to query for. Overrides group_ids and group_names keyword arguments.

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

• authorization (str) – Deprecated. Please use Client level authorization

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

• group_ids (List[str]) – A comma-separated list of group IDs.

• group_names (List[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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_protection_groups_hosts(members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, groups: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, group_ids: Optional[ConstrainedListValue[StrictStr]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, member_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 host from a protection group

Deletes a host member from a protection group. After the member has been removed, it is no longer protected by the group. Any protection group snapshots that were taken before the member was removed will not be affected. Removing a member from a protection group does not delete the member from the array, and the member can be added back to the protection group at any time. The group_names parameter represents the name of the protection group, and the member_names parameter represents the name of the host. The group_names and member_names parameters are required and must be set together.

Parameters

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

• groups (ReferenceType or List[ReferenceType], optional) – A list of groups to query for. Overrides group_ids and group_names keyword arguments.

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

• authorization (str) – Deprecated. Please use Client level authorization

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

• group_ids (List[str]) – A comma-separated list of group IDs.

• group_names (List[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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_protection_groups_tags(resources: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, keys: Optional[ConstrainedListValue[StrictStr]] = None, namespaces: Optional[ConstrainedListValue[StrictStr]] = None, resource_ids: Optional[ConstrainedListValue[StrictStr]] = None, resource_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 tags

Deletes specified tags.

Parameters

• resources (ReferenceType or List[ReferenceType], optional) – A list of resources to query for. Overrides resource_ids and resource_names keyword arguments.

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

• authorization (str) – Deprecated. Please use Client level authorization

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

• keys (List[str]) – A comma-separated list of tag keys.

• namespaces (List[str]) – A comma-separated list of namespaces. Only one namespace is allowed per delete request.

• resource_ids (List[str]) – A comma-separated list of resource IDs. The resource_ids or resource_names parameter is required, but they cannot be set together.

• resource_names (List[str]) – A comma-separated list of resource names. The resource_ids or resource_names parameter is required, but they cannot be set together.

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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_protection_groups_targets(members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, groups: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, group_ids: Optional[ConstrainedListValue[StrictStr]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_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 target from a protection group

Deletes an array, pod, or offload target from a protection group. The group_names parameter represents the name of the protection group. The member_names parameter represents the name of the array, pod, or offload target that is being removed from the protection group. The group_names and member_names parameters are required and must be set together.

Parameters

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

• groups (ReferenceType or List[ReferenceType], optional) – A list of groups to query for. Overrides group_ids and group_names keyword arguments.

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

• authorization (str) – Deprecated. Please use Client level authorization

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

• group_ids (List[str]) – A comma-separated list of group IDs.

• group_names (List[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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_protection_groups_volumes(members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, groups: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, group_ids: Optional[ConstrainedListValue[StrictStr]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_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 volume from a protection group

Deletes a volume member from a protection group. After the member has been deleted, it is no longer protected by the group. Any protection group snapshots that were taken before the member was deleted are not affected. Deleting a member from a protection group does not delete the member from the array, and the member can be added back to the protection group at any time. The group_names parameter represents the name of the protection group, and the member_names and member_ids parameters represent the names or IDs of the volume. The group_names parameter, and either the member_names or member_ids parameters are required and must be set together.

Parameters

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

• groups (ReferenceType or List[ReferenceType], optional) – A list of groups to query for. Overrides group_ids and group_names keyword arguments.

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

• authorization (str) – Deprecated. Please use Client level authorization

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

• group_ids (List[str]) – A comma-separated list of group IDs.

• group_names (List[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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_realms(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, eradicate_contents: 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]

Delete realms

Deletes realms that have been destroyed and are pending eradication. Eradicated realms cannot be recovered. Realms are destroyed using the PATCH method.

Parameters

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

• authorization (str) – Deprecated. Please use Client level authorization

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

• eradicate_contents (bool) – Set to true to eradicate contents (e.g., volumes, protection groups, snapshots) and containers (e.g., realms, pods, volume groups). This enables you to eradicate containers with contents.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• 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_realms_tags(resources: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, keys: Optional[ConstrainedListValue[StrictStr]] = None, namespaces: Optional[ConstrainedListValue[StrictStr]] = None, resource_ids: Optional[ConstrainedListValue[StrictStr]] = None, resource_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 tags

Deletes specified tags.

Parameters

• resources (ReferenceType or List[ReferenceType], optional) – A list of resources to query for. Overrides resource_ids and resource_names keyword arguments.

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

• authorization (str) – Deprecated. Please use Client level authorization

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

• keys (List[str]) – A comma-separated list of tag keys.

• namespaces (List[str]) – A comma-separated list of namespaces. Only one namespace is allowed per delete request.

• resource_ids (List[str]) – A comma-separated list of resource IDs. The resource_ids or resource_names parameter is required, but they cannot be set together.

• resource_names (List[str]) – A comma-separated list of resource names. The resource_ids or resource_names parameter is required, but they cannot be set together.

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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_remote_protection_group_snapshots(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, on: 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 remote protection group snapshot

Deletes a remote protection group snapshot that has been destroyed and is pending eradication. Eradicated remote protection group snapshots cannot be recovered. Remote protection group snapshots are destroyed using the PATCH method. The names parameter represents the name of the protection group snapshot. The on parameter represents the name of the offload target. The names and on parameters are required and must be used together.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

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

• on (str) – Performs the operation on the target name specified. For example, targetName01.

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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_remote_protection_groups(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, on: 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 remote protection group

Deletes a remote protection group that has been destroyed and is pending eradication. Eradicated remote protection groups cannot be recovered. Remote protection groups are destroyed through the PATCH method. The on parameter represents the name of the offload target. The ids or names parameter and the on parameter are required and must be used together.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

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

• on (str) – Performs the operation on the target name specified. For example, targetName01.

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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_remote_volume_snapshots(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, on: Optional[StrictStr] = None, replication_snapshot: 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]

Delete a remote volume snapshot

Deletes a remote volume snapshot that has been destroyed and is pending eradication. Eradicated remote volume snapshots cannot be recovered. Remote volume snapshots are destroyed through the PATCH method. The names parameter represents the name of the volume snapshot. The on parameter represents the name of the offload target. The names and on parameters are required and must be used together.

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.

• authorization (str) – Deprecated. Please use Client level authorization

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

• on (str) – Performs the operation on the target name specified. For example, targetName01.

• replication_snapshot (bool) – If set to true, allow destruction/eradication of snapshots in use by replication. If set to false, allow destruction/eradication of snapshots not in use by replication. 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_resource_accesses(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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 a resource access configuration

Deletes a resource access object.

Parameters

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

• authorization (str) – Deprecated. Please use Client level authorization

• 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. Enter multiple resource IDs in comma-separated format.

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, cascade_delete: 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 server

Deletes a server.

Parameters

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

• authorization (str) – Deprecated. Please use Client level authorization

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

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

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. The name is expected to be fully qualified, meaning if the object is contained in some context, the corresponding name would provide complete information about the containment hierarchy. For example, name01,pod01::name01.

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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, authorization: Optional[StrictStr] = 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]

Delete SNMP manager

Deletes the SNMP manager object and stops communication with specified managers.

Parameters

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

• authorization (str) – Deprecated. Please use Client level authorization

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

delete_software(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, 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]

Delete a software package

Deletes a software package specified by software name and version. A software package being used for an installation can be deleted if the installation is downloading, downloaded, aborted, or finished. If the software package is currently downloading, the download will be cancelled.

Parameters

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

• authorization (str) – Deprecated. Please use Client level authorization

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

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

delete_software_check(softwares: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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]

Delete a software check task

Deletes a software check task specified by software name and version. The check task must be queued. If the check task is running or passed/failed then the task cannot be deleted.

Parameters

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

• authorization (str) – Deprecated. Please use Client level authorization

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

delete_sso_saml2_idps(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• 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_subnets(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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]

Delete subnet

Deletes subnets. A subnet can only be deleted if it has no interfaces. Interfaces must be removed by using the network-interfaces endpoint.

Parameters

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

• authorization (str) – Deprecated. Please use Client level authorization

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

delete_syslog_servers(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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]

Delete syslog server

Deletes a configured syslog server and stops forwarding syslog messages.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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]) – 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_vchost_connections(vchosts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, protocol_endpoints: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, all_vchosts: Optional[StrictBool] = None, protocol_endpoint_ids: Optional[ConstrainedListValue[StrictStr]] = None, protocol_endpoint_names: Optional[ConstrainedListValue[StrictStr]] = None, vchost_ids: Optional[ConstrainedListValue[StrictStr]] = None, vchost_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 the vchost-connection between a protocol endpoint and its vchost

Deletes the vchost-connection between a protocol endpoint and its vchost. The storage container represented by the protocol endpoint will no longer be visible to the vCenter represented by the vchost. One of the protocol_endpoint_names or protocol_endpoint_ids query parameters, and one of the vchost_names or vchost_ids query parameters are required. But if all_vchosts is set to true, vchost_names and vchost_ids should not be specified.

Parameters

• vchosts (ReferenceType or List[ReferenceType], optional) – A list of vchosts to query for. Overrides vchost_ids and vchost_names keyword arguments.

• protocol_endpoints (ReferenceType or List[ReferenceType], optional) – A list of protocol_endpoints to query for. Overrides protocol_endpoint_ids and protocol_endpoint_names keyword arguments.

• authorization (str) – Deprecated. Please use Client level authorization

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

• all_vchosts (bool) – If set to true, the storage container represented by the protocol endpoint is accessible to all vchosts. Users should not specify vchost_ids or vchost_names in the request. If set to false, the storage container represented by the protocol endpoint is only accessible to the vchosts that have explicit vchost-connections with the protocol endpoint. Users need to specify vchost_ids or vchost_names in the request.

• protocol_endpoint_ids (List[str]) – A comma-separated list of protocol endpoint IDs. Performs the operation on the protocol endpoints specified. For example, peid01,peid02. Cannot be used in conjunction with protocol_endpoint_names. If the list contains more than one value, then vchost_ids or vchost_names must have exactly one value.

• protocol_endpoint_names (List[str]) – A comma-separated list of protocol endpoint names. Performs the operation on the protocol endpoints specified. For example, pe01,pe02. Cannot be used in conjunction with protocol_endpoint_ids. If the list contains more than one value, then vchost_ids or vchost_names must have exactly one value.

• vchost_ids (List[str]) – A comma-separated list of vchost IDs. Performs the operation on the vchosts specified. For example, vchostid01,vchostid02. Cannot be used in conjunction with vchost_names. If the list contains more than one value, then protocol_endpoint_ids or protocol_endpoint_names must have exactly one value.

• vchost_names (List[str]) – A comma-separated list of vchost names. Performs the operation on the vchosts specified. For example, vchost01,vchost02. Cannot be used in conjunction with vchost_ids. If the list contains more than one value, then protocol_endpoint_ids or protocol_endpoint_names must have 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_vchosts(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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 vchost

Deletes an existing vchost. The names or ids query parameter is required.

Parameters

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

• authorization (str) – Deprecated. Please use Client level authorization

• 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. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• 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_vchosts_certificates(vchosts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, certificates: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, certificate_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, vchost_ids: Optional[ConstrainedListValue[StrictStr]] = None, vchost_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 vchost certificate

Deletes an existing vchost certificate. The ids query parameter alone, or the certificate_names query parameter together with one of vchost_names or vchost_ids, is required.

Parameters

• vchosts (ReferenceType or List[ReferenceType], optional) – A list of vchosts to query for. Overrides vchost_ids and vchost_names keyword arguments.

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

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

• authorization (str) – Deprecated. Please use Client level authorization

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

• certificate_names (List[str]) – The names of one or more certificates. Enter multiple names in comma-separated format. For example, cert01,cert02.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• vchost_ids (List[str]) – Performs the operation on the unique vchost IDs specified. Enter multiple vchost IDs in a comma-separated format. For example, vchostid01,vchostid02.

• vchost_names (List[str]) – Performs the operation on the unique vchost name specified. Enter multiple names in a comma-separated format. For example, vchost01,vchost02.

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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_vchosts_endpoints(vchosts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, endpoints: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, vchost_ids: Optional[ConstrainedListValue[StrictStr]] = None, vchost_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 vchost endpoint

Deletes an existing vchost endpoint The ids query parameter alone, or the endpoints query parameter together with one of vchost_names or vchost_ids, is required.

Parameters

• vchosts (ReferenceType or List[ReferenceType], optional) – A list of vchosts to query for. Overrides vchost_ids and vchost_names keyword arguments.

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

• authorization (str) – Deprecated. Please use Client level authorization

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

• endpoints (List[str]) – Performs the operation on the unique endpoints specified. Enter multiple endpoints in a comma-separated format.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• vchost_ids (List[str]) – Performs the operation on the unique vchost IDs specified. Enter multiple vchost IDs in a comma-separated format. For example, vchostid01,vchostid02.

• vchost_names (List[str]) – Performs the operation on the unique vchost name specified. Enter multiple names in a comma-separated format. For example, vchost01,vchost02.

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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_volume_groups(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, eradicate_contents: 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]

Delete a volume group

Deletes a volume group that has been destroyed and is pending eradication. Eradicated volume groups cannot be recovered. Volume groups are destroyed through the PATCH method. The ids or names parameter is required, but they cannot be set together.

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.

• authorization (str) – Deprecated. Please use Client level authorization

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

• eradicate_contents (bool) – Set to true to eradicate contents (e.g., volumes, protection groups, snapshots) and containers (e.g., realms, pods, volume groups). This enables you to eradicate containers with contents.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• 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_volume_groups_tags(resources: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, keys: Optional[ConstrainedListValue[StrictStr]] = None, namespaces: Optional[ConstrainedListValue[StrictStr]] = None, resource_ids: Optional[ConstrainedListValue[StrictStr]] = None, resource_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 tags

Deletes specified tags.

Parameters

• resources (ReferenceType or List[ReferenceType], optional) – A list of resources to query for. Overrides resource_ids and resource_names keyword arguments.

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

• authorization (str) – Deprecated. Please use Client level authorization

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

• keys (List[str]) – A comma-separated list of tag keys.

• namespaces (List[str]) – A comma-separated list of namespaces. Only one namespace is allowed per delete request.

• resource_ids (List[str]) – A comma-separated list of resource IDs. The resource_ids or resource_names parameter is required, but they cannot be set together.

• resource_names (List[str]) – A comma-separated list of resource names. The resource_ids or resource_names parameter is required, but they cannot be set together.

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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_volume_snapshots(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, replication_snapshot: 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]

Delete a volume snapshot

Deletes a volume snapshot that has been destroyed and is pending eradication. Eradicated volume snapshots cannot be recovered. Volume snapshots are destroyed by using the PATCH method. The ids or names parameter is required, but they cannot be set together.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

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

• replication_snapshot (bool) – If set to true, allow destruction/eradication of snapshots in use by replication. If set to false, allow destruction/eradication of snapshots not in use by replication. 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_volume_snapshots_tags(resources: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, keys: Optional[ConstrainedListValue[StrictStr]] = None, namespaces: Optional[ConstrainedListValue[StrictStr]] = None, resource_ids: Optional[ConstrainedListValue[StrictStr]] = None, resource_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 tags

Deletes specified tags.

Parameters

• resources (ReferenceType or List[ReferenceType], optional) – A list of resources to query for. Overrides resource_ids and resource_names keyword arguments.

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

• authorization (str) – Deprecated. Please use Client level authorization

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

• keys (List[str]) – A comma-separated list of tag keys.

• namespaces (List[str]) – A comma-separated list of namespaces. Only one namespace is allowed per delete request.

• resource_ids (List[str]) – A comma-separated list of resource IDs. The resource_ids or resource_names parameter is required, but they cannot be set together.

• resource_names (List[str]) – A comma-separated list of resource names. The resource_ids or resource_names parameter is required, but they cannot be set together.

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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_volumes(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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 a volume

Deletes a volume that has been destroyed and is pending eradication. Eradicated volumes cannot be recovered. Volumes are destroyed using the PATCH method. The ids or names parameter is required, but they cannot be set together.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• 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_volumes_protection_groups(members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, groups: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, group_ids: Optional[ConstrainedListValue[StrictStr]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_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 volume from a protection group

Deletes a volume member from a protection group. After the member has been deleted, it is no longer protected by the group. Any protection group snapshots that were taken before the member was deleted are not affected. Deleting a member from a protection group does not delete the member from the array, and the member can be added back to the protection group at any time. The group_names parameter represents the name of the protection group, and the member_names and member_ids parameters represent the names or IDs of the volume. The group_names and only one of member_names or member_ids parameters are required and must be set together.

Parameters

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

• groups (ReferenceType or List[ReferenceType], optional) – A list of groups to query for. Overrides group_ids and group_names keyword arguments.

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

• authorization (str) – Deprecated. Please use Client level authorization

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

• group_ids (List[str]) – A comma-separated list of group IDs.

• group_names (List[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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_volumes_tags(resources: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, keys: Optional[ConstrainedListValue[StrictStr]] = None, namespaces: Optional[ConstrainedListValue[StrictStr]] = None, resource_ids: Optional[ConstrainedListValue[StrictStr]] = None, resource_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 tags

Deletes specified tags.

Parameters

• resources (ReferenceType or List[ReferenceType], optional) – A list of resources to query for. Overrides resource_ids and resource_names keyword arguments.

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

• authorization (str) – Deprecated. Please use Client level authorization

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

• keys (List[str]) – A comma-separated list of tag keys.

• namespaces (List[str]) – A comma-separated list of namespaces. Only one namespace is allowed per delete request.

• resource_ids (List[str]) – A comma-separated list of resource IDs. The resource_ids or resource_names parameter is required, but they cannot be set together.

• resource_names (List[str]) – A comma-separated list of resource names. The resource_ids or resource_names parameter is required, but they cannot be set together.

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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_workloads(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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 a workload

Deletes a workload that has been destroyed and is pending eradication. Eradicated workloads cannot be recovered. Workloads are destroyed using the PATCH method. The ids or names parameter is required, but they cannot be set together.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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]) – Performs the operation on the unique resource IDs specified. Only one value is supported.

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

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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_workloads_tags(resources: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, keys: Optional[ConstrainedListValue[StrictStr]] = None, namespaces: Optional[ConstrainedListValue[StrictStr]] = None, resource_ids: Optional[ConstrainedListValue[StrictStr]] = None, resource_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 tags

Deletes specified tags.

Parameters

• resources (ReferenceType or List[ReferenceType], optional) – A list of resources to query for. Overrides resource_ids and resource_names keyword arguments.

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

• authorization (str) – Deprecated. Please use Client level authorization

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

• keys (List[str]) – A comma-separated list of tag keys.

• namespaces (List[str]) – A comma-separated list of namespaces. Only one namespace is allowed per delete request.

• resource_ids (List[str]) – A comma-separated list of resource IDs. The resource_ids or resource_names parameter is required, but they cannot be set together.

• resource_names (List[str]) – A comma-separated list of resource names. The resource_ids or resource_names parameter is required, but they cannot be set together.

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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_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, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = 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 Active Directory accounts

Displays configured Active Directory accounts.

Parameters

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

• authorization (str) – Deprecated. Please use Client level authorization

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. The name is expected to be fully qualified, meaning if the object is contained in some context, the corresponding name would provide complete information about the containment hierarchy. For example, name01,pod01::name01.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_admins(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, expose_api_token: Optional[StrictBool] = None, expose_public_key: Optional[StrictBool] = None, filter: Optional[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = 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 administrators

Displays a list of administrators.

Parameters

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

• authorization (str) – Deprecated. Please use Client level authorization

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

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

• expose_public_key (bool) – If true, exposes the public key of the current user.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_admins_api_tokens(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, expose_api_token: Optional[StrictBool] = None, filter: Optional[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = 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 API tokens

Displays API tokens for the specified administrators.

Parameters

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

• authorization (str) – Deprecated. Please use Client level authorization

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

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

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_admins_cache(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = 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 administrator cache entries

Displays entries in the administrator cache.

Parameters

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

• authorization (str) – Deprecated. Please use Client level authorization

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_admins_policies_management_access(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = 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, 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 management access policies attached to administrators

Displays a list of management access policies that are attached to administrators.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_admins_settings(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = 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 administrator settings

Displays the global administrator settings for the array.

Parameters

• authorization (str) – Deprecated. Please use Client level authorization

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

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_alert_watchers(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = 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 alert watchers

Displays alert watcher email addressess and indicates whether they are enabled.

Parameters

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

• authorization (str) – Deprecated. Please use Client level authorization

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_alert_watchers_test(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = 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 alert watcher test

Displays alert watcher email test results.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_alerts(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = None, flagged: Optional[StrictBool] = 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_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 alerts

Displays a list of alerts.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• flagged (bool) – If set to true, lists only flagged messages. If set to false, lists only unflagged messages. if not specified, lists all messages.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_alerts_events(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = None, flagged: Optional[StrictBool] = 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_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 alert events

Displays a list of alert events.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• flagged (bool) – If set to true, lists only flagged messages. If set to false, lists only unflagged messages. if not specified, lists all messages.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. For example, name01. Enter multiple names in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_alerts_rules(contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, code: Optional[StrictInt] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = 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 custom alert rules

Displays a list of custom alert rules.

Parameters

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

• authorization (str) – Deprecated. Please use Client level authorization

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

• code (int) – The alert code to display.

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_alerts_rules_catalog(contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, code: Optional[StrictInt] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = 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 available customizable alert codes

Displays a list of available customizable alert codes.

Parameters

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

• authorization (str) – Deprecated. Please use Client level authorization

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

• code (int) – The alert code to display.

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_api_clients(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = 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_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 API clients

Displays a list of API clients.

Parameters

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

• authorization (str) – Deprecated. Please use Client level authorization

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

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_apps(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = 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 apps

Displays a list of installed apps.

Parameters

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

• authorization (str) – Deprecated. Please use Client level authorization

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_apps_nodes(apps: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, app_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = 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 app nodes

Displays a list of installed apps and their nodes.

Parameters

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

• authorization (str) – Deprecated. Please use Client level authorization

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

• app_names (List[str]) – The name of the installed app. Enter multiple names in comma-separated format.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_array_connections(remotes: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, 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_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 the connected arrays

Displays a list 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 and names keyword arguments.

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

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects 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, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_ids query parameter.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_array_connections_connection_key(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, encrypted: 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 connection key

Displays the connection key for the array.

Parameters

• authorization (str) – Deprecated. Please use Client level authorization

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

• encrypted (bool) – If true, the returned array connection key will encode an encryption key used to establish trust and secure replication traffic. If false, the returned array connection key will not encode an encryption key. 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_array_connections_path(remotes: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, 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_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 connection path

Displays the connection path from the array to which the connection was made.

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.

• authorization (str) – Deprecated. Please use Client level authorization

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects 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, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_ids query parameter.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_arrays(contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = 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 arrays

Displays general array properties including the array name, login banner, idle timeout for management sessions, and NTP servers.

Parameters

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

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_arrays_cloud_capacity(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = 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 CBS array capacity status

Displays the capacity status of the CBS array including the progress of the capacity update. Requests for non-CBS arrays will receive an error response.

Parameters

• authorization (str) – Deprecated. Please use Client level authorization

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

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_arrays_cloud_capacity_supported_steps(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = 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 CBS array capacity steps

Displays the list of supported raw capacity sizes in bytes the CBS array can be upgraded to. Requests for non-CBS arrays will receive an error response.

Parameters

• authorization (str) – Deprecated. Please use Client level authorization

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_arrays_cloud_config(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = 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 CBS array configuration status

Displays the configuration status of the CBS array, including the progress of the configuration upgrade. Requests for non-CBS arrays will receive an error response.

Parameters

• authorization (str) – Deprecated. Please use Client level authorization

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

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_arrays_cloud_config_supported_configs(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = 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 CBS array supported upgrade target configs

Displays the list of supported configurations to which the CBS array can be upgraded. Requests for non-CBS arrays will receive an error response.

Parameters

• authorization (str) – Deprecated. Please use Client level authorization

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_arrays_cloud_provider_tags(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = 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 user tags on the cloud.

Displays the list of user tags on deployed cloud resources of a CBS array.

Parameters

• authorization (str) – Deprecated. Please use Client level authorization

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_arrays_erasures(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = 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 factory reset details

Displays a list of factory reset processes.

Parameters

• authorization (str) – Deprecated. Please use Client level authorization

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

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_arrays_eula(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = 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 End User Agreement and signature

Displays the End User Agreement and signature.

Parameters

• authorization (str) – Deprecated. Please use Client level authorization

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

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_arrays_factory_reset_token(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = 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 factory reset tokens

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

Parameters

• authorization (str) – Deprecated. Please use Client level authorization

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

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_arrays_ntp_test(authorization: Optional[StrictStr] = 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]

List NTP test results

Displays test results for configured NTP servers.

Parameters

• authorization (str) – Deprecated. Please use Client level authorization

• 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_arrays_performance(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, end_time: Optional[StrictInt] = None, filter: Optional[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, protocol: Optional[StrictStr] = None, protocol_group: Optional[StrictStr] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[StrictInt] = 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 array front-end performance data

Displays real-time and historical front-end performance data at the array level including latency, bandwidth, IOPS, average I/O size, and queue depth.

Parameters

• authorization (str) – Deprecated. Please use Client level authorization

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

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• protocol (str) – Protocol type. Valid values are nfs, smb, and all.

• protocol_group (str) – Protocol group type. Valid values are block, file, and all.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• 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_arrays_performance_by_link(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, end_time: Optional[StrictInt] = None, filter: Optional[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[StrictInt] = 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 array front-end IO performance data by link

Displays real-time and historical front-end performance data at the array level including latency, bandwidth, IOPS, average I/O size, and queue depth. Group output is shown by link. A link represents a set of arrays that an I/O operation depends on. For local-only I/Os, this is a local array. For mirrored I/Os, this is a set of synchronous replication peer arrays.

Parameters

• authorization (str) – Deprecated. Please use Client level authorization

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

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• 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_arrays_space(contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, end_time: Optional[StrictInt] = None, filter: Optional[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[StrictInt] = 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 array space information

Displays real-time and historical array space information including unique volume and snapshot space, shared space, data reduction, provisioned capacity, usable capacity, and parity.

Parameters

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

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• 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_arrays_tags(contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = None, namespaces: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = 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 tags

Displays the list of tags on array objects.

Parameters

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

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• namespaces (List[str]) – A comma-separated list of namespaces.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_audits(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = 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_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 audits

Displays a list of audits.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_certificate_groups(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = 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_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 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.

• authorization (str) – Deprecated. Please use Client level authorization

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_certificate_groups_certificates(certificates: Optional[Union[ReferenceType, List[ReferenceType]]] = None, certificate_groups: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = 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 certificate-groups and certificates

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

• authorization (str) – Deprecated. Please use Client level authorization

• 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 no resource matches each of the elements of certificate_group_names, then an error is returned. This cannot be provided in conjunction with the certificate_group_ids parameter.

• certificate_ids (List[str]) – 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]) – The names of one or more certificates. Enter multiple names in comma-separated format. For example, cert01,cert02.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_certificate_groups_uses(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = 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_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 certificate-groups/uses

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

• authorization (str) – Deprecated. Please use Client level authorization

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_certificates(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = 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_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 certificate attributes

Displays certificate attributes.

Parameters

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

• authorization (str) – Deprecated. Please use Client level authorization

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_certificates_certificate_groups(certificates: Optional[Union[ReferenceType, List[ReferenceType]]] = None, certificate_groups: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = 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 certificates and certificate-groups

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

• authorization (str) – Deprecated. Please use Client level authorization

• 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 no resource matches each of the elements of certificate_group_names, then an error is returned. This cannot be provided in conjunction with the certificate_group_ids parameter.

• certificate_ids (List[str]) – 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]) – The names of one or more certificates. Enter multiple names in comma-separated format. For example, cert01,cert02.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_certificates_uses(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = 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_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 certificates uses

Displays the usage and associations of certificates.

Parameters

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

• authorization (str) – Deprecated. Please use Client level authorization

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_connections(volumes: Optional[Union[ReferenceType, List[ReferenceType]]] = None, protocol_endpoints: Optional[Union[ReferenceType, List[ReferenceType]]] = None, hosts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, host_groups: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = None, host_group_names: Optional[ConstrainedListValue[StrictStr]] = None, host_names: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, protocol_endpoint_ids: Optional[ConstrainedListValue[StrictStr]] = None, protocol_endpoint_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, volume_ids: Optional[ConstrainedListValue[StrictStr]] = None, volume_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]

List volume connections

Displays a list of connections between a volume and its hosts and host groups, as well as the logical unit numbers (LUNs) or NVMe Namespace IDs (NSIDs) used by the associated hosts to address these volumes.

Parameters

• volumes (ReferenceType or List[ReferenceType], optional) – A list of volumes to query for. Overrides volume_ids and volume_names keyword arguments.

• protocol_endpoints (ReferenceType or List[ReferenceType], optional) – A list of protocol_endpoints to query for. Overrides protocol_endpoint_ids and protocol_endpoint_names keyword arguments.

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

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

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

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• host_group_names (List[str]) – Performs the operation on the host group specified. Enter multiple names in comma-separated format. A request cannot include a mix of multiple objects with multiple names. For example, a request cannot include a mix of multiple host group names and volume names; instead, at least one of the objects (e.g., host_group_names) must be set to only one name (e.g., hgroup01).

• host_names (List[str]) – Performs the operation on the hosts specified. Enter multiple names in comma- separated format. For example, host01,host02. A request cannot include a mix of multiple objects with multiple names. For example, a request cannot include a mix of multiple host names and volume names; instead, at least one of the objects (e.g., host_names) must be set to only one name (e.g., host01).

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• protocol_endpoint_ids (List[str]) – Performs the operation on the protocol endpoints specified. Enter multiple IDs in comma-separated format. For example, peid01,peid02. A request cannot include a mix of multiple objects with multiple IDs. For example, a request cannot include a mix of multiple protocol endpoint IDs and host names. Instead, at least one of the objects (e.g., protocol_endpoint_ids) must be set to one ID (e.g., peid01).

• protocol_endpoint_names (List[str]) – Performs the operation on the protocol endpoints specified. Enter multiple names in comma-separated format. For example, pe01,pe02. A request cannot include a mix of multiple objects with multiple names. For example, a request cannot include a mix of multiple protocol endpoint names and host names; instead, at least one of the objects (e.g., protocol_endpoint_names) must be set to one name (e.g., pe01).

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

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

• volume_ids (List[str]) – Performs the operation on the specified volume. Enter multiple ids in comma- separated format. For example, vol01id,vol02id. A request cannot include a mix of multiple objects with multiple IDs. For example, a request cannot include a mix of multiple volume IDs and host names; instead, at least one of the objects (e.g., volume_ids) must be set to only one name (e.g., vol01id). Only one of the two between volume_names and volume_ids may be used at a time.

• volume_names (List[str]) – Performs the operation on the volume specified. Enter multiple names in comma- separated format. For example, vol01,vol02. A request cannot include a mix of multiple objects with multiple names. For example, a request cannot include a mix of multiple volume names and host names; instead, at least one of the objects (e.g., volume_names) must be set to only one name (e.g., vol01).

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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_container_default_protections(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = 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_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 container default protections

Displays a list of containers with its default protections.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• 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. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the container ID specified. Enter multiple source IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together. Specifying ids or names with no value will perform the operation on local array.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique container name specified. Enter multiple names in comma-separated format. The ids or names parameter is required, but they cannot be set together. Specifying ids or names with no value will perform the operation on local array.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_controllers(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = 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 controller information and status

Displays the name, mode, FlashArray model, Purity//FA software version, and status of each controller in the array.

Parameters

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

• authorization (str) – Deprecated. Please use Client level authorization

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_directories(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, file_systems: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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, file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, filter: Optional[Union[StrictStr, Filter]] = 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_item_count: Optional[StrictBool] = 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 directories

Displays a list of directories, including those pending eradication.

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.

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

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• 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. For destroyed objects, the time remaining is displayed in milliseconds.

• file_system_ids (List[str]) – Performs the operation on the file system ID specified. Enter multiple file system IDs in comma-separated format. The file_system_ids or file_system_names parameter is required, but they cannot be set together.

• file_system_names (List[str]) – Performs the operation on the file system name specified. Enter multiple file system names in comma-separated format. For example, filesystem01,filesystem02.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

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

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

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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_directories_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, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = None, group_ids: Optional[ConstrainedListValue[StrictInt]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, group_sids: Optional[ConstrainedListValue[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_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 group with content in directories

Displays a list of groups, that have content in specific directories.

Parameters

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

• groups (ReferenceType or List[ReferenceType], optional) – A list of groups to query for. Overrides group_ids and group_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.

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

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• file_system_ids (List[str]) – Performs the operation on the file system ID specified. Enter multiple file system IDs in comma-separated format. The file_system_ids or file_system_names parameter is required, but they cannot be set together.

• file_system_names (List[str]) – Performs the operation on the file system name specified. Enter multiple file system names in comma-separated format. For example, filesystem01,filesystem02.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• group_ids (List[int]) – Performs the operation on the groups that match the given list of gids. Enter names in a comma-separated format, e.g., 2001,2002.

• group_names (List[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• group_sids (List[str]) – Performs the operation on the specified group SID. Enter multiple group SIDs in comma-separated format. For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_directories_performance(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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, end_time: Optional[StrictInt] = None, filter: Optional[Union[StrictStr, Filter]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, protocol: Optional[StrictStr] = None, protocol_group: Optional[StrictStr] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[StrictInt] = None, total_item_count: Optional[StrictBool] = 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 directory performance data

Displays real-time and historical performance data, real-time latency data, and average I/O sizes for each directory and as a total of all directories across the entire 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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• 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. For destroyed objects, the time remaining is displayed in milliseconds.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• protocol (str) – Protocol type. Valid values are nfs, smb, and all.

• protocol_group (str) – Protocol group type. Valid values are block, file, and all.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

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

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

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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_directories_policies(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = 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, 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 policies

Displays a list of policies that are attached to directories.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• 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. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_directories_policies_audit_file(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = 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, 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 audit policies attached to a directory

Displays a list of audit policies that are attached to directories.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• 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. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_directories_policies_autodir(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = 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, 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 auto managed directory policies attached to a directory

Displays a list of auto managed directory policies that are attached to directories.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• 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. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_directories_policies_nfs(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = 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, 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 NFS policies attached to a directory

Displays a list of NFS policies that are attached to directories.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• 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. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_directories_policies_quota(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = 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, 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 quota policies attached to a directory

Displays a list of quota policies that are attached to directories.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• 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. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_directories_policies_smb(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = 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, 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 SMB policies attached to a directory

Displays a list of SMB policies that are attached to directories.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• 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. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_directories_policies_snapshot(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = 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, 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 snapshot policies attached to a directory

Displays a list of snapshot policies that are attached to directories.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• 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. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_directories_policies_user_group_quota(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = 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, 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 user-group-quota policies attached to a directory

Displays a list of user-group-quota policies that are attached to directories.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• 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. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_directories_space(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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, end_time: Optional[StrictInt] = None, filter: Optional[Union[StrictStr, Filter]] = 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[StrictInt] = None, total_item_count: Optional[StrictBool] = 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 directory space information

Displays physical storage consumption data for each directory.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• 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. For destroyed objects, the time remaining is displayed in milliseconds.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

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

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

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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_directories_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, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = 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_item_count: Optional[StrictBool] = None, user_ids: Optional[ConstrainedListValue[StrictInt]] = None, user_names: Optional[ConstrainedListValue[StrictStr]] = None, user_sids: 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 users with content in directories

Displays a list of users that have content in specific directories.

Parameters

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

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

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

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• file_system_ids (List[str]) – Performs the operation on the file system ID specified. Enter multiple file system IDs in comma-separated format. The file_system_ids or file_system_names parameter is required, but they cannot be set together.

• file_system_names (List[str]) – Performs the operation on the file system name specified. Enter multiple file system names in comma-separated format. For example, filesystem01,filesystem02.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

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

• user_ids (List[int]) – Performs the operation on the users that match the given list of uids. Enter names in a comma-separated format, for example, 1001,1002.

• user_names (List[str]) – Performs the operation on the users that match the given list of user names. Enter names in a comma-separated format, for example, u1,u2.

• user_sids (List[str]) – Performs the operation on the users that match the given list of user SIDs. Enter SIDs in a comma-separated format, for example, S-1-1-20-1000,S-1-1-20-2002.

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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_exports(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, exports: Optional[Union[ReferenceType, List[ReferenceType]]] = None, directories: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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, directory_ids: Optional[ConstrainedListValue[StrictStr]] = None, directory_names: Optional[ConstrainedListValue[StrictStr]] = None, export_names: Optional[ConstrainedListValue[StrictStr]] = None, filter: Optional[Union[StrictStr, Filter]] = 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, 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 directory exports

Displays a list of directory exports.

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.

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

• directories (ReferenceType or List[ReferenceType], optional) – A list of directories to query for. Overrides directory_ids and directory_names keyword arguments.

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

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• 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. For destroyed objects, the time remaining is displayed in milliseconds.

• directory_ids (List[str]) – Performs the operation on the unique managed directory IDs specified. Enter multiple managed directory IDs in comma-separated format. The directory_ids or directory_names parameter is required, but they cannot be set together.

• directory_names (List[str]) – Performs the operation on the managed directory names specified. Enter multiple full managed directory names in comma-separated format. The name is expected to be fully qualified, meaning if the object is contained in some context, the corresponding name would provide complete information about the containment hierarchy. For example, fs:dir01,pod01::fs:dir01.

• export_names (List[str]) – Performs the operation on the export names specified. Enter multiple names in comma-separated format. For example, name01,name02.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. Combines the export containment hierarchy (server), the protocol (smb or nfs) and the export_name. For example, server01::smb::export01,server01::nfs::export01.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. The name is expected to be fully qualified, meaning if the object is contained in some context, the corresponding name would provide complete information about the containment hierarchy. For example, policy01,pod01::policy01.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_directory_group_quotas(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, groups: Optional[Union[ReferenceType, List[ReferenceType]]] = None, directories: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, directory_ids: Optional[ConstrainedListValue[StrictStr]] = None, directory_names: Optional[ConstrainedListValue[StrictStr]] = None, filter: Optional[Union[StrictStr, Filter]] = None, group_ids: Optional[ConstrainedListValue[StrictInt]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, group_sids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: 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 group quotas.

Displays a list of groups and the group quota rules that affect their usage limits.

Parameters

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

• groups (ReferenceType or List[ReferenceType], optional) – A list of groups to query for. Overrides group_ids and group_names keyword arguments.

• directories (ReferenceType or List[ReferenceType], optional) – A list of directories to query for. Overrides directory_ids and directory_names keyword arguments.

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

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• directory_ids (List[str]) – Performs the operation on the unique managed directory IDs specified. Enter multiple managed directory IDs in comma-separated format. The directory_ids or directory_names parameter is required, but they cannot be set together.

• directory_names (List[str]) – Performs the operation on the managed directory names specified. Enter multiple full managed directory names in comma-separated format. For example, fs:dir01,fs:dir02.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• group_ids (List[int]) – Performs the operation on the groups that match the given list of gids. Enter names in a comma-separated format, e.g., 2001,2002.

• group_names (List[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• group_sids (List[str]) – Performs the operation on the specified group SID. Enter multiple group SIDs in comma-separated format. For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_directory_quotas(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, directories: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, directory_ids: Optional[ConstrainedListValue[StrictStr]] = None, directory_names: Optional[ConstrainedListValue[StrictStr]] = None, filter: Optional[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: 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 directories with attached quota policies

Displays a list of directories and the quota policies attached to them. Directories with multiple policies are listed repeatedly (once per policy). The directories without a policy attached are not listed.

Parameters

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

• directories (ReferenceType or List[ReferenceType], optional) – A list of directories to query for. Overrides directory_ids and directory_names keyword arguments.

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

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• directory_ids (List[str]) – Performs the operation on the unique managed directory IDs specified. Enter multiple managed directory IDs in comma-separated format. The directory_ids or directory_names parameter is required, but they cannot be set together.

• directory_names (List[str]) – Performs the operation on the managed directory names specified. Enter multiple full managed directory names in comma-separated format. For example, fs:dir01,fs:dir02.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_directory_services(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = 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_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 directory services configuration

Displays the directory services configuration settings for manageability.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. The name is expected to be fully qualified, meaning if the object is contained in some context, the corresponding name would provide complete information about the containment hierarchy. For example, name01,pod01::name01.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_directory_services_local_directory_services(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = 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_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 local directory services

Displays a list of local directory services.

Parameters

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

• authorization (str) – Deprecated. Please use Client level authorization

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. The name is expected to be fully qualified, meaning if the object is contained in some context, the corresponding name would provide complete information about the containment hierarchy. For example, name01,pod01::name01.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_directory_services_local_groups(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = None, gids: Optional[ConstrainedListValue[StrictInt]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sids: 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 local groups

Displays a list of local groups.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• gids (List[int]) – Performs the operation on the specified GIDs. Enter multiple GIDs in comma- separated format. For example, 4234235,9681923.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• sids (List[str]) – Performs the operation on the object SID specified. Enter multiple SIDs in comma-separated format. For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_directory_services_local_groups_members(members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, groups: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = None, group_gids: Optional[ConstrainedListValue[StrictInt]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, group_sids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictInt]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, member_sids: Optional[ConstrainedListValue[StrictStr]] = None, member_types: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = 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 local group memberships

Displays a list of local group memberships.

Parameters

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

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

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

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• group_gids (List[int]) – Performs the operation on the specified GIDs. Enter multiple GIDs in comma- separated format. For example, 4234235,9681923.

• group_names (List[str]) – Performs the operation on the group names specified. Enter multiple group names in comma-separated format. For example, group1,group2.

• group_sids (List[str]) – Performs the operation on the specified group SID. Enter multiple group SIDs in comma-separated format. For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (List[int]) – Performs the operation on the unique local member IDs specified. Enter multiple member IDs in comma-separated format. For local group IDs refer to group IDs (GID). For local user IDs refer to user IDs (UID). The member_ids and member_names parameters cannot be provided together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_sids (List[str]) – Performs the operation on the specified member SID. Enter multiple member SIDs in comma-separated format. For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

• member_types (List[str]) – Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include directories. Enter multiple member types in comma-separated format. For example, type01,type02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_directory_services_local_users(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sids: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, uids: Optional[ConstrainedListValue[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]

List local users

Displays a list of local users.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• sids (List[str]) – Performs the operation on the object SID specified. Enter multiple SIDs in comma-separated format. For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

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

• uids (List[int]) – A comma-separated list of local user IDs (UIDs). Enter multiple local user IDs in comma-separated format. For example, 423,51234.

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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_local_users_members(members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, groups: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = None, group_gids: Optional[ConstrainedListValue[StrictInt]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, group_sids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictInt]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, member_sids: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = 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 local user memberships

Displays a list of local user memberships.

Parameters

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

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

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

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• group_gids (List[int]) – Performs the operation on the specified GIDs. Enter multiple GIDs in comma- separated format. For example, 4234235,9681923.

• group_names (List[str]) – Performs the operation on the group names specified. Enter multiple group names in comma-separated format. For example, group1,group2.

• group_sids (List[str]) – Performs the operation on the specified group SID. Enter multiple group SIDs in comma-separated format. For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (List[int]) – Performs the operation on the unique local member IDs specified. Enter multiple member IDs in comma-separated format. For local group IDs refer to group IDs (GID). For local user IDs refer to user IDs (UID). The member_ids and member_names parameters cannot be provided together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_sids (List[str]) – Performs the operation on the specified member SID. Enter multiple member SIDs in comma-separated format. For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_directory_services_roles(roles: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, role_names: 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 group to management access policy mappings

Displays access control settings for remote groups.

Parameters

• roles (ReferenceType or List[ReferenceType], optional) – A list of roles to query for. Overrides role_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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique names specified. For example, GroupRoleMappingName. Enter multiple names in comma-separated format.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• role_names (List[str]) – This field has been deprecated.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_directory_services_roles_policies_management_access(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = 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, 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 management access policies attached to a group to management access policy mapping

Displays a list of management access policies that are attached to a group to management access policy mappings.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_directory_services_test(names: ConstrainedListValue[StrictStr], contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = 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 directory services test results

Displays the directory services test and displays the results. The test verifies that URIs can be resolved and that the array can bind and query the tree using the bind user credentials. The test also verifies that the array can find all configured groups to ensure the common names and group base are correctly configured.

Parameters

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

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_directory_snapshots(sources: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = None, total_item_count: Optional[StrictBool] = 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 directory snapshots

Displays a list of directory snapshots, including those pending eradication.

Parameters

• sources (ReferenceType or List[ReferenceType], optional) – A list of sources to query for. Overrides source_ids and source_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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• 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. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• source_ids (List[str]) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

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

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

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

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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_user_quotas(users: Optional[Union[ReferenceType, List[ReferenceType]]] = None, policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, directories: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, directory_ids: Optional[ConstrainedListValue[StrictStr]] = None, directory_names: Optional[ConstrainedListValue[StrictStr]] = None, filter: Optional[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, user_ids: Optional[ConstrainedListValue[StrictInt]] = None, user_names: Optional[ConstrainedListValue[StrictStr]] = None, user_sids: 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 user quotas.

Displays a list of users and the user quota rules that affect their usage limits.

Parameters

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

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

• directories (ReferenceType or List[ReferenceType], optional) – A list of directories to query for. Overrides directory_ids and directory_names keyword arguments.

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

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• directory_ids (List[str]) – Performs the operation on the unique managed directory IDs specified. Enter multiple managed directory IDs in comma-separated format. The directory_ids or directory_names parameter is required, but they cannot be set together.

• directory_names (List[str]) – Performs the operation on the managed directory names specified. Enter multiple full managed directory names in comma-separated format. For example, fs:dir01,fs:dir02.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

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

• user_ids (List[int]) – Performs the operation on the users that match the given list of uids. Enter names in a comma-separated format, for example, 1001,1002.

• user_names (List[str]) – Performs the operation on the users that match the given list of user names. Enter names in a comma-separated format, for example, u1,u2.

• user_sids (List[str]) – Performs the operation on the users that match the given list of user SIDs. Enter SIDs in a comma-separated format, for example, S-1-1-20-1000,S-1-1-20-2002.

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = 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 DNS parameters

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

• authorization (str) – Deprecated. Please use Client level authorization

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. The name is expected to be fully qualified, meaning if the object is contained in some context, the corresponding name would provide complete information about the containment hierarchy. For example, name01,pod01::name01.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_drives(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = 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 flash, NVRAM, and cache modules

Displays a list of flash, NVRAM, and cache modules that are installed in the array along with their attributes and status.

Parameters

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

• authorization (str) – Deprecated. Please use Client level authorization

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_file_systems(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = 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_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 file systems

Displays a list of file systems, including those pending eradication.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• 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. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_fleets(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = 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_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 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.

• authorization (str) – Deprecated. Please use Client level authorization

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

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

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_fleets_fleet_key(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = 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]

Get fleet key information

Displays the time remaining on the fleet key. Note, fleet key itself is not displayed, since that is only available at time of fleet key creation.

Parameters

• authorization (str) – Deprecated. Please use Client level authorization

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_fleets_members(members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, fleets: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = 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_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 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.

• authorization (str) – Deprecated. Please use Client level authorization

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter 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) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_hardware(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = 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 hardware component information

Displays a list of hardware slots and bays and status of installed components.

Parameters

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

• authorization (str) – Deprecated. Please use Client level authorization

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

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_host_groups(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = 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 host groups

Displays a list of host groups.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• 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. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_host_groups_hosts(members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, groups: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = 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 host groups that are associated with hosts

Displays a list of host groups that are associated with hosts.

Parameters

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

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

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

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• group_names (List[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_host_groups_performance(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, end_time: Optional[StrictInt] = None, filter: Optional[Union[StrictStr, Filter]] = 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[StrictInt] = None, total_item_count: Optional[StrictBool] = 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 host group performance data

Displays real-time and historical performance data, real-time latency data, and average I/O sizes of all host groups, displayed both by host group and by total size across all host groups. This data represents volumes that are connected to the host groups on the local array and stretched volumes connected to the host groups on arrays that are connected by synchronous replication.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

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

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

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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_host_groups_performance_by_array(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, end_time: Optional[StrictInt] = None, filter: Optional[Union[StrictStr, Filter]] = 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[StrictInt] = None, total_item_count: Optional[StrictBool] = 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 host group performance data by array

Displays real-time and historical performance data, real-time latency data, and average I/O size data. The data is displayed by total size across all host groups on each array and by individual host group on each array. The displayed data represents the volumes that are connected to a host group on the current array and the volumes that are connected to a host group on any remote arrays that are visible to the current array.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

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

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

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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_host_groups_protection_groups(members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, groups: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = None, group_ids: Optional[ConstrainedListValue[StrictStr]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = 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 host groups that are members of protection groups

Displays a list of host group members that belong to one or more protection groups.

Parameters

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

• groups (ReferenceType or List[ReferenceType], optional) – A list of groups to query for. Overrides group_ids and group_names keyword arguments.

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

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• group_ids (List[str]) – A comma-separated list of group IDs.

• group_names (List[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_host_groups_space(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = 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 host group space information

Displays provisioned size and physical storage consumption data for each host group.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_host_groups_tags(resources: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = None, namespaces: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, resource_destroyed: Optional[StrictBool] = None, resource_ids: Optional[ConstrainedListValue[StrictStr]] = None, resource_names: 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 tags

Displays the list of tags on host group objects.

Parameters

• resources (ReferenceType or List[ReferenceType], optional) – A list of resources to query for. Overrides resource_ids and resource_names keyword arguments.

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

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• namespaces (List[str]) – A comma-separated list of namespaces.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• resource_destroyed (bool) – If set to true, returns only objects from destroyed resources. Returns an error if the name of a live resource is specified in the resource_names query parameter. If set to false, returns only objects from live resources. Returns an error if the name of a destroyed resource is specified in the resource_names query parameter.

• resource_ids (List[str]) – A comma-separated list of resource IDs. The resource_ids or resource_names parameter is required, but they cannot be set together.

• resource_names (List[str]) – A comma-separated list of resource names. The resource_ids or resource_names parameter is required, but they cannot be set together.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_hosts(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = 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 hosts

Displays a list of hosts.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• 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. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_hosts_host_groups(members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, groups: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = 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 hosts that are associated with host groups

Displays a list of hosts that are associated with host groups.

Parameters

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

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

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

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• group_names (List[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_hosts_performance(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, end_time: Optional[StrictInt] = None, filter: Optional[Union[StrictStr, Filter]] = 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[StrictInt] = None, total_item_count: Optional[StrictBool] = 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 host performance data

Displays real-time and historical performance data, real-time latency data, and average I/O sizes across all hosts, displayed by host and by total size across all hosts. This data represents volumes that are connected to the hosts on the local array and stretched volumes connected to the hosts on any arrays that are connected by synchronous replication.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

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

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

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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_hosts_performance_balance(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = 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 host performance balance

Displays the I/O balance statistics for host paths.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_hosts_performance_by_array(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, end_time: Optional[StrictInt] = None, filter: Optional[Union[StrictStr, Filter]] = 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[StrictInt] = None, total_item_count: Optional[StrictBool] = 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 host performance data by array

Displays real-time and historical performance data, real-time latency data, and average I/O size data. The data is displayed by total size across all hosts on each array and by individual host on each array. The displayed data represents the volumes that are connected to a host on the current array and the volumes that are connected to a host on any remote arrays that are visible to the current array.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

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

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

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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_hosts_protection_groups(members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, groups: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = None, group_ids: Optional[ConstrainedListValue[StrictStr]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = 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 hosts that are members of protection groups

Displays a list of host members that belong to one or more protection groups.

Parameters

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

• groups (ReferenceType or List[ReferenceType], optional) – A list of groups to query for. Overrides group_ids and group_names keyword arguments.

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

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• group_ids (List[str]) – A comma-separated list of group IDs.

• group_names (List[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_hosts_space(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = 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 host space information

Displays provisioned size and physical storage consumption data for each host.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_hosts_tags(resources: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = None, namespaces: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, resource_destroyed: Optional[StrictBool] = None, resource_ids: Optional[ConstrainedListValue[StrictStr]] = None, resource_names: 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 tags

Displays the list of tags on host objects.

Parameters

• resources (ReferenceType or List[ReferenceType], optional) – A list of resources to query for. Overrides resource_ids and resource_names keyword arguments.

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

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• namespaces (List[str]) – A comma-separated list of namespaces.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• resource_destroyed (bool) – If set to true, returns only objects from destroyed resources. Returns an error if the name of a live resource is specified in the resource_names query parameter. If set to false, returns only objects from live resources. Returns an error if the name of a destroyed resource is specified in the resource_names query parameter.

• resource_ids (List[str]) – A comma-separated list of resource IDs. The resource_ids or resource_names parameter is required, but they cannot be set together.

• resource_names (List[str]) – A comma-separated list of resource names. The resource_ids or resource_names parameter is required, but they cannot be set together.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_kmip(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = 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 KMIP server objects

Displays the list of KMIP server objects.

Parameters

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

• authorization (str) – Deprecated. Please use Client level authorization

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_kmip_test(names: ConstrainedListValue[StrictStr], references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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]

Lists KMIP connection tests

Displays communication data between a FlashArray and KMIP server.

Parameters

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

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

• authorization (str) – Deprecated. Please use Client level authorization

• 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_log_targets(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = 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 log targets

Displays a list of configured log targets.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_log_targets_file(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = 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 file log targets

Displays a list of configured file log targets.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_log_targets_syslog(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = 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 syslog servers

Displays a list of configured syslog servers.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_log_targets_syslog_settings(contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = 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 syslog settings

Displays syslog settings. Values include continuation_token, items, more_items_remaining, and total_item_count.

Parameters

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

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_log_targets_syslog_test(contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = 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 syslog server test results

Displays syslog server test results, which indicate whether the syslog is working and configured correctly.

Parameters

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

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_maintenance_windows(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = 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 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 names keyword argument.

• authorization (str) – Deprecated. Please use Client level authorization

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_network_interfaces(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = 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 network interfaces

Displays all network interfaces for all controllers on the array.

Parameters

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

• authorization (str) – Deprecated. Please use Client level authorization

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

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_network_interfaces_neighbors(local_ports: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = None, local_port_names: 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 network interface neighbors

Displays all neighbors for all network interfaces on the array.

Parameters

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

• authorization (str) – Deprecated. Please use Client level authorization

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

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• local_port_names (List[str]) – Performs the operation on the unique local port name specified. Enter multiple names in comma-separated format. For example, ct0.eth0,ct1.eth0.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_network_interfaces_performance(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, end_time: Optional[StrictInt] = None, filter: Optional[Union[StrictStr, Filter]] = 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[StrictInt] = None, total_item_count: Optional[StrictBool] = 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 network performance statistics

Displays network statistics, historical bandwidth, and error reporting for all specified network interfaces.

Parameters

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

• authorization (str) – Deprecated. Please use Client level authorization

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

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

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

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

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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_port_details(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = 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 SFP port details

Displays Ethernet and Fibre Channel SFP details.

Parameters

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

• authorization (str) – Deprecated. Please use Client level authorization

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

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_offloads(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, protocol: Optional[StrictStr] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = 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 offload targets

Displays a list of offload targets that are connected to the array.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• protocol (str) – Protocol type. Valid values are azure, google-cloud, nfs, and s3.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

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

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

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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_pod_replica_links(remote_pods: Optional[Union[ReferenceType, List[ReferenceType]]] = None, remotes: Optional[Union[ReferenceType, List[ReferenceType]]] = None, local_pods: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, local_pod_ids: Optional[ConstrainedListValue[StrictStr]] = None, local_pod_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, remote_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_names: Optional[ConstrainedListValue[StrictStr]] = None, remote_pod_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_pod_names: 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 pod replica links

Displays the list of pod replica links that are configured between arrays.

Parameters

• remote_pods (ReferenceType or List[ReferenceType], optional) – A list of remote_pods to query for. Overrides remote_pod_ids and remote_pod_names keyword arguments.

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

• local_pods (ReferenceType or List[ReferenceType], optional) – A list of local_pods to query for. Overrides local_pod_ids and local_pod_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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• local_pod_ids (List[str]) – A comma-separated list of local pod 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_pod_names query parameter.

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

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects 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, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_ids query parameter.

• remote_pod_ids (List[str]) – A comma-separated list of remote pod 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_pod_names query parameter.

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

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_pod_replica_links_lag(remote_pods: Optional[Union[ReferenceType, List[ReferenceType]]] = None, remotes: Optional[Union[ReferenceType, List[ReferenceType]]] = None, local_pods: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, end_time: Optional[StrictInt] = None, filter: Optional[Union[StrictStr, Filter]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, local_pod_ids: Optional[ConstrainedListValue[StrictStr]] = None, local_pod_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, remote_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_names: Optional[ConstrainedListValue[StrictStr]] = None, remote_pod_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_pod_names: Optional[ConstrainedListValue[StrictStr]] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[StrictInt] = 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 pod replica link lag

Displays the lag in milliseconds that the replication target is behind the source. This is the time difference between the current time and the recovery point.

Parameters

• remote_pods (ReferenceType or List[ReferenceType], optional) – A list of remote_pods to query for. Overrides remote_pod_ids and remote_pod_names keyword arguments.

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

• local_pods (ReferenceType or List[ReferenceType], optional) – A list of local_pods to query for. Overrides local_pod_ids and local_pod_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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• local_pod_ids (List[str]) – A comma-separated list of local pod 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_pod_names query parameter.

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

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects 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, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_ids query parameter.

• remote_pod_ids (List[str]) – A comma-separated list of remote pod 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_pod_names query parameter.

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

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• 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_pod_replica_links_mappings_policies(remote_pods: Optional[Union[ReferenceType, List[ReferenceType]]] = None, remotes: Optional[Union[ReferenceType, List[ReferenceType]]] = None, pod_replica_links: Optional[Union[ReferenceType, List[ReferenceType]]] = None, local_pods: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, local_pod_ids: Optional[ConstrainedListValue[StrictStr]] = None, local_pod_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, pod_replica_link_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_names: Optional[ConstrainedListValue[StrictStr]] = None, remote_pod_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_pod_names: 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 policy mappings

Displays a list of policy mappings.

Parameters

• remote_pods (ReferenceType or List[ReferenceType], optional) – A list of remote_pods to query for. Overrides remote_pod_ids and remote_pod_names keyword arguments.

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

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

• local_pods (ReferenceType or List[ReferenceType], optional) – A list of local_pods to query for. Overrides local_pod_ids and local_pod_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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• local_pod_ids (List[str]) – A comma-separated list of local pod 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_pod_names query parameter.

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

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

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

• remote_pod_ids (List[str]) – A comma-separated list of remote pod 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_pod_names query parameter.

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

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_pod_replica_links_performance_replication(remote_pods: Optional[Union[ReferenceType, List[ReferenceType]]] = None, remotes: Optional[Union[ReferenceType, List[ReferenceType]]] = None, local_pods: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, end_time: Optional[StrictInt] = None, filter: Optional[Union[StrictStr, Filter]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, local_pod_ids: Optional[ConstrainedListValue[StrictStr]] = None, local_pod_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, remote_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_names: Optional[ConstrainedListValue[StrictStr]] = None, remote_pod_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_pod_names: Optional[ConstrainedListValue[StrictStr]] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[StrictInt] = None, total_item_count: Optional[StrictBool] = 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]

api244_pod_replica_links_performance_replication_get

Parameters

• remote_pods (ReferenceType or List[ReferenceType], optional) – A list of remote_pods to query for. Overrides remote_pod_ids and remote_pod_names keyword arguments.

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

• local_pods (ReferenceType or List[ReferenceType], optional) – A list of local_pods to query for. Overrides local_pod_ids and local_pod_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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• local_pod_ids (List[str]) – A comma-separated list of local pod 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_pod_names query parameter.

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

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects 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, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_ids query parameter.

• remote_pod_ids (List[str]) – A comma-separated list of remote pod 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_pod_names query parameter.

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

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

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

• total_only (bool) – If set to true, only return the aggregate value of all items after filtering. For real-time performance, the values are aggregated for the latest timestamp. For historical performance, the values are aggregated for each timestamp from start_time to end_time. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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_pods(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = 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_item_count: Optional[StrictBool] = 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 pods

Displays a list of pods that are stretched to this 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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• 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. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

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

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

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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_pods_arrays(members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, groups: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = None, group_ids: Optional[ConstrainedListValue[StrictStr]] = None, group_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_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 pods and their the array members

Displays a list of pods and the local and remote arrays over which the pods are stretched. Pods with realm members will not be returned. The optional group_names parameter represents the name of the pod. The optional member_names parameter represents the name of the array over which the pod is stretched. (Deprecated) Use pods/members instead.)

Parameters

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

• groups (ReferenceType or List[ReferenceType], optional) – A list of groups to query for. Overrides group_ids and group_names keyword arguments.

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

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• group_ids (List[str]) – A comma-separated list of group IDs.

• group_names (List[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_pods_members(pods: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, pod_ids: Optional[ConstrainedListValue[StrictStr]] = None, pod_names: 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 pods and their members

Displays a list of pods and the local and remote members over which the pods are stretched. Currently either array or realm is supported as member.

Parameters

• pods (ReferenceType or List[ReferenceType], optional) – A list of pods to query for. Overrides pod_ids and pod_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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• pod_ids (List[str]) – A comma-separated list of pod IDs.

• pod_names (List[str]) – Performs the operation on the unique pod name specified. Enter multiple names in comma-separated format. For example, pod01,pod02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_pods_performance(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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, end_time: Optional[StrictInt] = None, filter: Optional[Union[StrictStr, Filter]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, protocol: Optional[StrictStr] = None, protocol_group: Optional[StrictStr] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[StrictInt] = None, total_item_count: Optional[StrictBool] = 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 pod performance data

Displays real-time and historical performance data, real-time latency data, and average I/O sizes across all pods, displayed both by pod and as a total across all pods.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• 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. For destroyed objects, the time remaining is displayed in milliseconds.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• protocol (str) – Protocol type. Valid values are nfs, smb, and all.

• protocol_group (str) – Protocol group type. Valid values are block, file, and all.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

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

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

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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_pods_performance_by_array(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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, end_time: Optional[StrictInt] = None, filter: Optional[Union[StrictStr, Filter]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, protocol: Optional[StrictStr] = None, protocol_group: Optional[StrictStr] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[StrictInt] = None, total_item_count: Optional[StrictBool] = 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 pod performance data by array

Displays real-time and historical performance data, real-time latency data, and average I/O size data. The data is displayed as a total across all pods on the local array and by individual pod.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• 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. For destroyed objects, the time remaining is displayed in milliseconds.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• protocol (str) – Protocol type. Valid values are nfs, smb, and all.

• protocol_group (str) – Protocol group type. Valid values are block, file, and all.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

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

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

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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_pods_performance_replication(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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, end_time: Optional[StrictInt] = None, filter: Optional[Union[StrictStr, Filter]] = 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[StrictInt] = None, total_item_count: Optional[StrictBool] = 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 pod replication performance data

Displays pod replication performance data. The data returned is the real-time and historical performance data for each replication type at the pod level. Values include continuous, periodic, resync, and sync.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• 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. For destroyed objects, the time remaining is displayed in milliseconds.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

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

• total_only (bool) – If set to true, only return the aggregate value of all items after filtering. For real-time performance, the values are aggregated for the latest timestamp. For historical performance, the values are aggregated for each timestamp from start_time to end_time. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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_pods_performance_replication_by_array(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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, end_time: Optional[StrictInt] = None, filter: Optional[Union[StrictStr, Filter]] = 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[StrictInt] = None, total_item_count: Optional[StrictBool] = 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 pod replication performance data by array

Displays pod replication performance data, organized by array. The data returned is the real-time and historical performance data for each replication type at the pod level. Values include continuous, periodic, resync, and sync.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• 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. For destroyed objects, the time remaining is displayed in milliseconds.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

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

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

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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_pods_space(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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, end_time: Optional[StrictInt] = None, filter: Optional[Union[StrictStr, Filter]] = 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[StrictInt] = None, total_item_count: Optional[StrictBool] = 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 pod space information

Displays provisioned size and physical storage consumption data for each pod on the local 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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• 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. For destroyed objects, the time remaining is displayed in milliseconds.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

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

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

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

• async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

Union[ValidResponse, ErrorResponse]

Raises

PureError: 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_pods_tags(resources: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = None, namespaces: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, resource_destroyed: Optional[StrictBool] = None, resource_ids: Optional[ConstrainedListValue[StrictStr]] = None, resource_names: 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 tags

Displays the list of tags.

Parameters

• resources (ReferenceType or List[ReferenceType], optional) – A list of resources to query for. Overrides resource_ids and resource_names keyword arguments.

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

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• namespaces (List[str]) – A comma-separated list of namespaces.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• resource_destroyed (bool) – If set to true, returns only objects from destroyed resources. Returns an error if the name of a live resource is specified in the resource_names query parameter. If set to false, returns only objects from live resources. Returns an error if the name of a destroyed resource is specified in the resource_names query parameter.

• resource_ids (List[str]) – A comma-separated list of resource IDs. The resource_ids or resource_names parameter is required, but they cannot be set together.

• resource_names (List[str]) – A comma-separated list of resource names. The resource_ids or resource_names parameter is required, but they cannot be set together.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_policies(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = 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_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 policies

Displays a list of 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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• 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. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_policies_alert_watcher(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = 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_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 alert-watcher policies

Displays a list of alert-watcher 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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• 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. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_policies_alert_watcher_members(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = 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, 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 alert-watcher policy members

Displays a list of alert-watcher policy 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.

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

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• 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. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_types (List[str]) – Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include directories. Enter multiple member types in comma-separated format. For example, type01,type02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_policies_alert_watcher_rules(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = 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, 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 alert-watcher policy rules

Displays a list of alert-watcher 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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• 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. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_policies_alert_watcher_rules_test(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = 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 rules of alert-watcher policy rule test

Displays alert-watcher policy rule email test results.

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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_policies_audit_file(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = 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_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 audit policies

Displays a list of 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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• 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. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_policies_audit_file_members(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = 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, 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 audit policy members

Displays a list of audit policy 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.

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

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• 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. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_types (List[str]) – Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include directories. Enter multiple member types in comma-separated format. For example, type01,type02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_policies_autodir(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = 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_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 auto managed directory policies

Displays a list of auto managed directory 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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• 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. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_policies_autodir_members(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = 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, 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 auto managed directories policy members

Displays a list of auto managed directory policy 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.

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

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• 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. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_types (List[str]) – Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include directories. Enter multiple member types in comma-separated format. For example, type01,type02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_policies_management_access(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = 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_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 management access policies

Displays a list of management 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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_policies_management_access_members(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = 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, 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 management access policy members

Displays a list of management access policy 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.

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

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in a comma-separated format.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_types (List[str]) – Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include directories. Enter multiple member types in comma-separated format. For example, type01,type02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in a comma-separated format.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_policies_members(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = 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, 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 policy members

Displays a list of policy 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.

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

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• 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. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_types (List[str]) – Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include directories. Enter multiple member types in comma-separated format. For example, type01,type02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_policies_nfs(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = 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_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 NFS policies

Displays a list of NFS 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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• 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. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_policies_nfs_client_rules(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = 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, 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 NFS client policy rules

Displays a list of NFS client 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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• 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. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_policies_nfs_members(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = 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, 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 NFS policy members

Displays a list of NFS policy 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.

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

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• 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. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_types (List[str]) – Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include directories. Enter multiple member types in comma-separated format. For example, type01,type02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_policies_password(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = 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_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 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.

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

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_policies_quota(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = 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_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 quota policies

Displays a list of quota 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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• 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. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_policies_quota_members(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = 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, 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 quota policy members

Displays a list of quota policy 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.

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

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• 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. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_types (List[str]) – Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include directories. Enter multiple member types in comma-separated format. For example, type01,type02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_policies_quota_rules(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = 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, 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 quota policy rules

Displays a list of quota 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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• 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. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_policies_smb(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = 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_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 SMB policies

Displays a list of SMB 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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• 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. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. The name is expected to be fully qualified, meaning if the object is contained in some context, the corresponding name would provide complete information about the containment hierarchy. For example, name01,pod01::name01.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_policies_smb_client_rules(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = 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, 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 SMB client policy rules

Displays a list of SMB client 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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• 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. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_policies_smb_members(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = 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, 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 SMB policy members

Displays a list of SMB policy 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.

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

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• 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. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_types (List[str]) – Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include directories. Enter multiple member types in comma-separated format. For example, type01,type02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_policies_snapshot(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = 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_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 snapshot policies

Displays a list of snapshot 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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• 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. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_policies_snapshot_members(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = 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, 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 snapshot policy members

Displays a list of snapshot policy 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.

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

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• 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. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_types (List[str]) – Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include directories. Enter multiple member types in comma-separated format. For example, type01,type02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_policies_snapshot_rules(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = 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, 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 snapshot policy rules

Displays a list of snapshot 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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• 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. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_policies_user_group_quota(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = 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_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 user-group-quota policies

Displays a list of user-group-quota 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.

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• 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. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• 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 starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_policies_user_group_quota_members(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = None, limit: Optional[ConstrainedIntValue] = 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, 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 user-group-quota policy members

Displays a list of user-group-quota policy 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.

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

• authorization (str) – Deprecated. Please use Client level authorization

• 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) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• 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. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (Union[str, Filter]) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_types (List[str]) – Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include directories. Enter multiple member types in comma-separated format. For example, type01,type02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• 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_policies_user_group_quota_rules(policies: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = 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[Union[StrictStr, Filter]] = 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, 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]