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

  • 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_directory_exports(policies: 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, 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.

Parameters

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

  • 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. For example, fs:dir01,fs:dir02.

  • export_names (List[str]) – Performs the operation on the export names 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_directory_services_local_groups(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, gids: Optional[ConstrainedListValue[StrictInt]] = 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.

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

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

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

  • 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, groups: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, group_gids: Optional[ConstrainedListValue[StrictInt]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, group_sids: 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_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.

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

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

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

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

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

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

  • 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, groups: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, group_gids: Optional[ConstrainedListValue[StrictInt]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, group_sids: 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.

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

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

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

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

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

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. 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_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_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_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_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[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 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 (str) – 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(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[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 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 (str) – 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[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 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 (str) – 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[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 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 (str) – 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[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, 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 (str) – 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[StrictStr] = 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 (str) – 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[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 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 (str) – 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[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 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 (str) – 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[StrictStr] = 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 (str) – 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[StrictStr] = 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 (str) – 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[StrictStr] = 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 (str) – 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[StrictStr] = 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 (str) – 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[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 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 (str) – 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[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 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 (str) – 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[StrictStr] = 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 (str) – 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[StrictStr] = 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 (str) – 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[StrictStr] = 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 (str) – 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[StrictStr] = 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 (str) – 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[StrictStr] = 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 (str) – 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[StrictStr] = 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 (str) – 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[StrictStr] = 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 (str) – 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[StrictStr] = 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 (str) – 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[StrictStr] = 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 (str) – 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[StrictStr] = 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 (str) – 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[StrictStr] = 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 (str) – 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[StrictStr] = 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 (str) – 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[StrictStr] = 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 (str) – 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.

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 (str) – 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[StrictStr] = 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 (str) – 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[StrictStr] = 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 (str) – 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[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 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 (str) – 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[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 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 (str) – 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[StrictStr] = 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 (str) – 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[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 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 (str) – 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[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 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 (str) – 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[StrictStr] = 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 (str) – 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[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 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 (str) – 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[StrictStr] = 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 (str) – 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[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 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 (str) – 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[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 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 (str) – 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[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, 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 (str) – 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_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[StrictStr] = 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 (str) – 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[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, 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 (str) – 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[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, 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 (str) – 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[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, 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 (str) – 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[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, 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 (str) – 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[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, 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 (str) – 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[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, 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 (str) – 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[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, 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 (str) – 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[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[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 (str) – 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_directory_exports(policies: 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[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 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.

  • 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. For example, fs:dir01,fs:dir02.

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

  • filter (str) – 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_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[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 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 (str) – 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[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 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 (str) – 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_directory_services_local_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[StrictStr] = 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.

  • 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 (str) – 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, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = 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.

  • 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 (str) – 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, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, 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.

  • 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 (str) – 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, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = 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.

  • 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 (str) – 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[StrictStr] = 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 (str) – 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[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, 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 (str) – 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[StrictStr] = 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 (str) – 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[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, 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 (str) – 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_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[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 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 (str) – 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_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[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 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 (str) – 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[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 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 (str) – 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[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 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 (str) – 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[StrictStr] = 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 (str) – 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[StrictStr] = None, fleet_ids: Optional[ConstrainedListValue[StrictStr]] = None, fleet_names: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_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 (str) – 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[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 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 (str) – 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[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 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 (str) – 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[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 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 (str) – 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[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 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 (str) – 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[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 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 (str) – 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[StrictStr] = 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 (str) – 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[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 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 (str) – 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[StrictStr] = 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 (str) – 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[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 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 (str) – 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[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 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 (str) – 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[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 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 (str) – 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[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 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 (str) – 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[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 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 (str) – 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[StrictStr] = 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 (str) – 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[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 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 (str) – 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[StrictStr] = 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 (str) – 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[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 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 (str) – 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[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 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 (str) – 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[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 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 (str) – 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[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 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 (str) – 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[StrictStr] = 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 (str) – 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[StrictStr] = 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 (str) – 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[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 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 (str) – 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[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 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 (str) – 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[StrictStr] = 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 (str) – 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[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 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 (str) – 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[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 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 (str) – 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[StrictStr] = 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 (str) – 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.

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 (str) – 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.

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 (str) – 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.

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 (str) – 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.

api243_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 (str) – 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[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, 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 (str) – 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[StrictStr] = 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 (str) – 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[StrictStr] = 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 (str) – 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[StrictStr] = 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 (str) – 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[StrictStr] = 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 (str) – 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[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[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 (str) – 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[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[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 (str) – 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[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[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 (str) – 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[StrictStr] = 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 (str) – 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[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 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 (str) – 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[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 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 (str) – 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[StrictStr] = 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 (str) – 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[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, 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 (str) – 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[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 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 (str) – 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[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 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 (str) – 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[StrictStr] = 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 (str) – 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[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 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 (str) – 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[StrictStr] = 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 (str) – 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[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 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 (str) – 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[StrictStr] = 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 (str) – 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[StrictStr] = 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 (str) – 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[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 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 (str) – 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[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, 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 (str) – 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[StrictStr] = 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 (str) – 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[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 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 (str) – 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[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 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 (str) – 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[StrictStr] = 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 (str) – 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[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, 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 (str) – 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[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 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 (str) – 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_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[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, 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 (str) – 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[StrictStr] = 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 (str) – 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[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 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 (str) – 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[StrictStr] = 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 (str) – 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[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, 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 (str) – 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_ports(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[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 ports

Displays host name, iSCSI Qualified Names (IQNs), NVMe Qualified Names (NQNs), IPv4 address of the portal, Fibre Channel World Wide Names (WWNs), and failover ports, including those that were discovered by Purity//FA and those that have been manually assigned by system administrators.

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 (str) – 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_ports_initiators(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[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 port initiators

Displays host iSCSI Qualified Names (IQNs), NVMe Qualified Names (NQNs), and Fibre Channel World Wide Names (WWNs), including those that were discovered by Purity//FA and those that have been manually assigned by system administrators, along with the array ports (targets) on which they are eligible to communicate.

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 (str) – 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_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]

List workload presets

Displays a list of workload presets.

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 unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context. Enter multiple names in comma-separated format. For example, name01,name02.

  • ids (List[str]) – 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.

get_protection_group_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[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, 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 protection group snapshots

Displays a list of protection group 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 (str) – 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_protection_group_snapshots_transfer(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[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, 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 protection group snapshots with transfer statistics

Displays a list of protection group snapshots and corresponding transfer statistics.

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 (str) – 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_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, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_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 protection groups

Displays a list of protection groups, including their associated source arrays, replication targets, hosts, host groups, and volumes. The list includes protection groups that were created on the local array to replicate snapshot data to other arrays or offload targets, created on a remote array and replicated asynchronously to this array, or created inside a pod on a remote array and stretched to 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.

  • filter (str) – 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_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, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = 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 protection groups with host group members

Displays a list of protection groups that have host group members.

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 (str) – 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_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, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = 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 protection groups with host members

Displays a list of protection groups that have host members.

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 (str) – 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_protection_groups_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[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[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 protection group replication performance data

Displays the total number of bytes of replication data transmitted and received per second. The data is grouped by protection group.

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 (str) – 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.

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_protection_groups_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[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[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 protection group replication performance data with array details

Displays the total number of bytes of replication data transmitted and received per second. The data is grouped by protection group and includes the names of the source array and targets for each protection group.

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 (str) – 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.

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_protection_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, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_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 protection group space information

Displays provisioned size and physical storage consumption data for each protection group.

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 (str) – 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_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, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = 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 (str) – 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_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, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = 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 protection groups with targets

Displays a list of protection groups that have target arrays, pods, or offload targets.

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 (str) – 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_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, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, group_ids: Optional[ConstrainedListValue[StrictStr]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, include_remote: Optional[StrictBool] = None, limit: Optional[ConstrainedIntValue] = None, member_destroyed: Optional[StrictBool] = 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 protection groups with volume members

Displays a list of protection groups that have volume members.

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 (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

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

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

  • include_remote (bool) – If set to true the response will include remote membership for protection groups that belong to the remote arrays as well as local volumes. Defaults to false.

  • 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_destroyed (bool) – If true, returns only destroyed member objects. Returns an error if a name of a live member object is specified in the member_names query param. If false, returns only live member objects. Returns an error if a name of a destroyed member object is specified in the member_names query param.

  • 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_realms(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_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 realms

Displays a list of realms.

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.

  • 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 (str) – 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_realms_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[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[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 realm performance data

Displays real-time and historical performance data, real-time latency data, and average I/O sizes across all realms, displayed both by realm and as a total across all realms.

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 (str) – 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_realms_space(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, end_time: Optional[StrictInt] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[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 realm space information

Displays provisioned size and storage consumption data for each realm on the local 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.

  • 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 (str) – 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_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, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = 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 (str) – 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_remote_arrays(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, current_fleet_only: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_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 remote arrays

Dispalys arrays in the current fleet, as well as arrays that the current array has existing replication connections to.

Parameters

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

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

  • current_fleet_only (bool) – If current_fleet_only is specified, then results will only show arrays from the same fleet to which the current array is a member of.

  • filter (str) – 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_remote_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, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, on: 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 remote pods

Displays a list of pods that that are on connected arrays but not 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.

  • filter (str) – 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.

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

  • 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_remote_protection_group_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[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, on: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = 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 remote protection group snapshots

Displays a list of remote protection group snapshots.

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 (str) – 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.

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

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

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_remote_protection_group_snapshots_transfer(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[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, on: Optional[ConstrainedListValue[StrictStr]] = 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 remote protection groups with transfer statistics

Displays a list of remote protection groups and their transfer statistics.

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 (str) – 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.

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

  • 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_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, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, on: 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 remote protection groups

Returns a list of remote protection 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.

  • 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 (str) – 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.

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

  • 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_remote_volume_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[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, on: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = 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 remote volume snapshots

Displays a list of remote volume snapshots.

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 (str) – 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.

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

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

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_remote_volume_snapshots_transfer(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[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, on: Optional[ConstrainedListValue[StrictStr]] = 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 remote volume snapshots with transfer statistics

Displays a list of remote volume snapshots and their transfer statistics.

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 (str) – 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.

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

  • 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_resource_accesses(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, 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 resource access configurations

Displays a list of configured resource accesses.

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.

  • 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 (str) – 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.

  • 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_resource_accesses_status(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_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 status of resource accesses as specified by resource access configuration

Displays a list of effective resource accesses.

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 (str) – 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_rest_version()

Get the REST API version being used by this client.

Returns

str

get_sessions(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_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 session data

Displays session data for user login events performed in the Purity//FA GUI, CLI, and REST API.

Parameters

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

  • 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 (str) – 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_smi_s(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = 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 SMI-S settings

Displays the SMI-S settings, including whether SLP and WBEM-HTTPS are enabled.

Parameters

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

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

  • filter (str) – 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_smtp_servers(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = 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 SMTP server attributes

Displays SMTP server attributes. Values include user_name, password, relay_host, sender_domain, sender_username, subject_prefix, body_prefix, encryption_mode, and name.

Parameters

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

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

  • filter (str) – 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_snmp_agents(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = 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 SNMP agent

Displays the SNMP agent name and protocol attributes.

Parameters

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

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

  • filter (str) – 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_snmp_agents_mib(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = 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 SNMP agent MIB text

Displays the SNMP MIB text.

Parameters

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

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

  • filter (str) – 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_snmp_managers(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, 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 SNMP managers

Displays designated SNMP managers and their communication and security attributes.

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 (str) – 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_snmp_managers_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[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 SNMP manager test results

Displays SNMP manager test results (traps or informs).

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 (str) – 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_software(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, versions: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

List software packages

Displays a list of available software packages.

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 (str) – 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.

  • versions (List[str]) – A comma-separated list of 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.

get_software_bundle(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, 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 software-bundle

Displays a list of software bundles.

Parameters

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

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

  • filter (str) – 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.

  • 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_software_check(softwares: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, software_names: Optional[ConstrainedListValue[StrictStr]] = None, software_versions: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

List software check tasks

Displays a list of software check tasks.

Parameters

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

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

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

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

  • filter (str) – 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.

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

  • software_versions (List[str]) – A comma-separated list of target software versions.

  • sort (List[str]) – 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_software_installation_steps(software_installations: 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[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, software_installation_ids: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

List software upgrade steps

Displays a list of currently running and completed software upgrade steps.

Parameters

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

  • 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 (str) – 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.

  • software_installation_ids (List[str]) – A comma-separated list of software installation IDs.

  • 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_software_installations(softwares: 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[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, software_ids: Optional[ConstrainedListValue[StrictStr]] = None, software_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 software upgrades

Displays a list of software upgrades, including currently running and past upgrades.

Parameters

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

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

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

  • 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_software_patches(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, 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 software patches

Displays a list of software patches.

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 (str) – 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_software_patches_catalog(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = 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 software patches

Displays a list of available software patches.

Parameters

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

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

  • filter (str) – 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_software_versions(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = 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 software versions

Displays a list of software versions.

Parameters

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

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

  • filter (str) – 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_sso_saml2_idps(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_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 SAML2 SSO configurations

Displays the SAML2 SSO service provider and identity provider configuration settings in the array.

Parameters

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

  • 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 (str) – 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_sso_saml2_idps_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[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 existing SAML2 SSO configurations

Displays the existing SAML2 SSO configurations in the array.

Parameters

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

  • 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 (str) – 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_subnets(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, 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 subnets

Displays a list of subnets with statuses and attributes.

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 (str) – 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_subscription_assets(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_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 subscription assets

Displays information about subscription assets.

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 (str) – 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_subscriptions(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, 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 subscriptions

Displays information about subscriptions.

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.

  • 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 (str) – 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.

  • 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_support(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_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 paths

Displays connection paths between the current array and each connected 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 (str) – 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_support_diagnostics_details(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_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 diagnostics details

Displays the diagnostics tests details.

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 (str) – 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_support_diagnostics_settings(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_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 diagnostics tools version and last updated date

Displays diagnostics tools version and last updated date.

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 (str) – 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_support_remote_assist_sessions(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_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 remote assist session

Displays settings for remote assist sessions.

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 (str) – 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_support_remote_assist_sessions_settings(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_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 remote assist session global settings

Displays global settings for remote assist sessions.

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 (str) – 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_support_test(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, test_type: Optional[StrictStr] = 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 Pure Storage Support connection data

Displays information about whether the array can connect to Pure Storage Support by establishing a secure shell or secure HTTP connection and verifies that messages can be exchanged.

Parameters

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

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

  • filter (str) – 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.

  • test_type (str) – Specifies the type of test. Valid values are all, phonehome, and remote- assist. If not specified, defaults to all.

  • 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_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, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, 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 (str) – 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_syslog_servers_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[StrictStr] = 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 (str) – 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_syslog_servers_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[StrictStr] = 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 (str) – 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_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, continuation_token: Optional[StrictStr] = None, filter: Optional[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, 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]

List the vchost-connections between protocol endpoint and vchost.

Displays a list of vchost-connections between the protocol endpoint and vchost.

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.

  • 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 (str) – 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_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.

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

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

get_vchosts(references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_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 vchosts

Displays a list of vchosts.

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 (str) – 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_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, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = 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]

List vchost certificates

Displays certificates that are attached to configured vchosts on at least one endpoint.

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.

  • 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 (str) – 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.

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

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

get_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, continuation_token: Optional[StrictStr] = None, endpoints: Optional[ConstrainedListValue[StrictStr]] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = 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]

List vchost endpoints

Displays a list of vchost endpoints with their associated vchosts and certificates.

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.

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

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

  • filter (str) – 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.

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

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

get_virtual_machine_snapshots(vms: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, vm_ids: Optional[ConstrainedListValue[StrictStr]] = None, vm_type: Optional[StrictStr] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

List Virtual Machine Snapshots

Displays a list of virtual machine snapshots, including those pending eradication. If vm_type is vvol, the recovery_context in the response will represent a protection group snapshot containing the virtual machine. This must be used as the source in the POST /virtual-machine method when recovering or overwriting a virtual machine from a snapshot.

Parameters

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

  • 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 (str) – 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.

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

  • vm_type (str) – The type of virtual machine. The only valid value is vvol.

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_virtual_machine_volume_snapshots(vm_ids: ConstrainedListValue[StrictStr], vms: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, vm_type: Optional[StrictStr] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

List Virtual Machine Volume Snapshots

Displays a list of virtual machine volume snapshots, including those pending eradication. If vm_type is vvol, the recover_context in the response will represent a protection group snapshot containing the virtual machine volume.

Parameters

  • vm_ids (List[str]) – Performs the operation on the unique virtual machine IDs specified. Enter multiple resource IDs in a comma-separated format. (required)

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

  • 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 (str) – 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.

  • vm_type (str) – The type of virtual machine. The only valid value is vvol.

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_virtual_machines(vms: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, vm_ids: Optional[ConstrainedListValue[StrictStr]] = None, vm_type: Optional[StrictStr] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

List Virtual Machines

Displays a list of virtual machines, including those pending eradication. If vm_type is vvol, the recovery_context in the response will represent the most recent snapshot of the config vVol. This must be used as the source in the PATCH method when recovering a virtual machine from the destroyed state.

Parameters

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

  • 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 (str) – 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.

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

  • vm_type (str) – The type of virtual machine. The only valid value is vvol.

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_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, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_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 volume groups

Displays a list of volume groups, 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 (str) – 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_volume_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, destroyed: Optional[StrictBool] = None, end_time: Optional[StrictInt] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[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 volume group performance data

Displays real-time and historical performance data, real-time latency data, and average I/O sizes for each volume group and and as a total of all volume groups 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 (str) – 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_volume_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, destroyed: Optional[StrictBool] = None, end_time: Optional[StrictInt] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[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 volume group space information

Displays the provisioned size and physical storage consumption data for each volume group.

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 (str) – 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_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, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = 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 (str) – 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_volume_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, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = 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 volume groups with volumes

Displays a list of volume groups that contain volumes.

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 (str) – 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_volume_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[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, 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 volume snapshots

Displays a list of volume 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 (str) – 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_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, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = 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 (str) – 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_volume_snapshots_transfer(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[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, 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 volume snapshots with transfer statistics

Displays a list of volume snapshots and their transfer statistics.

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 (str) – 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_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, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_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 volumes

Displays a list of volumes, 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 (str) – 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_volumes_diff(block_size: StrictInt, segment_length: StrictInt, 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, base_id: Optional[StrictStr] = None, base_name: Optional[StrictStr] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, next_allocated_block_hint: Optional[StrictBool] = None, offset: Optional[ConstrainedIntValue] = None, segment_offset: Optional[StrictInt] = 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 volume diffs

Displays block differences for the specified volumes.

Parameters

  • block_size (int) – Granularity at which to compare, in bytes. Must be a multiple of 512. (required)

  • segment_length (int) – Length of the segment, in bytes, to compare. (required)

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

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

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

  • base_id (str) – ID of the volume or volume snapshot that the diff comparison is based on. If a base volume or volume snapshot is not specified, all mapped blocks for the volume or volume snapshot are displayed. The base_name or base_id parameter is required, but they cannot be set together.

  • base_name (str) – Name of the volume or volume snapshot that the diff comparison is based on. If a base volume or volume snapshot is not specified, all mapped blocks for the volume or volume snapshot are displayed. The base_name or base_id parameter is required, but they cannot be set together.

  • 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 (str) – 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.

  • next_allocated_block_hint (bool) – If set to true, appends offset of the next allocated block in bytes for the volume specified in names or ids to the output items. base_name or base_id must not be specified if this is set to true. If not specified, defaults to false.

  • offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • segment_offset (int) – Absolute offset, in bytes, of the segment to compare. Must be a multiple of block_size.

  • 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_volumes_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[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[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 volume performance data

Displays real-time and historical performance data, real-time latency data, and average I/O sizes for each volume and and as a total of all volumes 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 (str) – 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_volumes_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[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[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 volume performance data by array

Displays real-time and historical performance data, real-time latency data, and average I/O size data. The data returned is for each volume on the current array and for each volume on any remote arrays that are visible to the current array. The data is grouped by individual volumes and as a total across all volumes on each 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 (str) – 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_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, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, group_ids: Optional[ConstrainedListValue[StrictStr]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, member_destroyed: Optional[StrictBool] = 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 volumes that are members of protection groups

Displays a list of volume 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_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 (str) – 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_destroyed (bool) – If true, returns only destroyed member objects. Returns an error if a name of a live member object is specified in the member_names query param. If false, returns only live member objects. Returns an error if a name of a destroyed member object is specified in the member_names query param.

  • 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_volumes_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[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[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 volume space information

Displays the provisioned size and physical storage consumption data for each volume.

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 (str) – 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_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, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = 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 (str) – 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_volumes_volume_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[StrictStr] = 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 volumes that are in volume groups

Displays a list of volumes that are in a volume group.

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 (str) – 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_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, allow_errors: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = 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]

List workloads

Displays a list of workloads.

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.

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

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_workloads_placement_recommendations(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, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = 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]

List workload placement recommendations

Displays a list of placement recommendations for workloads.

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 context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

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

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

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

get_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, allow_errors: Optional[StrictBool] = None, context_names: 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]

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.

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

patch_active_directory(names: ConstrainedListValue[StrictStr], active_directory: ActiveDirectoryPatch, 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]

Modify Active Directory account

Modifies specified Active Directory account.

Parameters

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

  • active_directory (ActiveDirectoryPatch) – (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.

patch_admins(admin: AdminPatch, 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]

Modify an administrator

Modifies properties for the specified administrator.

Parameters

  • admin (AdminPatch) – (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.

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

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_admins_settings(admin_settings: AdminSettings, 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]

Modify administrator settings

Modifies the global administrator settings for the array.

Parameters

  • admin_settings (AdminSettings) – (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.

patch_alert_watchers(names: ConstrainedListValue[StrictStr], alert_watcher: AlertWatcherPatch, 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]

Modify alert watcher

Modify alert watcher email address by enabling or disabling it.

Parameters

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

  • alert_watcher (AlertWatcherPatch) – (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.

patch_alerts(alert: Alert, 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]

Modify flagged state

Modifies one or more alerts and display updated information about these alerts.

Parameters

  • alert (Alert) – (required)

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

patch_alerts_rules(code: StrictInt, parameter: StrictStr, alert_rule: AlertRules, 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]

Modify a custom alert rule

Modifies a custom alert rule to a new value.

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)

  • alert_rule (AlertRules) – (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.

patch_api_clients(api_clients: ApiClientPatch, 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]

Manage an API client

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

Parameters

  • api_clients (ApiClientPatch) – (required)

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

patch_apps(names: ConstrainedListValue[StrictStr], app: App, 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]

Modify app

Modifies an installed app or modifies Virtual Network Computing (VNC) access for apps that are being patched.

Parameters

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

  • app (App) – (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.

patch_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, refresh: Optional[StrictBool] = None, renew_encryption_key: Optional[StrictBool] = None, array_connection: Optional[ArrayConnectionPatch] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Modify an array connection

Modifies attributes for an array connection.

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.

  • refresh (bool) – If set to true, the array will attempt to communicate with the connection peer in order to update the connection attributes on both arrays with any changes that have occurred. If set to true, other array connection attributes may not be modified in requests. Default value is false.

  • renew_encryption_key (bool) – If set to true, update array connection with a new encryption key. If set to true, other array connection attributes may not be modified in requests. Defaults to false.

  • array_connection (ArrayConnectionPatch) –

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_arrays(array: Arrays, contexts: 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]

Modify an array

Modifies general array properties such as the array name, login banner, idle timeout for management sessions, and NTP servers.

Parameters

  • array (Arrays) – (required)

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

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_arrays_cloud_capacity(capacity: CloudCapacityStatus, 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]

Modify CBS array capacity

Modifies the raw capacity of the CBS array. This should trigger a backend process that will update the CBS array capacity. The array capacity can be updated only to values defined by the capacity steps endpoint. When an existing capacity update request is in progress, any new request to update of the capacity will receive an error response. For non-CBS arrays, this feature is not supported and requests will receive an error response.

Parameters

  • capacity (CloudCapacityStatus) – The requested capacity of the CBS array. (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.

patch_arrays_cloud_config(config: CloudConfigPatch, 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]

Modify CBS array configuration

Modifies the configuration of the CBS array. This should trigger a backend process that will upgrade the CBS array configuration. The array can be upgraded only to models defined by the supported configurations endpoint. When an existing array upgrade request is in progress, any new request to upgrade the array will receive an error response. For non-CBS arrays, this feature is not supported and requests will receive an error response.

Parameters

  • config (CloudConfigPatch) – The requested configuration of the CBS array hardware. (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.

patch_arrays_erasures(delete_sanitization_certificate: StrictBool, eradicate_all_data: StrictBool, finalize: StrictBool, reinstall_image: StrictBool, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, erasure_patch: Optional[ArrayErasurePatch] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Update factory reset

Modifies the factory reset process to finalize.

Parameters

  • delete_sanitization_certificate (bool) – Set to true to finalize factory reset and acknowledge the deletion of sanitization certificate. (required)

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

  • finalize (bool) – Must be true to finalize factory reset. (required)

  • reinstall_image (bool) – Set to true to reinstall image, or false to skip reinstalling image. (required)

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

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

  • erasure_patch (ArrayErasurePatch) –

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

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

Modify signature on the End User Agreement

Modifies the signature on the End User Agreement.

Parameters

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

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

  • eula (Eula) –

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_certificates(certificate: CertificatePost, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, generate_new_key: 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]

Modify certificates

Modifies certificate attributes. Modifying self-signed certificate attributes replaces the existing certificate with a new one, generated by Purity//FA, using the specified attributes.

Parameters

  • certificate (CertificatePost) – (required)

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

  • generate_new_key (bool) – If set to true, a new private key is generated when generating a new certificate with the specified attributes. This may not be set to true when importing a certificate and private key, and may not be set to false when generating a new self-signed certificate to replace a certificate that was imported. Default setting is false.

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

patch_container_default_protections(container_default_protection: ContainerDefaultProtection, 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]

Modify a container’s default protections

Modifies a container’s default protections. To modify, set default_protections to the new list.

Parameters

  • container_default_protection (ContainerDefaultProtection) – (required)

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

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

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

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

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_directories(directory: DirectoryPatch, 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]

Modify a managed directory

Modifies a managed directory. To rename a managed directory, set name to the new name. The ids or names parameter is required, but cannot be set together. The name or directory_name parameter is required.

Parameters

  • directory (DirectoryPatch) – (required)

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

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

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

patch_directory_exports(export: DirectoryExportPatch, policies: 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, 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]

Modify directory exports

Modifies a directory export. Used for manually renaming, enabling, and disabling directory exports. To rename a directory export, set ‘export_name’ to the new name.

Parameters

  • export (DirectoryExportPatch) – (required)

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

  • 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. For example, fs:dir01,fs:dir02.

  • export_names (List[str]) – Performs the operation on the export names 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.

patch_directory_services(names: ConstrainedListValue[StrictStr], directory_service: DirectoryService, 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]

Modify directory services configuration

Modifies the directory service configuration.

Parameters

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

  • directory_service (DirectoryService) – (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.

patch_directory_services_local_groups(local_group: LocalGroup, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, gids: Optional[ConstrainedListValue[StrictInt]] = 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]

Modify local groups

Modifies local groups.

Parameters

  • local_group (LocalGroup) – (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.

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

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

patch_directory_services_local_users(local_user: LocalUserPatch, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, keep_open_sessions: Optional[StrictBool] = 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]

Modify local user

Modifies a local user.

Parameters

  • local_user (LocalUserPatch) – (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.

  • keep_open_sessions (bool) – If set to true, the session does not expire. If set to false, when the user is disabled or password is changed, the session expires. 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.

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

patch_directory_services_roles(names: ConstrainedListValue[StrictStr], directory_service_roles: DirectoryServiceRole, roles: Optional[Union[ReferenceType, List[ReferenceType]]] = None, 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, role_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Modify group to management access policy mappings

Modifies properties of one or more group to management access policy mappings. Modifying management access policies is done at /directory-services/roles/policies/management-access instead.

Parameters

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

  • directory_service_roles (DirectoryServiceRole) – (required)

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

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

  • role_names (List[str]) – This field has been deprecated.

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_directory_snapshots(directory_snapshot: DirectorySnapshotPatch, 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]

Modify directory snapshot

Modifies a directory snapshot. You can destroy, recover, or update the policy or time remaining of a directory snapshot. To destroy a directory snapshot, set destroyed=true. To recover a directory snapshot that has been destroyed and is pending eradication, set destroyed=false. To rename a directory snapshot, set name to the new name. The ids or names parameter is required, but they cannot be set together.

Parameters

  • directory_snapshot (DirectorySnapshotPatch) – (required)

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

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

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

patch_dns(dns: DnsPatch, 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]

Modify DNS parameters

Modifies the DNS parameters of an array, including the domain suffix, the list of DNS name server IP addresses, and the list of services that DNS parameters apply to. If there is no DNS configuration beforehand new DNS configuration with ‘default’ name is created. If more than one DNS configuration exists, name has to be specified to identify the DNS configuration to be modified.

Parameters

  • dns (DnsPatch) – (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.

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

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_drives(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, admit: 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]

Modify flash and NVRAM modules

Modifies flash and NVRAM modules that have been added or connected but not yet admitted to the array.

Parameters

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

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

  • admit (bool) – If true, admits any unadmitted drives into the system.

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_file_systems(file_system: FileSystemPatch, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, 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]

Modify a file system

Modifies a file system. You can rename, destroy, move, or recover a file system. To rename a file system, set name to the new name. To destroy a file system, set destroyed=true. To move a file system, set ‘pod’ to the destination pod reference. To recover a file system that has been destroyed and is pending eradication, set destroyed=false.

Parameters

  • file_system (FileSystemPatch) – (required)

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

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

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

patch_fleets(fleet: FleetPatch, 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]

Modify a fleet

Modifies a fleet, changing its name by passing the old name in name query parameter, and the new name in the name parameter in the request body.

Parameters

  • fleet (FleetPatch) – (required)

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

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

patch_hardware(hardware: HardwarePatch, 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]

Modify visual identification

Modifies the visual identification of a specified hardware component, and causing the ID LED to turn on or off.

Parameters

  • hardware (HardwarePatch) – (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.

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

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_host_groups(host_group: HostGroupPatch, to_members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, from_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, from_member_ids: Optional[ConstrainedListValue[StrictStr]] = None, from_member_names: Optional[ConstrainedListValue[StrictStr]] = None, modify_resource_access: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, to_member_ids: Optional[ConstrainedListValue[StrictStr]] = None, to_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]

Modify a host group

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

Parameters

  • host_group (HostGroupPatch) – (required)

  • to_members (ReferenceType or List[ReferenceType], optional) – A list of to_members to query for. Overrides to_member_ids and to_member_names keyword arguments.

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

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

  • from_member_ids (List[str]) – Move the resource from the specified local member realm or array. This should be a union of all local realms and arrays from which the resource should be removed. Enter multiple IDs in a comma-separated format.

  • from_member_names (List[str]) – Move the resource from the specified local member realm or array. This should be a union of all local realms and arrays to be removed from the specified resource. Enter multiple names in a comma-separated format.

  • modify_resource_access (str) – Describes how to modify a resource accesses of a resource when that resource is moved. Possible values are: none, create, and delete. The none value indicates that no resource access should be modified. The create value is used when a resource is moving out of a realm into the array and it needs to create a resource access of the moved resource to the realm from which it is moving. The delete value is used when a resource that is moving from an array into a realm already has a resource access into that realm. This is a required parameter when a resource is being moved to another member.

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

  • to_member_ids (List[str]) – The resource will be moved to the specified local member realm or array. Enter multiple IDs in a comma-separated format.

  • to_member_names (List[str]) – The resource will be moved to the specified local member realm or array. Enter multiple names in a 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.

patch_hosts(host: HostPatch, to_members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, from_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, from_member_ids: Optional[ConstrainedListValue[StrictStr]] = None, from_member_names: Optional[ConstrainedListValue[StrictStr]] = None, modify_resource_access: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, to_member_ids: Optional[ConstrainedListValue[StrictStr]] = None, to_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]

Modify a host

Modifies an existing host, including its storage network addresses, CHAP, host personality, and preferred arrays, or associate a host to a host group. The names query parameter is required.

Parameters

  • host (HostPatch) – (required)

  • to_members (ReferenceType or List[ReferenceType], optional) – A list of to_members to query for. Overrides to_member_ids and to_member_names keyword arguments.

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

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

  • from_member_ids (List[str]) – Move the resource from the specified local member realm or array. This should be a union of all local realms and arrays from which the resource should be removed. Enter multiple IDs in a comma-separated format.

  • from_member_names (List[str]) – Move the resource from the specified local member realm or array. This should be a union of all local realms and arrays to be removed from the specified resource. Enter multiple names in a comma-separated format.

  • modify_resource_access (str) – Describes how to modify a resource accesses of a resource when that resource is moved. Possible values are: none, create, and delete. The none value indicates that no resource access should be modified. The create value is used when a resource is moving out of a realm into the array and it needs to create a resource access of the moved resource to the realm from which it is moving. The delete value is used when a resource that is moving from an array into a realm already has a resource access into that realm. This is a required parameter when a resource is being moved to another member.

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

  • to_member_ids (List[str]) – The resource will be moved to the specified local member realm or array. Enter multiple IDs in a comma-separated format.

  • to_member_names (List[str]) – The resource will be moved to the specified local member realm or array. Enter multiple names in a 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.

patch_kmip(kmip: KmipPatch, 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]

Modify KMIP attributes

Modifies one or more attributes of KMIP server objects.

Parameters

  • kmip (KmipPatch) – (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.

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

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_log_targets_file(log_target_file: LogTargetFile, 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]

Modify file log target

Modifies the URI of a configured file log target.

Parameters

  • log_target_file (LogTargetFile) – (required)

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

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

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

patch_log_targets_syslog(syslog_server: SyslogServer, 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]

Modify syslog server

Modifies the URI and services of a configured syslog server.

Parameters

  • syslog_server (SyslogServer) – (required)

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

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

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

patch_log_targets_syslog_settings(syslog_server_settings: SyslogServerSettings, contexts: 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]

Modify syslog settings

Modifies syslog settings. Values include continuation_token, items, more_items_remaining, and total_item_count.

Parameters

  • syslog_server_settings (SyslogServerSettings) – (required)

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

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_network_interfaces(network: NetworkInterfacePatch, 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]

Modify network interface

Modifies a network interface on a controller.

Parameters

  • network (NetworkInterfacePatch) – (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.

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

Modify pod replica links

Modifies 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

  • pod_replica_link (PodReplicaLinkPatch) – (required)

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

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

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

Modify policy mappings

Modifies policy mappings of a replica link. Valid mapping values are connected and disconnected. connected indicates that the source policy and its attachments will be mirrored on the target pod. disconnected indicates that the associated policy and its attachments are independent from any policy on the remote. This operation can only be performed on the target side of a pod replica link.

Parameters

  • mapping (MappingPolicyPatch) – (required)

  • remote_policies (ReferenceType or List[ReferenceType], optional) – A list of remote_policies to query for. Overrides remote_policy_ids and remote_policy_names keyword arguments.

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

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

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

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

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

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_pods(pod: PodPatch, to_members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, move_with_hosts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, move_with_host_groups: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, from_members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, abort_quiesce: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, destroy_contents: Optional[StrictBool] = None, from_member_ids: Optional[ConstrainedListValue[StrictStr]] = None, from_member_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, move_with_host_group_names: Optional[ConstrainedListValue[StrictStr]] = None, move_with_host_names: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, promote_from: Optional[StrictStr] = None, quiesce: Optional[StrictBool] = None, skip_quiesce: Optional[StrictBool] = None, to_member_ids: Optional[ConstrainedListValue[StrictStr]] = None, to_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]

Modify a pod

Modifies pod details.

Parameters

  • pod (PodPatch) – (required)

  • to_members (ReferenceType or List[ReferenceType], optional) – A list of to_members to query for. Overrides to_member_ids and to_member_names keyword arguments.

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

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

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

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

  • abort_quiesce (bool) – Set to true to promote the pod when the pod-replica-link is in the quiescing state and abort when waiting for the pod-replica-link to complete the quiescing operation.

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

  • destroy_contents (bool) – Set to true to destroy contents (e.g., volumes, protection groups, snapshots) and containers (e.g., realms, pods, volume groups), including eradicating containers with content.

  • from_member_ids (List[str]) – Move the resource from the specified local member realm or array. This should be a union of all local realms and arrays from which the resource should be removed. Enter multiple IDs in a comma-separated format.

  • from_member_names (List[str]) – Move the resource from the specified local member realm or array. This should be a union of all local realms and arrays to be removed from the specified resource. Enter multiple names 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.

  • move_with_host_group_names (List[str]) – The host groups to be moved together with the pods to the specified local member realm or array. All the hosts in the host groups will also be moved. Enter multiple names in a comma-separated format.

  • move_with_host_names (List[str]) – The hosts to be moved together with the pods to the specified local member realm or array. Enter multiple names in a comma-separated format.

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

  • promote_from (str) – The undo-demote pod that should be used to promote the pod. After the pod has been promoted, it will have the same data as the undo-demote pod and the undo-demote pod will be eradicated.

  • quiesce (bool) – Set to true to demote the pod after the pod-replica-link goes into quiesced state and allow the pod to become a target of the remote pod. This ensures that all local data has been replicated to the remote pod before the pod is demoted.

  • skip_quiesce (bool) – Set to true to demote the pod without quiescing the pod-replica-link and allow the pod to become a target of the remote pod. This stops all pending replication to the remote pod.

  • to_member_ids (List[str]) – The resource will be moved to the specified local member realm or array. Enter multiple IDs in a comma-separated format.

  • to_member_names (List[str]) – The resource will be moved to the specified local member realm or array. Enter multiple names in a 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.

patch_policies_alert_watcher(policy: PolicyPatch, 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]

Modify alert-watcher policies

Modifies one or more alert-watcher policies. To enable a policy, set enabled=true. To disable a policy, set enabled=false. To rename a policy, set name to the new name. The ids or names parameter is required, but they cannot be set together.

Parameters

  • policy (PolicyPatch) – (required)

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

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

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

patch_policies_alert_watcher_rules(rules: PolicyRuleAlertWatcherPatch, 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]

Modify alert-watcher policy rules

Modifies alert-watcher policy rules.

Parameters

  • rules (PolicyRuleAlertWatcherPatch) – (required)

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

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

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

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

patch_policies_audit_file(policy: PolicyAuditFilePatch, 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]

Modify audit policies

Modifies one or more audit policies. To enable a policy, set enabled=true. To disable a policy, set enabled=false. To rename a policy, set name to the new name. The ids or names parameter is required, but they cannot be set together.

Parameters

  • policy (PolicyAuditFilePatch) – (required)

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

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

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

patch_policies_autodir(policy: PolicyPatch, 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]

Modify auto managed directory policies

Modifies one or more auto managed directory policies. To enable a policy, set enabled=true. To disable a policy, set enabled=true. To rename a policy, set name to the new name. The ids or names parameter is required, but they cannot be set together.

Parameters

  • policy (PolicyPatch) – (required)

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

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

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

patch_policies_management_access(policy: PolicyManagementAccessPatch, 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]

Modify management access policies

Modifies one or more management access policies. One of ids or names is required. For renames, can only specify one old policy in ids or names.

Parameters

  • policy (PolicyManagementAccessPatch) – (required)

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

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

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

patch_policies_nfs(policy: PolicyNfsPatch, 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]

Modify NFS policies

Modifies one or more NFS policies. To enable a policy, set enabled=true. To disable a policy, set enabled=false. To rename a policy, set name to the new name. The ids or names parameter is required, but they cannot be set together.

Parameters

  • policy (PolicyNfsPatch) – (required)

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

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

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

patch_policies_password(policy: PolicyPassword, 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]

Modify password policies

Modifies one or more password policies. To enable a policy, set enabled=true. To disable a policy, set enabled=false.

Parameters

  • policy (PolicyPassword) – (required)

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

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

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

patch_policies_quota(policy: PolicyPatch, 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, ignore_usage: Optional[StrictBool] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Modify quota policies

Modifies one or more quota policies. To enable a policy, set enabled=true. To disable a policy, set enabled=false. To rename a policy, set name to the new name. The ids or names parameter is required, but they cannot be set together.

Parameters

  • policy (PolicyPatch) – (required)

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

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

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

  • ignore_usage (bool) – Flag used to override checks for quota management operations. If set to true, directory usage is not checked against the quota_limits that are set. If set to false, the actual logical bytes in use are prevented from exceeding the limits set on the directory. Client operations might be impacted. If the limit exceeds the quota, the client operation is not allowed. 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.

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_policies_quota_rules(rules: PolicyRuleQuotaPatch, 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]

Modify quota policy rules

Modifies quota policy rules.

Parameters

  • rules (PolicyRuleQuotaPatch) – (required)

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

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

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

  • 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 quota management operations. If set to true, directory usage is not checked against the quota_limits that are set. If set to false, the actual logical bytes in use are prevented from exceeding the limits set on the directory. Client operations might be impacted. If the limit exceeds the quota, the client operation is not allowed. 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.

patch_policies_smb(policy: PolicySmbPatch, 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]

Modify SMB policies

Modifies one or more SMB policies. To enable a policy, set enabled=true. To disable a policy, set enabled=false. To enable access based enumeration, set access_based_enumeration_enabled=true. To disable access based enumeration, set access_based_enumeration_enabled=false. To enable continuous availability, set continuous_availability=true. To disable continuous availability, set continuous_availability=false. To rename a policy, set name to the new name. The ids or names parameter is required, but they cannot be set together.

Parameters

  • policy (PolicySmbPatch) – (required)

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

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

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

patch_policies_snapshot(policy: PolicyPatch, 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]

Modify snapshot policies

Modifies one or more snapshot policies. To enable a policy, set enabled=true. To disable a policy, set enabled=true. To rename a policy, set name to the new name. The ids or names parameter is required, but they cannot be set together.

Parameters

  • policy (PolicyPatch) – (required)

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

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

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

patch_presets_workload(preset: PresetWorkloadPatch, 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]

Modify a workload preset

Modifies a workload preset by overriding the fields specified in preset. To rename a workload preset, set name to the new name.

Parameters

  • preset (PresetWorkloadPatch) – (required)

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

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

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

patch_protection_group_snapshots(protection_group_snapshot: ProtectionGroupSnapshotPatch, 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]

Modify a protection group snapshot

Modifies a protection group snapshot so that it can be destroyed. To destroy a volume, set destroyed=true. To recover a volume that has been destroyed and is pending eradication, set destroyed=false. The names or ids parameter is required, but they cannot be set together.

Parameters

  • protection_group_snapshot (ProtectionGroupSnapshotPatch) – (required)

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

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

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

patch_protection_groups(protection_group: ProtectionGroup, 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]

Modify a protection group

Modifies the protection group schedules to generate and replicate snapshots to another array or to an external storage system. Renames or destroys a protection group.

Parameters

  • protection_group (ProtectionGroup) – (required)

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

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

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

patch_protection_groups_targets(target: TargetProtectionGroupPostPatch, 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]

Modify a protection group target

Modifies the source array to replicate protection group data to the target, or disallows the source array from replicating protection group data to the target. The allowed parameter must be set from the target array. The group_names parameter represents the name of the protection group. The allowed and group_names parameters are required and must be set together. Offload targets do not support the allowed parameter.

Parameters

  • target (TargetProtectionGroupPostPatch) – (required)

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

patch_realms(realm: RealmPatch, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, destroy_contents: Optional[StrictBool] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, ignore_usage: Optional[StrictBool] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Modify realms

Modifies realm details.

Parameters

  • realm (RealmPatch) – (required)

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

  • destroy_contents (bool) – Set to true to destroy contents (e.g., volumes, protection groups, snapshots) and containers (e.g., realms, pods, volume groups), including eradicating containers with content.

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

  • ignore_usage (bool) – Set to true to set a quota_limit that is lower than the existing usage. This ensures that no new volumes can be created until the existing usage drops below the quota_limit. 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.

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_remote_protection_group_snapshots(remote_protection_group_snapshot: DestroyedPatchPost, 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]

Modify a remote protection group snapshot

Modifies a remote protection group snapshot, removing it from the offload target and destroying the snapshot. 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

  • remote_protection_group_snapshot (DestroyedPatchPost) – (required)

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

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

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

patch_remote_protection_groups(remote_protection_group: RemoteProtectionGroup, 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]

Modify a remote protection group

Modifies the snapshot retention schedule of a remote protection group. Also destroys a remote protection group from the offload target. Before the remote protection group can be destroyed, the offload target must first be removed from the protection group via the source array. 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

  • remote_protection_group (RemoteProtectionGroup) – (required)

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

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

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

patch_remote_volume_snapshots(remote_volume_snapshot: DestroyedPatchPost, 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]

Modify a remote volume snapshot

Modifies a remote volume snapshot by destroying or recovering it from the offload target. The on parameter represents the name of the offload target. The names parameter and the on parameter are required and must be used together.

Parameters

  • remote_volume_snapshot (DestroyedPatchPost) – (required)

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

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

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

patch_smi_s(smi_s: Smis, 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]

Modify SLP and SMI-S

Modifies the Service Location Protocol (SLP) and the SMI-S provider, enabling or disabling them.

Parameters

  • smi_s (Smis) – (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.

patch_smtp_servers(smtp: SmtpServer, 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]

Modify SMTP server attributes

Modifies SMTP server attributes. Values include user_name, password, relay_host, sender_domain, sender_username, subject_prefix, body_prefix, encryption_mode, and name.

Parameters

  • smtp (SmtpServer) – (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.

patch_snmp_agents(snmp_agent: SnmpAgentPatch, 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]

Modify SNMP agent

Modifies the name or the protocol attributes of the SNMP agent.

Parameters

  • snmp_agent (SnmpAgentPatch) – (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.

patch_snmp_managers(snmp_manager: SnmpManagerPatch, 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]

Modify SNMP manager

Modifies the name or the protocol attributes of the specified SNMP manager.

Parameters

  • snmp_manager (SnmpManagerPatch) – (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.

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

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_software_installations(command: StrictStr, current_step_id: StrictStr, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, software_installations: Optional[SoftwareInstallationPatch] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Modify software upgrade

Modifies a software upgrade by continuing, retrying, or aborting it. All override_checks are updated before the command is issued if add_override_checks is present. The override_checks parameter is valid when command is set to continue or retry.

Parameters

  • command (str) – A user command that interacts with the upgrade. Commands may only be issued when the upgrade is paused. Valid values are continue, retry, and abort. The continue command continues a paused upgrade. The retry command retries the previous step. The abort command aborts the upgrade. (required)

  • current_step_id (str) – The current step id of the installation. (required)

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

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

  • software_installations (SoftwareInstallationPatch) –

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_sso_saml2_idps(idp: Saml2SsoPatch, 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]

Modify SAML2 SSO configurations

Modifies one or more attributes of SAML2 SSO configurations.

Parameters

  • idp (Saml2SsoPatch) – (required)

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

patch_sso_saml2_idps_test(idp: Saml2SsoPost, 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]

Modify provided SAML2 SSO configurations

Modifies the provided SAML2 SSO configurations. If the configurations with the specified ids or names exist, the provided configurations will overwrite the existing configurations, but will not be persisted in the array.

Parameters

  • idp (Saml2SsoPost) – (required)

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

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

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

patch_subnets(subnet: SubnetPatch, 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]

Modify subnet

Modifies one or more specified subnet properties.

Parameters

  • subnet (SubnetPatch) – (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.

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

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_support(support: SupportPatch, 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]

Create connection path

Creates a connection path from the array to another array.

Parameters

  • support (SupportPatch) – (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.

patch_support_diagnostics_settings(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, purity_default: 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]

Update diagnostics tools

Update diagnostics tools from downloaded bundle.

Parameters

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

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

  • purity_default (bool) – Set diagnostics tool to default version.

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_support_remote_assist_sessions(support: SupportRemoteAssistSessionsPatch, 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]

Modify remote assist session

Modifies settings for remote assist sessions.

Parameters

  • support (SupportRemoteAssistSessionsPatch) – (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.

patch_support_remote_assist_sessions_settings(support: SupportRemoteAssistSessionsSettings, 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]

Update remote assist session global settings

Updates global settings for remote assist sessions.

Parameters

  • support (SupportRemoteAssistSessionsSettings) – (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.

patch_syslog_servers(syslog_server: SyslogServer, 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]

Modify syslog server

Modifies the URI and services of a configured syslog server.

Parameters

  • syslog_server (SyslogServer) – (required)

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

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

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

patch_syslog_servers_settings(syslog_server_settings: SyslogServerSettings, contexts: 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]

Modify syslog settings

Modifies syslog settings. Values include continuation_token, items, more_items_remaining, and total_item_count.

Parameters

  • syslog_server_settings (SyslogServerSettings) – (required)

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

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_vchosts(vchost: VchostPatch, 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]

Modify a vchost

Modifies an existing vchost. The names or ids query parameter is required.

Parameters

  • vchost (VchostPatch) – (required)

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

patch_vchosts_certificates(certificate: VchostCertificatePatch, 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]

Modify a vchost certificate

Modifies 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

  • certificate (VchostCertificatePatch) – (required)

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

patch_vchosts_endpoints(endpoint: VchostEndpointPatch, 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]

Modify a vchost endpoint

Modifies 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

  • endpoint (VchostEndpointPatch) – (required)

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

patch_virtual_machines(virtual_machine: VirtualMachinePost, 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]

Update a virtual machine

Updates a virtual machine, recovering it from the destroyed state. If the virtual machine is of type vvol, the source property of the request body must be a recovery_context value retrieved from the GET /virtual-machines endpoint. If recovering the virtual machine will cause a conflict with an existing virtual machine, the operation will fail.

Parameters

  • virtual_machine (VirtualMachinePost) – (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.

patch_volume_groups(volume_group: VolumeGroupPatch, 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, destroy_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]

Modify a volume group

Modifies a volume group. You can rename, destroy, recover, or set QoS limits for a volume group. To rename a volume group, set name to the new name. To destroy a volume group, set destroyed=true. To recover a volume group that has been destroyed and is pending eradication, set destroyed=false. Sets the bandwidth and IOPS limits of a volume group through the respective bandwidth_limit and iops_limit parameter. The ids or names parameter is required, but they cannot be set together. Sets the priority adjustment for a volume group using the priority_adjustment_operator and priority_adjustment_value fields.

Parameters

  • volume_group (VolumeGroupPatch) – (required)

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

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

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

  • destroy_contents (bool) – Set to true to destroy contents (e.g., volumes, protection groups, snapshots) and containers (e.g., realms, pods, volume groups), including eradicating containers with content.

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

patch_volume_snapshots(volume_snapshot: VolumeSnapshotPatch, 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]

Modify a volume snapshot

Modifies a volume snapshot by renaming, destroying, or recovering it. To rename the suffix of a volume snapshot, set name to the new suffix name. To recover a volume snapshot that has been destroyed and is pending eradication, set destroyed=true. The ids or names parameter is required, but they cannot be set together.

Parameters

  • volume_snapshot (VolumeSnapshotPatch) – (required)

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

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

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

patch_volumes(volume: VolumePatch, remove_from_protection_groups: Optional[Union[ReferenceType, List[ReferenceType]]] = None, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, add_to_protection_groups: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, add_to_protection_group_ids: Optional[ConstrainedListValue[StrictStr]] = None, add_to_protection_group_names: Optional[ConstrainedListValue[StrictStr]] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, remove_from_protection_group_ids: Optional[ConstrainedListValue[StrictStr]] = None, remove_from_protection_group_names: Optional[ConstrainedListValue[StrictStr]] = None, truncate: 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]

Modify a volume

Modifies a volume by renaming, destroying, or resizing it. To rename a volume, set name to the new name. To destroy a volume, set destroyed=true. To recover a volume that has been destroyed and is pending eradication, set destroyed=false. Set the bandwidth and IOPS limits of a volume through the respective bandwidth_limit and iops_limit parameter. This moves the volume into a pod or volume group through the respective pod or volume_group parameter. The ids or names parameter is required, but they cannot be set together.

Parameters

  • volume (VolumePatch) – (required)

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

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

  • add_to_protection_group_ids (List[str]) – The volumes will be added to the specified protection groups along with creation or movement across pods and array. When a volume is moved, the specified protection groups must be in the target pod or array. Enter multiple ids in comma-separated format.

  • add_to_protection_group_names (List[str]) – The volumes will be added to the specified protection groups along with creation or movement across pods and array. When a volume is moved, the specified protection groups must be in the target pod or array. Enter multiple names in a comma-separated format.

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

  • remove_from_protection_group_ids (List[str]) – The volumes will be removed from the specified protection groups in the source pod or array along with the move. This can only be used when moving volumes across pods and arrays and must include all protection groups that the volumes are members of before the move. Enter multiple ids in a comma-separated format.

  • remove_from_protection_group_names (List[str]) – The volumes will be removed from the specified protection groups in the source pod or array along with the move. This can only be used when moving volumes across pods and arrays and must include all protection groups that the volumes are members of before the move. Enter multiple names in a comma-separated format.

  • truncate (bool) – If set to true, reduces the size of a volume during a volume resize operation. When a volume is truncated, Purity automatically takes an undo snapshot, providing a 24-hour window during which the previous contents can be retrieved. After truncating a volume, its provisioned size can be subsequently increased, but the data in truncated sectors cannot be retrieved. If set to false or not set at all and the volume is being reduced in size, the volume copy operation fails. Required if the provisioned parameter is set to a volume size that is smaller than the original size.

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

patch_workloads(workload: WorkloadPatch, 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]

Modify a workload

Modifies a workload by renaming or destroying it. To rename a workload, set name to the new name. To destroy a workload, set destroyed=true. To recover a workload that has been destroyed and is pending eradication, set destroyed=false. The ids or names parameter is required, but they cannot be set together.

Parameters

  • workload (WorkloadPatch) – (required)

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

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

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

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

Create Active Directory account

Creates one or more Active Directory accounts. The user and password provided are used to join the array to the specified domain.

Parameters

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

  • active_directory (ActiveDirectoryPost) – (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.

  • join_existing_account (bool) – If specified as true, the domain is searched for a pre-existing computer account to join to, and no new account will be created within the domain. The user specified when joining a pre-existing account must have permissions to ‘read all properties from’ and ‘reset the password of’ the pre-existing account. join_ou will be read from the pre-existing account and cannot be specified when joining to an existing account. If not specified, defaults to false.

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_admins(admin: AdminPost, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, 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]

Create an administrator

Creates an administrator.

Parameters

  • admin (AdminPost) – (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.

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

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_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, timeout: Optional[StrictInt] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Create API tokens

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

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

  • timeout (int) – The duration of API token validity, in milliseconds.

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_admins_policies_management_access(policies: PolicyAssignmentPost, 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, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Create a membership between an administrator with one or more management access policies.

Creates a membership between an administrator with one or more management access policies. One of member_ids or member_names parameter is required.

Parameters

  • policies (PolicyAssignmentPost) – (required)

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

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

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

Create alert watcher

Creates one or more alert watcher email addresses, adding them to 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.

  • alert_watcher (AlertWatcherPost) –

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_alerts_rules(code: StrictInt, parameter: StrictStr, alert_rule: AlertRules, 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]

Create a custom alert rule

Creates an alert rule with a custom value.

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)

  • alert_rule (AlertRules) – (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.

post_api_clients(api_clients: ApiClientPost, 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]

Create an API client

Creates an API client. Newly created API clients are disabled by default. Enable an API client through the PATCH method. The names, issuer, and public_key parameters are required. The access_policies or max_role parameter is required, but they cannot be set together.

Parameters

  • api_clients (ApiClientPost) – (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.

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

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_array_connections(array_connection: ArrayConnectionPost, contexts: 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]

Create an array connection

Creates a connection between this array and the specified array.

Parameters

  • array_connection (ArrayConnectionPost) – (required)

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

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_arrays_erasures(eradicate_all_data: StrictBool, preserve_configuration_data: ConstrainedListValue[StrictStr], authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, skip_phonehome_check: 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]

Create a process for factory reset

Creates the initiation of the factory reset process

Parameters

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

  • preserve_configuration_data (List[str]) – A comma-separated list of configuration data types to preserve. A value of all will preserve all configuration data types. Valid values include all. (required)

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

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

  • skip_phonehome_check (bool) – A flag to skip phonehome connectivity check. If skip_phonehome_check is not set, the factory reset will fail if phonehome connectivity check fails. Arrays that intentionally disable phonehome or do not permit connectivity to Pure Storage’s cloud servers must set this flag to true in order to start 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.

post_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]

Create a factory reset token

Creates a token that can be used to perform a factory reset on the array. Factory reset tokens can only be created after the array has been prepared for reset (e.g., all volumes and snapshots must first be eradicated). After a token has been created, operations that would take the array out of the prepared state are disabled (e.g., creating volumes) until all tokens have been deleted.

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.

post_certificate_groups(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]

Create certificate-groups

Creates one or more certificate groups on the array.

Parameters

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

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

post_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]

Create certificate-groups/certificates

Creates one or more certificates to one or more certificate groups on the array.

Parameters

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

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

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

post_certificates(certificate: CertificatePost, 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]

Create certificate

Creates a certificate object and specifies the valid time period and organization details of the certificate. A certificate can be imported or manually configured.

Parameters

  • certificate (CertificatePost) – (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.

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

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_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]

Create certificates orcertificate-groups

Creates one or more certificates to one or more certificate groups.

Parameters

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

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

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

post_certificates_certificate_signing_requests(certificate: CertificateSigningRequestPost, 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]

Create certificate-signing-requests

Creates a certificate signing request using a specified certificate and parameters.

Parameters

  • certificate (CertificateSigningRequestPost) – (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.

post_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, connection: Optional[ConnectionPost] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Create a connection between a volume and host or host group

Creates a connection between a volume and a 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).

  • connection (ConnectionPost) –

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_directories(directory: DirectoryPost, 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, context_names: Optional[ConstrainedListValue[StrictStr]] = None, file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Create directory

Creates a managed directory at the specified path. The managed directory name must consist of a file system name prefix and a managed directory name suffix (separated with ‘&#58;’). The suffix must be between 1 and 63 characters (alphanumeric and ‘-’) in length and begin and end with a letter or number. The suffix must include at least one letter or ‘-’. Set names to create a managed directory with the specified full managed directory name, or set file_system_names or file_system_ids in the query parameters and suffix in the body parameters to create a managed directory in the specified file system with the specified suffix. These two options are exclusive.

Parameters

  • directory (DirectoryPost) – (required)

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

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

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

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

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

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

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

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

Create NLM reclamation

Creates an NLM reclamation, which is a system-wide operation that affects all clients, so only one may be in progress at a time. Attempting to initiate reclamation while one is in progress will result in an error. When NLM reclamation is initiated, all NLM locks are deleted and client applications are notified that they can reacquire their locks within a grace period.

Parameters

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

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

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

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_directories_policies_audit_file(policies: DirectoryPolicyPost, 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, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Create a membership between a directory and one or more audit policies

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

Parameters

  • policies (DirectoryPolicyPost) – (required)

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

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_directories_policies_autodir(policies: DirectoryPolicyPost, 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, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Create a membership between a directory with one or more auto managed directory policies

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

Parameters

  • policies (DirectoryPolicyPost) – (required)

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

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_directories_policies_nfs(policies: DirectoryPolicyExportPost, 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, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Create a membership between a directory and one or more NFS policies

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

Parameters

  • policies (DirectoryPolicyExportPost) – (required)

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

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_directories_policies_quota(policies: DirectoryPolicyPost, 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, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Create a membership between a directory and one or more quota policies

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

Parameters

  • policies (DirectoryPolicyPost) – (required)

  • 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 quota management operations. If set to true, directory usage is not checked against the quota_limits that are set. If set to false, the actual logical bytes in use are prevented from exceeding the limits set on the directory. Client operations might be impacted. If the limit exceeds the quota, the client operation is not allowed. 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.

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_directories_policies_smb(policies: DirectoryPolicyExportPost, 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, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Create a membership between a directory and one or more SMB policies

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

Parameters

  • policies (DirectoryPolicyExportPost) – (required)

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

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_directories_policies_snapshot(policies: DirectoryPolicyPost, 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, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Create a membership between a directory with one or more snapshot policies

Creates a membership between a directory with one or more snapshot policies. The member_ids or member_names parameter is required, but cannot be set together.

Parameters

  • policies (DirectoryPolicyPost) – (required)

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

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_directory_exports(exports: DirectoryExportPost, 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, context_names: Optional[ConstrainedListValue[StrictStr]] = None, directory_ids: Optional[ConstrainedListValue[StrictStr]] = None, directory_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]

Create directory exports

Creates an export of a managed directory. The directory_ids or directory_names parameter is required, but cannot be set together. The policy_ids or policy_names parameter is required, but cannot be set together.

Parameters

  • exports (DirectoryExportPost) – (required)

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

  • 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. For example, fs:dir01,fs:dir02.

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

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

Create local group

Creates a local group.

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.

  • local_group (LocalGroupPost) –

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_directory_services_local_groups_members(local_membership: LocalGroupMembershipPost, groups: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, group_gids: Optional[ConstrainedListValue[StrictInt]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, group_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]

Create local group membership

Creates a local group membership with a group. The group_names, group_sids, or group_ids parameter is required, but cannot be set together.

Parameters

  • local_membership (LocalGroupMembershipPost) – The member_names, member_sids, or member_gids parameter is required, but cannot be set together. (required)

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

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

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

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

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

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

Create local user

Creates a local user.

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.

  • local_user (LocalUserPost) –

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_directory_services_local_users_members(local_membership: LocalUserMembershipPost, members: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, member_ids: Optional[ConstrainedListValue[StrictInt]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, member_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]

Create local user membership

Creates a local user membership with a group. The member_names or member_sids or member_ids parameter is required, but cannot be set together.

Parameters

  • local_membership (LocalUserMembershipPost) – The group_names, group_sids, or group_gids parameter is required, but cannot be set together. (required)

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

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_directory_services_roles(names: ConstrainedListValue[StrictStr], directory_service_roles: DirectoryServiceRolePost, 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]

Create a group in management access policy mappings

Creates one or more groups in 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)

  • directory_service_roles (DirectoryServiceRolePost) – (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.

post_directory_services_roles_policies_management_access(policies: PolicyAssignmentPost, 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, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Create a membership between a group to management access policy mapping with one or more management access policies

Creates a membership between a group to management access policy mapping with one or more management access policies. One of member_ids or member_names parameter is required.

Parameters

  • policies (PolicyAssignmentPost) – (required)

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

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_directory_snapshots(directory_snapshot: DirectorySnapshotPost, sources: 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, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Create directory snapshot

Creates a snapshot of the contents of a directory. The source_ids or source_names parameter is required, but they cannot be set together.

Parameters

  • directory_snapshot (DirectorySnapshotPost) – (required)

  • sources (ReferenceType or List[ReferenceType], optional) – A list of sources to query for. Overrides source_ids and source_names keyword arguments.

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

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

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

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_dns(dns: DnsPost, 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]

Create DNS configuration

Creates new DNS configuration with parameters including the domain suffix, the list of DNS name server IP addresses, and the list of services that DNS parameters apply to.

Parameters

  • dns (DnsPost) – (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.

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

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_file_systems(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]

Create file system

Creates one or more file systems.

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.

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

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_files(source_file: FilePost, directories: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, directory_ids: Optional[ConstrainedListValue[StrictStr]] = None, directory_names: Optional[ConstrainedListValue[StrictStr]] = None, overwrite: Optional[StrictBool] = None, paths: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Create a file copy

Creates a file copy from one path to another path. The directory_ids, directory_names or paths value must be specified. If the directory_ids or directory_names value is not specified, the file is copied to the source directory specified in the body params. The paths value refers to the path of the target file relative to the target directory. If paths value is not specified, the file will be copied to the relative path specified in source_path under the target directory. The source_path value refers to the path of the source file relative to the source directory. To overwrite an existing file, set the overwrite flag to true.

Parameters

  • source_file (FilePost) – (required)

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

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

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

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

  • overwrite (bool) – If set to true, overwrites an existing object during an object copy operation. If set to false or not set at all and the target name is an existing object, the copy operation fails. Required if the source body parameter is set and the source overwrites an existing object during the copy operation.

  • paths (List[str]) – Target file path relative to the target directory. Enter multiple target file path in a comma-separated format. For example, /dir1/dir2/file1,/dir3/dir4/file2.

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

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

Create a fleet

Creates a fleet and adds the current array as its first member. Additional arrays can be added to the fleet with POST /fleets/members.

Parameters

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

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

post_fleets_fleet_key(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]

Create a fleet key

Creates a fleet key allowing an array to be added to a fleet. This is the only time the fleet key is displayed, it cannot be retrieved subsequently. Note, creation of a subsequent key invalidates all keys created earlier.

Parameters

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

post_fleets_members(fleets: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, fleet_ids: Optional[ConstrainedListValue[StrictStr]] = None, fleet_names: Optional[ConstrainedListValue[StrictStr]] = None, members: Optional[FleetMemberPost] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Add members to a fleet

Adds arrays to an existing fleet. This API needs to be run from the array that’s joining the fleet. To add the current array to the fleet, specify its own array id or name, as well as the fleet key generated on any array already in the fleet. resource_type is remote-arrays. The array’s ID and name can be retrieved with a call to GET /arrays on the array.

Parameters

  • fleets (ReferenceType or List[ReferenceType], optional) – A list of fleets to query for. Overrides fleet_ids and fleet_names keyword arguments.

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

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

  • fleet_ids (List[str]) – Performs the operation on the unique Fleet IDs specified. This query currently accepts only 1 ID.

  • fleet_names (List[str]) – Performs the operation on the unique Fleet names specified. Enter multiple names in comma-separated format. For example, name01,name02. This query currently accepts only 1 name.

  • members (FleetMemberPost) – Info about the members being added to fleet.

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_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, host_group: Optional[HostGroupPost] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Create a host group and upsert tags

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

  • host_group (HostGroupPost) –

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_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]

Create a membership to a host group

Create a membership between a host and a host group. Adding a membership to a host group automatically connects the host to all volumes associated with the group. Multiple hosts can be belong to a host group, but a host can only belong to one host group. Hosts can be added to 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.

post_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]

Create a host group

Creates a host group member and assigns to a protection group. Members that are already in the protection group are not affected. For asynchronous replication, only members of the same type can belong to a protection group. 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.

post_hosts(host: HostPost, 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]

Create a host and upsert tags

Creates a host for which the names query parameter is required.

Parameters

  • host (HostPost) – (required)

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

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

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

post_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]

Create a membership to a host group

Creates a membership to a host group. Creating a membership to a host group automatically connects the host to all volumes associated with the group. Multiple hosts can be belong to a host group, but a host can only belong to one host group. Hosts can be added to 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.

post_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]

Create a host

Creates a host member and adds it to a protection group. Members that are already in the protection group are not affected. For asynchronous replication, only members of the same type can belong to a protection group. 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.

post_kmip(kmip: KmipPost, 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]

Create KMIP server object

Creates KMIP server objects.

Parameters

  • kmip (KmipPost) – (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.

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

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_log_targets_file(log_target_file: LogTargetFile, 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]

Create file log target

Creates a new file log target.

Parameters

  • log_target_file (LogTargetFile) – (required)

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

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

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

post_log_targets_syslog(syslog_server: SyslogServer, 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]

Create syslog server

Creates a new syslog server.

Parameters

  • syslog_server (SyslogServer) – (required)

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

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

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

post_maintenance_windows(maintenance_window: MaintenanceWindowPost, 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]

Create a maintenance window

Creates a maintenance window that suppresses alerts for a specified period of time. A maintenance window can be manually closed at any time. The names and timeout parameters are required. Set the names parameter to environment.

Parameters

  • maintenance_window (MaintenanceWindowPost) – (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.

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

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_network_interfaces(network: NetworkInterfacePost, 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]

Create network interface

Creates a network interface on a controller on the array.

Parameters

  • network (NetworkInterfacePost) – (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.

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

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_offloads(offload: OffloadPost, 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, initialize: Optional[StrictBool] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Create offload target

Creates an offload target, connecting it to an array. Before you can connect to, manage, and replicate to an offload target, the Purity Run app must be installed.

Parameters

  • offload (OffloadPost) – (required)

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

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

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

  • initialize (bool) – If set to true, initializes the Amazon S3/Azure Blob container/Google Cloud Storage in preparation for offloading. The parameter must be set to true if this is the first time the array is connecting to the offload target.

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

Create pod replica links

Creates pod replica links between two arrays. 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.

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

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

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_pods(pod: PodPost, 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_throttle: Optional[StrictBool] = 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]

Create a pod

Creates a pod on the local array. Each pod must be given a unique name across the arrays to which they are stretched. A pod cannot be stretched to an array that already contains a pod with the same name. After a pod has been created, add volumes and protection groups, and then stretch the pod to another connected array.

Parameters

  • pod (PodPost) – (required)

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

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

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

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

  • allow_throttle (bool) – If set to true, allows operation to fail if array health is not optimal.

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

post_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, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Creates a pod to be stretched to an array

Creates a pod to be stretched to an array. When a pod is stretched to an array, the data in the arrays over which the pod is stretched is synchronously replicated. The group_names parameter represents the name of the pod to be stretched. The member_names parameter represents the name of the array over which the pod is to be stretched. 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.

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_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, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Creates a pod to be stretched to a member

Creates a pod to be stretched to a member. When a pod is stretched to an array, the data in the arrays over which the pod is stretched is synchronously replicated. The member_names or member_ids parameter represents the array over which the pod is to be stretched. 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.

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_pods_test(pod: PodPost, 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_throttle: Optional[StrictBool] = 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]

Create an attempt to clone a pod

Creates an attempt to clone a pod on the local array without actually cloning it to test whether the pod can be successfully cloned. This action does not suppport pod creation.

Parameters

  • pod (PodPost) – (required)

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

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

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

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

  • allow_throttle (bool) – If set to true, allows operation to fail if array health is not optimal.

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

post_policies_alert_watcher(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, context_names: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = None, policy: Optional[PolicyPost] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Create alert-watcher policies

Creates one or more alert-watcher policies. To copy a policy, the source_names or source_ids parameter is required, but they cannot be set together. To create a policy from scratch, policy body is required.

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

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

  • policy (PolicyPost) –

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_policies_alert_watcher_members(members: PolicyMemberPost, policies: 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, 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]

Create a membership between an object and an alert-watcher policy

Creates a membership between one or more objects and an alert-watcher policy. The policy_ids or policy_names parameter is required, but cannot be set together.

Parameters

  • members (PolicyMemberPost) – (required)

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

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

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

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

post_policies_alert_watcher_rules(rules: PolicyRuleAlertWatcherPost, policies: 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, 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]

Create alert-watcher policy rules

Creates 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

  • rules (PolicyRuleAlertWatcherPost) – (required)

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

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

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

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

post_policies_audit_file(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, context_names: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = None, policy: Optional[PolicyAuditFilePost] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Create audit policies

Creates one or more audit policies. To copy a policy, the source_names or source_ids parameter is required, but they cannot be set together. To create a policy from scratch, policy body is required.

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

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

  • policy (PolicyAuditFilePost) –

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_policies_audit_file_members(members: PolicyMemberPost, policies: 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, 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]

Create a membership between a managed directory and a audit policy

Creates a membership between one or more managed directories and a audit policy. The policy_ids or policy_names parameter is required, but cannot be set together.

Parameters

  • members (PolicyMemberPost) – (required)

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

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

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

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

post_policies_autodir(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, context_names: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = None, policy: Optional[PolicyPost] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Create auto managed directory policies

Creates one or more auto managed directory policies. To copy a policy, set one of either source_names or source_ids. Each policy can only have one entry. To create a policy from scratch, policy body is required.

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

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

  • policy (PolicyPost) –

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_policies_autodir_members(members: PolicyMemberPost, policies: 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, 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]

Create auto managed directory policies

Creates a membership between one or more resources with an auto managed directory policy. Applicable resources are directories. The policy_ids or policy_names parameter is required, but they cannot be set together.

Parameters

  • members (PolicyMemberPost) – (required)

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

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

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

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

post_policies_management_access(names: ConstrainedListValue[StrictStr], sources: Optional[Union[ReferenceType, List[ReferenceType]]] = None, 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, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = None, policy: Optional[PolicyManagementAccessPost] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Create management access policies

Creates one or more management access policies. To copy a policy, one of source_names or source_ids is required. To create a policy from scratch, policy body is required.

Parameters

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

  • sources (ReferenceType or List[ReferenceType], optional) – A list of sources to query for. Overrides source_ids and source_names keyword arguments.

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

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

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

  • policy (PolicyManagementAccessPost) –

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_policies_management_access_members(members: PolicyMemberPost, policies: 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, 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]

Create a membership between an object and a management access policy

Creates a membership between one or more objects and a management access policy.

Parameters

  • members (PolicyMemberPost) – (required)

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

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

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

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

post_policies_nfs(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, context_names: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = None, policy: Optional[PolicyNfsPost] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Create NFS policies

Creates one or more NFS policies or copies an existing policy. To copy a policy, the source_names or source_ids parameter is required, but they cannot be set together. To create a policy, policy body is required.

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

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

  • policy (PolicyNfsPost) –

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_policies_nfs_client_rules(rules: PolicyRuleNfsClientPost, policies: 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, 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]

Create NFS client policy rules

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

Parameters

  • rules (PolicyRuleNfsClientPost) – (required)

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

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

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

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

post_policies_nfs_members(members: PolicyMemberExportPost, policies: 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, 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]

Create NFS policies

Creates a membership between one or more resources and an NFS policy. Applicable resources are directories. The policy_ids or policy_names parameter is required, but cannot be set together.

Parameters

  • members (PolicyMemberExportPost) – (required)

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

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

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

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

post_policies_quota(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, context_names: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = None, policy: Optional[PolicyPost] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Create quota policies

Creates one or more quota policies. To copy a policy, the source_names or source_ids parameter is required, but they cannot be set together. To create a policy from scratch, policy body is required.

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

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

  • policy (PolicyPost) –

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_policies_quota_members(members: PolicyMemberPost, policies: 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, 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]

Create a membership between a managed directory and a quota policy

Creates a membership between one or more managed directories and a quota policy. The policy_ids or policy_names parameter is required, but cannot be set together.

Parameters

  • members (PolicyMemberPost) – (required)

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

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

  • 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 quota management operations. If set to true, directory usage is not checked against the quota_limits that are set. If set to false, the actual logical bytes in use are prevented from exceeding the limits set on the directory. Client operations might be impacted. If the limit exceeds the quota, the client operation is not allowed. If not specified, defaults to false.

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

post_policies_quota_rules(rules: PolicyRuleQuotaPost, policies: 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, 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]

Create quota policy rules

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

Parameters

  • rules (PolicyRuleQuotaPost) – (required)

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

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

  • 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 quota management operations. If set to true, directory usage is not checked against the quota_limits that are set. If set to false, the actual logical bytes in use are prevented from exceeding the limits set on the directory. Client operations might be impacted. If the limit exceeds the quota, the client operation is not allowed. If not specified, defaults to false.

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

post_policies_smb(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, context_names: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = None, policy: Optional[PolicySmbPost] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Create SMB policies

Creates one or more SMB policies. To copy a policy, set one of either source_names or source_ids. Each policy can only have one entry. To create a policy from scratch, policy body is required. To create an SMB policy with access based enumeration enabled, set access_based_enumeration_enabled=true. To create an SMB policy with continuous availability enabled, set continuous_availability=true.

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

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

  • policy (PolicySmbPost) –

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_policies_smb_client_rules(rules: PolicyRuleSmbClientPost, policies: 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, 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]

Create SMB client policy rules

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

Parameters

  • rules (PolicyRuleSmbClientPost) – (required)

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

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

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

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

post_policies_smb_members(members: PolicyMemberExportPost, policies: 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, 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]

Create SMB policies

Creates a membership between one or more resources and an SMB policy. Applicable resources are directories. The policy_ids or policy_names parameter is required, but cannot be set together.

Parameters

  • members (PolicyMemberExportPost) – (required)

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

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

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

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

post_policies_snapshot(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, context_names: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = None, policy: Optional[PolicyPost] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Create snapshot policies

Creates one or more snapshot policies. To copy a policy, set one of either source_names or source_ids. Each policy can only have one entry. To create a policy from scratch, policy body is required.

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

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

  • policy (PolicyPost) –

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_policies_snapshot_members(members: PolicyMemberPost, policies: 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, 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]

Create snapshot policies

Creates a membership between one or more resources and a snapshot policy. Applicable resources are directories. The policy_ids or policy_names parameter is required, but cannot be set together.

Parameters

  • members (PolicyMemberPost) – (required)

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

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

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

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

post_policies_snapshot_rules(rules: PolicyRuleSnapshotPost, policies: 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, 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]

Create snapshot policy rules

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

Parameters

  • rules (PolicyRuleSnapshotPost) – (required)

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

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

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

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

post_presets_workload(names: ConstrainedListValue[StrictStr], preset: PresetWorkloadPost, 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]

Create a workload preset

Creates one workload preset.

Parameters

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

  • preset (PresetWorkloadPost) – (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.

post_protection_group_snapshots(sources: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, allow_throttle: Optional[StrictBool] = None, apply_retention: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, for_replication: Optional[StrictBool] = None, replicate: Optional[StrictBool] = None, replicate_now: Optional[StrictBool] = None, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = None, protection_group_snapshot: Optional[ProtectionGroupSnapshotPost] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Create a protection group snapshot

Creates a point-in-time snapshot of the contents of a protection group. The source_ids or source_names parameter is required, but they cannot be set together.

Parameters

  • sources (ReferenceType or List[ReferenceType], optional) – A list of sources to query for. Overrides source_ids and source_names keyword arguments.

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

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

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

  • allow_throttle (bool) – If set to true, allows snapshot to fail if array health is not optimal.

  • apply_retention (bool) – If true, applies the local and remote retention policy to the snapshots.

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

  • for_replication (bool) – If true, destroys and eradicates the snapshot after 1 hour.

  • replicate (bool) – If set to true, queues up and begins replicating to each allowed target after all earlier replication sessions for the same protection group have been completed to that target. The replicate and replicate_now parameters cannot be used together.

  • replicate_now (bool) – If set to true, replicates the snapshots to each allowed target. The replicate and replicate_now parameters cannot be used together.

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

  • protection_group_snapshot (ProtectionGroupSnapshotPost) –

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

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

Create an action to send protection group snapshots

Creates an action to send protection group snapshots to protection pgroup targets. When the on option is used, only specified targets will recieve the protection group snapshots.

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.

  • convert_source_to_baseline (bool) – Set to true to have the snapshot be eradicated when it is no longer baseline on source.

  • 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 (List[str]) – Performs the operation locally with the target names specified as the destinations of the operation. Enter multiple target names in comma-separated format. For example, targetName01,targetName02.

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_protection_group_snapshots_test(sources: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, allow_throttle: Optional[StrictBool] = None, apply_retention: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, for_replication: Optional[StrictBool] = None, replicate: Optional[StrictBool] = None, replicate_now: Optional[StrictBool] = None, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = None, protection_group_snapshot: Optional[ProtectionGroupSnapshotPost] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Create an attempt to take protection group snapshot

Creates an attempt to take the protection group snapshot, without actually taking it, to test if the snapshot can be successfully taken.

Parameters

  • sources (ReferenceType or List[ReferenceType], optional) – A list of sources to query for. Overrides source_ids and source_names keyword arguments.

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

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

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

  • allow_throttle (bool) – If set to true, allows snapshot to fail if array health is not optimal.

  • apply_retention (bool) – If true, applies the local and remote retention policy to the snapshots.

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

  • for_replication (bool) – If true, destroys and eradicates the snapshot after 1 hour.

  • replicate (bool) – If set to true, queues up and begins replicating to each allowed target after all earlier replication sessions for the same protection group have been completed to that target. The replicate and replicate_now parameters cannot be used together.

  • replicate_now (bool) – If set to true, replicates the snapshots to each allowed target. The replicate and replicate_now parameters cannot be used together.

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

  • protection_group_snapshot (ProtectionGroupSnapshotPost) –

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_protection_groups(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, context_names: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, overwrite: Optional[StrictBool] = None, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = None, protection_group: Optional[ProtectionGroupPost] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Create a protection group and upsert tags

Creates a protection group on the local array for asynchronous replication.

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

  • overwrite (bool) – If set to true, overwrites an existing object during an object copy operation. If set to false or not set at all and the target name is an existing object, the copy operation fails. Required if the source body parameter is set and the source overwrites an existing object during the copy operation.

  • source_ids (List[str]) – The id of the protection group or protection group snapshot to be copied into a new or existing protection group. If the destination protection group and all of its volumes already exist, include the overwrite parameter to overwrite all of the existing volumes with the snapshot contents. If including the overwrite parameter, the names of the volumes that are being overwritten must match the names of the volumes that are being restored. If the source is a protection group, the latest snapshot of the protection group will be used as the source during the copy operation.

  • source_names (List[str]) – The name of the protection group or protection group snapshot to be copied into a new or existing protection group. If the destination protection group and all of its volumes already exist, include the overwrite parameter to overwrite all of the existing volumes with the snapshot contents. If including the overwrite parameter, the names of the volumes that are being overwritten must match the names of the volumes that are being restored. If the source is a protection group, the latest snapshot of the protection group will be used as the source during the copy operation.

  • protection_group (ProtectionGroupPost) –

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

  • async_req – Whether to execute the request asynchronously.

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

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

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

Returns

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

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_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]

Creates an action to add a host group to a protection group

Creates an action to add a host group member to a protection group. Members that are already in the protection group are not affected. For asynchronous replication, only members of the same type can belong to a protection group. 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.

post_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]

Create an action to add a host to a protection group

Creates an action to add a host member to a protection group. Members that are already in the protection group are not affected. For asynchronous replication, only members of the same type can belong to a protection group. 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.

post_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]

Create an action to add a target to a protection group

Creates an action to add an array, pod, or offload target to 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 added to 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.

post_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]

Create a volume to add it to a protection group

Creates a volume member and adds it to a protection group. Members that are already in the protection group are not affected. For asynchronous replication, only members of the same type can belong to a protection group. 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.

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

Create realms

Creates realms on the local array. Each realm must be given a name that is unique across the connected arrays.

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.

  • realm (RealmPost) –

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • async_req – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_remote_protection_group_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_throttle: Optional[StrictBool] = None, apply_retention: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, convert_source_to_baseline: Optional[StrictBool] = None, for_replication: Optional[StrictBool] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, on: Optional[StrictStr] = None, replicate: Optional[StrictBool] = None, replicate_now: Optional[StrictBool] = None, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = None, remote_protection_group_snapshot: Optional[RemoteProtectionGroupSnapshotPost] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Create remote protection group snapshot

Creates remote protection group snapshots.

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_throttle (bool) – If set to true, allows snapshot to fail if array health is not optimal.

  • apply_retention (bool) – If true, applies the local and remote retention policy to the snapshots.

  • 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.

  • convert_source_to_baseline (bool) – Set to true to have the snapshot be eradicated when it is no longer baseline on source.

  • for_replication (bool) – If true, destroys and eradicates the snapshot after 1 hour.

  • 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.

  • replicate (bool) – If set to true, queues up and begins replicating to each allowed target after all earlier replication sessions for the same protection group have been completed to that target. The replicate and replicate_now parameters cannot be used together.

  • replicate_now (bool) – If set to true, replicates the snapshots to each allowed target. The replicate and replicate_now parameters cannot be used together.

  • 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.

  • remote_protection_group_snapshot (RemoteProtectionGroupSnapshotPost) –

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • async_req – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_remote_protection_group_snapshots_test(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_throttle: Optional[StrictBool] = None, apply_retention: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, convert_source_to_baseline: Optional[StrictBool] = None, for_replication: Optional[StrictBool] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, on: Optional[StrictStr] = None, replicate: Optional[StrictBool] = None, replicate_now: Optional[StrictBool] = None, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = None, remote_protection_group_snapshot: Optional[RemoteProtectionGroupSnapshotPost] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Create an attempt to take remote protection group snapshot

Creates an attempt to take a remote protection group snapshot without actually taking it, to test if the snapshot can be successfully taken.

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_throttle (bool) – If set to true, allows snapshot to fail if array health is not optimal.

  • apply_retention (bool) – If true, applies the local and remote retention policy to the snapshots.

  • 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.

  • convert_source_to_baseline (bool) – Set to true to have the snapshot be eradicated when it is no longer baseline on source.

  • for_replication (bool) – If true, destroys and eradicates the snapshot after 1 hour.

  • 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.

  • replicate (bool) – If set to true, queues up and begins replicating to each allowed target after all earlier replication sessions for the same protection group have been completed to that target. The replicate and replicate_now parameters cannot be used together.

  • replicate_now (bool) – If set to true, replicates the snapshots to each allowed target. The replicate and replicate_now parameters cannot be used together.

  • 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.

  • remote_protection_group_snapshot (RemoteProtectionGroupSnapshotPost) –

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • async_req – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_remote_volume_snapshots(remote_volume_snapshot: RemoteVolumeSnapshotPost, sources: 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, on: Optional[StrictStr] = None, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Create a volume snapshot on a connected remote target or offload target

Creates a volume snapshot on the specified connected remote target or offload target.

Parameters

  • remote_volume_snapshot (RemoteVolumeSnapshotPost) – (required)

  • sources (ReferenceType or List[ReferenceType], optional) – A list of sources to query for. Overrides source_ids and source_names keyword arguments.

  • contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

  • 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.

  • on (str) – Performs the operation on the target name specified. For example, targetName01.

  • 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.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • async_req – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_resource_accesses_batch(items: ConstrainedListValue[models.ResourceAccess], 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]

Create a resource access configuration

Creates resource access objects.

Parameters

  • items (List[ResourceAccess]) – (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.

post_snmp_managers(snmp_manager: SnmpManagerPost, 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]

Create SNMP manager

Creates a Purity SNMP manager object that identifies a host (SNMP manager) and specifies the protocol attributes for communicating with it. Once a manager object is created, the transmission of SNMP traps is immediately enabled.

Parameters

  • snmp_manager (SnmpManagerPost) – (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.

  • names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • async_req – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_software(software: SoftwarePost, 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]

Create a software package

Creates a software package download.

Parameters

  • software (SoftwarePost) – (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.

post_software_bundle(source: SoftwareBundlePost, x_request_id: Optional[StrictStr] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Create software-bundle

Creates and initiates a software bundle download.

Parameters

  • source (SoftwareBundlePost) – (required)

  • x_request_id (str) – Supplied by client during request or generated by server.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • async_req – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_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]

Create a software check task

Creates a software check task. If there are no previously queued or running software check tasks, the new task immediately starts. Otherwise, it is queued and starts once all previously queued or running software check tasks finish. To create a task, use a software name and version.

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.

post_software_installations(software_ids: ConstrainedListValue[StrictStr], software_installations: SoftwareInstallationPost, softwares: 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]

Create a software upgrade

Creates and initiates a software upgrade.

Parameters

  • software_ids (List[str]) – A comma-separated list of software IDs. (required)

  • software_installations (SoftwareInstallationPost) – (required)

  • softwares (ReferenceType or List[ReferenceType], optional) – A list of softwares to query for. Overrides software_ids 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.

post_software_patches(name: StrictStr, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, allow_ha_reduction: 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]

Create a software patch

Creates software patch download and installation.

Parameters

  • name (str) – Name of software patch to install (required)

  • authorization (str) – Deprecated. Please use Client level authorization

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_ha_reduction (bool) – If Software Patch has ha_reduction_required set to true, allow_ha_reduction must be set to true for Software Patch installation.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • async_req – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_sso_saml2_idps(names: ConstrainedListValue[StrictStr], idp: Saml2SsoPost, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, 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]

Create SAML2 SSO configurations

Creates SAML2 SSO configurations.

Parameters

  • names (List[str]) – Performs the operation on the unique name specified. For example, name01. Enter multiple names in comma-separated format. (required)

  • idp (Saml2SsoPost) – (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.

post_subnets(names: ConstrainedListValue[StrictStr], subnet: SubnetPost, 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]

Create subnet

Creates a subnet with the specified parameters.

Parameters

  • names (List[str]) – Performs the operation on the unique name specified. For example, name01. Enter multiple names in comma-separated format. (required)

  • subnet (SubnetPost) – (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.

post_syslog_servers(syslog_server: SyslogServer, 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]

Create syslog server

Creates a new syslog server.

Parameters

  • syslog_server (SyslogServer) – (required)

  • references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

  • contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

  • 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.

post_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, allow_stretched_multi_vchost: 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]

Create a vchost-connection between protocol endpoint and vchost.

Creates a vchost-connection between protocol endpoint and vchost. Each vchost is associated with a vCenter. Each protocol endpoint is associated with a storage container. A vchost-connection makes the storage container accessible to the vCenter when the vCenter attempts to mount the container. One of protocol_endpoint_names or protocol_endpoint_ids query parameters and one of 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.

  • allow_stretched_multi_vchost (bool) – If set to true, users are allowed to create a new vchost-connection to a stretched container that already has a vchost-connection. In principle, a stretched container can only have one vchost-connection at a time.

  • 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.

post_vchosts(vchost: VchostPost, 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]

Create a vchost

Creates a vchost. The names query parameter is required.

Parameters

  • vchost (VchostPost) – (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.

  • names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • async_req – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_vchosts_certificates(certificate: VchostCertificatePost, vchosts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[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]

Create a vchost certificate

Creates an association between a certificate and vchost on one or more endpoints. The vchost_names or vchost_ids query parameter is required.

Parameters

  • certificate (VchostCertificatePost) – (required)

  • vchosts (ReferenceType or List[ReferenceType], optional) – A list of vchosts to query for. Overrides vchost_ids and vchost_names keyword arguments.

  • authorization (str) – Deprecated. Please use Client level authorization

  • x_request_id (str) – Supplied by client during request or generated by server.

  • 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.

post_vchosts_endpoints(endpoint: VchostEndpointPost, vchosts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[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]

Create a vchost endpoint

Creates a vchost endpoint. Either the vchost_names or vchost_ids query parameter is required.

Parameters

  • endpoint (VchostEndpointPost) – (required)

  • vchosts (ReferenceType or List[ReferenceType], optional) – A list of vchosts to query for. Overrides vchost_ids and vchost_names keyword arguments.

  • authorization (str) – Deprecated. Please use Client level authorization

  • x_request_id (str) – Supplied by client during request or generated by server.

  • 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.

post_virtual_machines(virtual_machine: VirtualMachinePost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, overwrite: 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]

Create a virtual machine

Creates one or more virtual machines from a protection group snapshot. If the virtual machine is of type vvol, the source property of the request body must be a recovery_context value retrieved from the GET /virtual-machine-snapshots endpoint. If overwrite is specified, an existing virtual machine will have its volumes overwritten by the snapshot. Otherwise, a new virtual machine will be created from the snapshot. If creating the new virtual machine will cause a conflict with an existing virtual machine, the operation will fail.

Parameters

  • virtual_machine (VirtualMachinePost) – (required)

  • authorization (str) – Deprecated. Please use Client level authorization

  • x_request_id (str) – Supplied by client during request or generated by server.

  • overwrite (bool) – If set to true, overwrites an existing object during an object copy operation. If set to false or not set at all and the target name is an existing object, the copy operation fails. Required if the source body parameter is set and the source overwrites an existing object during the copy operation.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • async_req – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_volume_groups(volume_group: VolumeGroupPost, 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]

Create a volume group and upsert tags.

Creates a volume group. The volume group itself does not contain any meaningful content; instead, it acts as a container that is used to organize volumes. Once a volume group has been created, volumes can be created inside the volume group or moved into and out of the volume group.

Parameters

  • volume_group (VolumeGroupPost) – (required)

  • references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

  • contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

  • 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.

post_volume_snapshots(volume_snapshot: VolumeSnapshotPost, sources: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, allow_throttle: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, on: Optional[StrictStr] = None, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Create a volume snapshot

Creates a point-in-time snapshot of the contents of a volume. The source_ids or source_names parameter is required, but they cannot be set together.

Parameters

  • volume_snapshot (VolumeSnapshotPost) – (required)

  • sources (ReferenceType or List[ReferenceType], optional) – A list of sources to query for. Overrides source_ids and source_names keyword arguments.

  • contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

  • authorization (str) – Deprecated. Please use Client level authorization

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_throttle (bool) – If set to true, allows snapshot to fail if array health is not optimal.

  • 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.

  • on (str) – Performs the operation on the target name specified. For example, targetName01.

  • 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.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • async_req – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_volume_snapshots_test(volume_snapshot: VolumeSnapshotPost, sources: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, allow_throttle: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, on: Optional[StrictStr] = None, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Create the volume snapshot path

Creates the volume snapshot path without actually taking a volume snapshot.

Parameters

  • volume_snapshot (VolumeSnapshotPost) – (required)

  • sources (ReferenceType or List[ReferenceType], optional) – A list of sources to query for. Overrides source_ids and source_names keyword arguments.

  • contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

  • authorization (str) – Deprecated. Please use Client level authorization

  • x_request_id (str) – Supplied by client during request or generated by server.

  • allow_throttle (bool) – If set to true, allows snapshot to fail if array health is not optimal.

  • 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.

  • on (str) – Performs the operation on the target name specified. For example, targetName01.

  • 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.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • async_req – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_volumes(volume: VolumePost, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, add_to_protection_groups: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, add_to_protection_group_ids: Optional[ConstrainedListValue[StrictStr]] = None, add_to_protection_group_names: Optional[ConstrainedListValue[StrictStr]] = None, allow_throttle: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, overwrite: Optional[StrictBool] = None, with_default_protection: 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]

Create or copy a volume and upsert tags

Creates one or more virtual storage volumes of the specified size. If provisioned is not specified, the size of the new volume defaults to 1 MB. The names query parameter is required. The add_to_protection_group_names query parameter specifies a list of protection group names that will compose the initial protection for the volume. The with_default_protection query parameter specifies whether to use the container default protection configuration for the volume. The add_to_protection_group_names and with_default_protection query parameters cannot be provided when overwrite is true.

Parameters

  • volume (VolumePost) – (required)

  • references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

  • contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

  • add_to_protection_groups (ReferenceType or List[ReferenceType], optional) – A list of add_to_protection_groups to query for. Overrides add_to_protection_group_ids and add_to_protection_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.

  • add_to_protection_group_ids (List[str]) – The volumes will be added to the specified protection groups along with creation or movement across pods and array. When a volume is moved, the specified protection groups must be in the target pod or array. Enter multiple ids in comma-separated format.

  • add_to_protection_group_names (List[str]) – The volumes will be added to the specified protection groups along with creation or movement across pods and array. When a volume is moved, the specified protection groups must be in the target pod or array. Enter multiple names in a comma-separated format.

  • allow_throttle (bool) – If set to true, allows operation to fail if array health is not optimal.

  • 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.

  • overwrite (bool) – If set to true, overwrites an existing object during an object copy operation. If set to false or not set at all and the target name is an existing object, the copy operation fails. Required if the source body parameter is set and the source overwrites an existing object during the copy operation.

  • with_default_protection (bool) – If specified as true, the initial protection of the newly created volumes will be the union of the container default protection configuration and add_to_protection_group_names. If specified as false, the default protection of the container will not be applied automatically. The initial protection of the newly created volumes will be configured by add_to_protection_group_names. If not specified, defaults to true.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • async_req – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_volumes_batch(volume: ConstrainedListValue[models.VolumeBatchPost], contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, allow_throttle: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, overwrite: Optional[StrictBool] = None, with_default_protection: 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]

Create or copy volumes and upsert tags

Creates or copies a list of virtual storage volumes. Volumes of different sizes, vgroups, and tag upsertions can be copied this way.

Parameters

  • volume (List[VolumeBatchPost]) – A list of volumes to be created or copied. (required)

  • 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_throttle (bool) – If set to true, allows operation to fail if array health is not optimal.

  • 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.

  • overwrite (bool) – If set to true, overwrites an existing object during an object copy operation. If set to false or not set at all and the target name is an existing object, the copy operation fails. Required if the source body parameter is set and the source overwrites an existing object during the copy operation.

  • with_default_protection (bool) – If specified as true, the initial protection of the newly created volumes will be the union of the container default protection configuration and add_to_protection_group_names. If specified as false, the default protection of the container will not be applied automatically. The initial protection of the newly created volumes will be configured by add_to_protection_group_names. If not specified, defaults to true.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • async_req – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_volumes_batch_test(volume: ConstrainedListValue[models.VolumeBatchPost], contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, allow_throttle: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, overwrite: Optional[StrictBool] = None, with_default_protection: 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]

Create an attempt to copy volumes and upsert tags

Creates an attempt to copy virtual storage volumes of different sizes in different vgroups and also upserts tags, without actually creating them, to test if they can be successfully created. Only available for creating volumes via a copy, not direct volume creation.

Parameters

  • volume (List[VolumeBatchPost]) – A list of volumes to be copied. (required)

  • 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_throttle (bool) – If set to true, allows operation to fail if array health is not optimal.

  • 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.

  • overwrite (bool) – If set to true, overwrites an existing object during an object copy operation. If set to false or not set at all and the target name is an existing object, the copy operation fails. Required if the source body parameter is set and the source overwrites an existing object during the copy operation.

  • with_default_protection (bool) – If specified as true, the initial protection of the newly created volumes will be the union of the container default protection configuration and add_to_protection_group_names. If specified as false, the default protection of the container will not be applied automatically. The initial protection of the newly created volumes will be configured by add_to_protection_group_names. If not specified, defaults to true.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • async_req – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_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]

Create a volume and add it to a protection group

Creates a volume member and adds it to a protection group. Members that are already in the protection group are not affected. For asynchronous replication, only members of the same type can belong to a protection group. 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.

post_volumes_test(volume: VolumePost, references: Optional[Union[ReferenceType, List[ReferenceType]]] = None, contexts: Optional[Union[ReferenceType, List[ReferenceType]]] = None, add_to_protection_groups: Optional[Union[ReferenceType, List[ReferenceType]]] = None, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, add_to_protection_group_ids: Optional[ConstrainedListValue[StrictStr]] = None, add_to_protection_group_names: Optional[ConstrainedListValue[StrictStr]] = None, allow_throttle: Optional[StrictBool] = None, context_names: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, overwrite: Optional[StrictBool] = None, with_default_protection: 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]

Create a dry run attempt to copy a volume

Creates a dry run attempt to see if copying a volume would succeed. No virtual volumes are actually copied or created in this process.

Parameters

  • volume (VolumePost) – (required)

  • references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

  • contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

  • add_to_protection_groups (ReferenceType or List[ReferenceType], optional) – A list of add_to_protection_groups to query for. Overrides add_to_protection_group_ids and add_to_protection_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.

  • add_to_protection_group_ids (List[str]) – The volumes will be added to the specified protection groups along with creation or movement across pods and array. When a volume is moved, the specified protection groups must be in the target pod or array. Enter multiple ids in comma-separated format.

  • add_to_protection_group_names (List[str]) – The volumes will be added to the specified protection groups along with creation or movement across pods and array. When a volume is moved, the specified protection groups must be in the target pod or array. Enter multiple names in a comma-separated format.

  • allow_throttle (bool) – If set to true, allows operation to fail if array health is not optimal.

  • 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.

  • overwrite (bool) – If set to true, overwrites an existing object during an object copy operation. If set to false or not set at all and the target name is an existing object, the copy operation fails. Required if the source body parameter is set and the source overwrites an existing object during the copy operation.

  • with_default_protection (bool) – If specified as true, the initial protection of the newly created volumes will be the union of the container default protection configuration and add_to_protection_group_names. If specified as false, the default protection of the container will not be applied automatically. The initial protection of the newly created volumes will be configured by add_to_protection_group_names. If not specified, defaults to true.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • async_req – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

post_workloads(names: ConstrainedListValue[StrictStr], workload: WorkloadPost, presets: Optional[Union[ReferenceType, List[ReferenceType]]] = None, 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, preset_ids: Optional[ConstrainedListValue[StrictStr]] = None, preset_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Create a workload

Creates one workload.

Parameters

  • names (List[str]) – Performs the operation on the unique resource names specified. Only one value is supported. (required)

  • workload (WorkloadPost) – (required)

  • presets (ReferenceType or List[ReferenceType], optional) – A list of presets to query for. Overrides preset_ids and preset_names keyword arguments.

  • contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

  • references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides names keyword argument.

  • 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.

  • preset_ids (List[str]) – Create the resource using the preset specified by the ID. Only one preset can be specified. One of the preset_ids or preset_names parameters are required, but they cannot be set together.

  • preset_names (List[str]) – Create the resource using the preset specified by name. Only one preset can be specified. One of the preset_ids or preset_names parameters are 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.

post_workloads_placement_recommendations(inputs: WorkloadPlacementRecommendation, presets: Optional[Union[ReferenceType, List[ReferenceType]]] = None, placements: 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, placement_names: Optional[ConstrainedListValue[StrictStr]] = None, preset_ids: Optional[ConstrainedListValue[StrictStr]] = None, preset_names: Optional[ConstrainedListValue[StrictStr]] = None, async_req: Optional[bool] = None, _preload_content: bool = True, _return_http_data_only: Optional[bool] = None, _request_timeout: Optional[Union[float, Tuple[float, float]]] = None) → Union[ValidResponse, ErrorResponse]

Create a request for a workload placement recommendation.

Creates a recommendation for the placement of the specified workload. The computation might take a few minutes.

Parameters

  • inputs (WorkloadPlacementRecommendation) – (required)

  • presets (ReferenceType or List[ReferenceType], optional) – A list of presets to query for. Overrides preset_ids and preset_names keyword arguments.

  • placements (ReferenceType or List[ReferenceType], optional) – A list of placements to query for. Overrides placement_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.

  • placement_names (List[str]) – Placements from the preset which should be used to compute recommendation. Optional parameter if preset has just one placement.

  • preset_ids (List[str]) – Creates the workload placement recommendations using the presets specified by ids. Only one preset can be specified. One of the preset_ids or preset_names parameters are required, but they cannot be set together.

  • preset_names (List[str]) – Creates the workload placement recommendations using the presets specified by names. Only one preset can be specified. One of the preset_ids or preset_names parameters are 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.

put_admins_cache(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]

Update or refresh entries in the administrator cache

Updates entries in the cache for administrators who currently do not have a cache entry, otherwise refreshes the existing entry.

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.

put_arrays_cloud_provider_tags_batch(tag: ConstrainedListValue[models.CloudProviderTag], 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]

Update user tags on the cloud.

Updates users tags to deployed cloud resources of a CBS array.

Parameters

  • tag (List[CloudProviderTag]) – A list of tags to be created or, if already existing, updated. (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.

put_arrays_tags(tag: ConstrainedListValue[models.NonCopyableTag], contexts: 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]

Update tags

Updates tags.

Parameters

  • tag (List[NonCopyableTag]) – A list of tags to be created or, if they already exist, updated. (required)

  • 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.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • async_req – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout (int or (float, float), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

ValidResponse: If the call was successful. ErrorResponse: If the call was not successful.

Return type

[Union[ValidResponse, ErrorResponse]]

Raises

PureError: If calling the API fails.

Raises

ValueError: If a parameter is of an invalid type.

Raises

TypeError: If invalid or missing parameters are used.

put_host_groups_tags_batch(tag: ConstrainedListValue[models.NonCopyableTagBatch], 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, 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]

Update tags

Updates tags.

Parameters

  • tag (List[NonCopyableTagBatch]) – A list of tags to be created or, if one already exists, updated. (required)

  • 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.

  • 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.

put_hosts_tags_batch(tag: ConstrainedListValue[models.NonCopyableTagBatch], 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, 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]

Update tags

Updates tags.

Parameters

  • tag (List[NonCopyableTagBatch]) – A list of tags to be created or, if one already exists, updated. (required)

  • 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.

  • 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.

put_pods_tags_batch(tag: ConstrainedListValue[models.Tag], 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, 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]

Update tags

Updates tags for all specified objects.

Parameters

  • tag (List[Tag]) – A list of tags to be created or, if already existing, updated. (required)

  • 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.

  • 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.

put_presets_workload(preset: PresetWorkload, 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]

Update a workload preset

Updates a workload preset by replacing it with the new contents in preset. The ids or names parameter is required, but they cannot be set together.

Parameters

  • preset (PresetWorkload) – (required)

  • references (ReferenceType or List[ReferenceType], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • contexts (ReferenceType or List[ReferenceType], optional) – A list of contexts to query for. Overrides context_names keyword argument.

  • 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.

put_protection_groups_tags_batch(tag: ConstrainedListValue[models.TagBatch], 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, 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]

Update tags

Updates tags for all specified objects.

Parameters

  • tag (List[TagBatch]) – A list of tags to be created or, if one already exists, updated. (required)

  • 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.

  • 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.

put_realms_tags_batch(tag: ConstrainedListValue[models.NonCopyableTag], 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, 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]

Update tags

Updates or creates tags for all specified objects.

Parameters

  • tag (List[NonCopyableTag]) – A list of tags to be created or, if already existing, updated. (required)

  • 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.

  • 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.

put_volume_groups_tags_batch(tag: ConstrainedListValue[models.TagBatch], 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, 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]

Update tags

Updates tags for all specified objects.

Parameters

  • tag (List[TagBatch]) – A list of tags to be created or, if one already exists, updated. (required)

  • 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.

  • 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.

put_volume_snapshots_tags_batch(tag: ConstrainedListValue[models.TagBatch], 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, 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]

Update tags

Updates tags.

Parameters

  • tag (List[TagBatch]) – A list of tags to be created or modified. (required)

  • 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.

  • 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.

put_volumes_tags_batch(tag: ConstrainedListValue[models.TagBatch], 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, 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]

Update tags

Updates tags.

Parameters

  • tag (List[TagBatch]) – A list of tags to be created or, if one already exists, updated. (required)

  • 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.

  • 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.

put_workloads_tags_batch(tag: ConstrainedListValue[models.TagBatch], 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, 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]

Update tags

Updates or creates tags for all specified objects.

Parameters

  • tag (List[TagBatch]) – A list of tags to be created or, if they already exist, updated. (required)

  • 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.

  • 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.

Properties

Property

class pypureclient.flasharray.Property(value)

A Property object models a property of a resource and allows for easy compounding, sorting, and filtering with them. It is converted to a string when calling any API and can also be replaced by a string.

__add__(other)

The + operator. Create a subproperty.

Parameters

other (Property) – The Property to be the subproperty of the given Property.

Returns

Property

Raises

PureError – If other is not of the proper type.

__eq__(other)

The == operator. Create a Filter that checks for equality.

Parameters

other (str, int, bool) – The value to compare to.

Returns

Filter

Raises

PureError – If other is not of the proper type.

__ge__(other)

The >= operator. Create a Filter that checks for greater than or equal.

Parameters

other (str, int) – The value to compare to.

Returns

Filter

Raises

PureError – If other is not of the proper type.

__getitem__(index)

The [] operator. Create a list Property with the given index.

Parameters

index (str) – The list index to use.

Returns

Property

Raises

PureError – If index is not “all” or “any”.

__gt__(other)

The > operator. Create a Filter that checks for greater than.

Parameters

other (str, int) – The value to compare to.

Returns

Filter

Raises

PureError – If other is not of the proper type.

__init__(value)

Initialize a Property.

Parameters

value (str) – The name of the property.

__le__(other)

The <= operator. Create a Filter that checks for less than or equal.

Parameters

other (str, int) – The value to compare to.

Returns

Filter

Raises

PureError – If other is not of the proper type.

__lt__(other)

The < operator. Create a Filter that checks for less than.

Parameters

other (str, int) – The value to compare to.

Returns

Filter

Raises

PureError – If other is not of the proper type.

__ne__(other)

The != operator. Create a Filter that checks for inequality.

Parameters

other (str, int, bool) – The value to compare to.

Returns

Filter

Raises

PureError – If other is not of the proper type.

__repr__()

Return the string value of the Property.

Returns

str

all()

Create a list Property indexed by “all”.

Returns

Property

any()

Create a list Property indexed by “any”.

Returns

Property

ascending()

Create a Property that can be sorted in ascending order.

Returns

Property

descending()

Create a property that can be sorted in descending order.

Returns

Property

exists()

Create a Filter that checks for existance of the given Property.

Returns

Filter

subproperty(other)

Create a subproperty.

Parameters

other (Property) – The Property to be the subproperty of the given Property.

Returns

Property

Raises

PureError – If other is not of the proper type.

Filter

class pypureclient.flasharray.Filter(operation, operand1, operand2=None)

A Filter object models a filter string by keeping track of operations between Properties, values, and other Filters. It is converted to a string when calling any API and can also be replaced by a string.

__and__(other)

The & operator. Create a Filter that is the AND of two Filters.

Parameters

other (Filter) – The Filter to AND.

Returns

Filter

Raises

PureError – If other is not of the proper type.

__init__(operation, operand1, operand2=None)

Initialize a Filter. Should not be used directly. Instead, use the static methods to create Filters.

Parameters

  • operation (_Operation) – The operation.

  • operand1 (any) – The first operand.

  • operand2 (any, optional) – The second operand, if the operation is binary. Defaults to None.

__invert__()

The ~ operator. Create a Filter that is the inverse of another Filter.

Returns

Filter

__or__(other)

The | operator. Create a Filter that is the OR of two Filters.

Parameters

other (Filter) – The Filter to OR.

Returns

Filter

Raises

PureError – If other is not of the proper type.

__repr__()

Return the string value of the Filter.

Returns

str

static and_(operand1, operand2)

Create a Filter that is the AND of two Filters.

Parameters

  • operand1 (Filter) – The first Filter.

  • operand2 (Filter) – The second Filter.

Returns

Filter

Raises

PureError – If either operand is not of the proper type.

static contains(operand1, operand2)

Create a Filter that checks for substring containment.

Parameters

  • operand1 (Property, str) – The Property to check.

  • operand2 (str) – The value to check for.

Returns

Filter

Raises

PureError – If either operand is not of the proper type.

static eq(operand1, operand2)

Create a Filter that checks for equality.

Parameters

  • operand1 (Property, str) – The Property to compare.

  • operand2 (str, int, bool) – The value to compare to.

Returns

Filter

Raises

PureError – If either operand is not of the proper type.

static exists(operand1)

Create a Filter that checks for existance of a Property.

Parameters

operand1 (Property, str) – The Property to check for.

Returns

Filter

Raises

PureError – If the operand is not of the proper type.

static ge(operand1, operand2)

Create a Filter that checks for greater than or equal.

Parameters

  • operand1 (Property, str) – The Property to compare.

  • operand2 (str, int) – The value to compare to.

Returns

Filter

Raises

PureError – If either operand is not of the proper type.

static gt(operand1, operand2)

Create a Filter that checks for greater than.

Parameters

  • operand1 (Property, str) – The Property to compare.

  • operand2 (str, int) – The value to compare to.

Returns

Filter

Raises

PureError – If either operand is not of the proper type.

static in_(operand1, operand2)

Create a Filter that checks if a Property is in a list of values.

Parameters

  • operand1 (Property, str) – The Property to check.

  • operand2 (list[str], list[int]) – The list of values.

Returns

Filter

Raises

PureError – If either operand is not of the proper type.

static le(operand1, operand2)

Create a Filter that checks for less than or equal.

Parameters

  • operand1 (Property, str) – The Property to compare.

  • operand2 (str, int) – The value to compare to.

Returns

Filter

Raises

PureError – If either operand is not of the proper type.

static lt(operand1, operand2)

Create a Filter that checks for less than.

Parameters

  • operand1 (Property, str) – The Property to compare.

  • operand2 (str, int) – The value to compare to.

Returns

Filter

Raises

PureError – If either operand is not of the proper type.

static ne(operand1, operand2)

Create a Filter that checks for inequality.

Parameters

  • operand1 (Property, str) – The Property to compare.

  • operand2 (str, int, bool) – The value to compare to.

Returns

Filter

Raises

PureError – If either operand is not of the proper type.

static not_(operand1)

Create a Filter that is the inverse of another Filter.

Parameters

operand1 (Filter) – The Filter to invert.

Returns

Filter

Raises

PureError – If the operand is not of the proper type.

static or_(operand1, operand2)

Create a Filter that is the OR of two Filters.

Parameters

  • operand1 (Filter) – The first Filter.

  • operand2 (Filter) – The second Filter.

Returns

Filter

Raises

PureError – If either operand is not of the proper type.

static tags(operand1, operand2)

Create a Filter that checks for a key-value tag.

Parameters

  • operand1 (str) – The key of the tag.

  • operand2 (str) – The value of the tag.

Returns

Filter

Raises

PureError – If either operand is not of the proper type.

Responses

ResponseHeaders

class pypureclient.flasharray.ResponseHeaders(x_request_id, x_ratelimit_limit_second, x_ratelimit_limit_minute, x_ratelimit_remaining_second, x_ratelimit_remaining_minute)

An object that includes headers from the server response.

__init__(x_request_id, x_ratelimit_limit_second, x_ratelimit_limit_minute, x_ratelimit_remaining_second, x_ratelimit_remaining_minute)

Initialize a ResponseHeaders.

Parameters

  • x_request_id (str) – The X-Request-ID from the client or generated by the server.

  • x_ratelimit_limit_second (int) – The number of requests available per second.

  • x_ratelimit_limit_minute (int) – The number of requests available per minute.

  • x_ratelimit_remaining_second (int) – The number of requests remaining in that second.

  • x_ratelimit_remaining_minute (int) – The number of requests remaining in that minute.

__repr__()

Return a pretty formatted string of the object.

Returns

str

to_dict()

Return a dictionary of the class attributes.

Returns

dict

ValidResponse

class pypureclient.flasharray.ValidResponse(status_code, continuation_token, total_item_count, items, headers, total=None, more_items_remaining=None, errors=None)

A response that indicates the request was successful and has the returned data.

__init__(status_code, continuation_token, total_item_count, items, headers, total=None, more_items_remaining=None, errors=None)

Initialize a ValidResponse.

Parameters

  • status_code (int) – The HTTP status code.

  • continuation_token (str) – An opaque token to iterate over a collection of resources. May be None.

  • total_item_count (int) – The total number of items available in the collection.

  • items (ItemIterator) – An iterator over the items in the collection.

  • headers (dict) – Response headers from the server.

__repr__()

Return a pretty formatted string of the object. Does not convert the items to a list of items by using the iterator.

Returns

str

to_dict()

Return a dictionary of the class attributes. It will convert the items to a list of items by exhausting the iterator. If any items were previously iterated, they will be missed.

Returns

dict

ApiError

class pypureclient.flasharray.ApiError(context, message, location_context=None)

An object that models the error response from the server.

__init__(context, message, location_context=None)

Initialize an ApiError.

Parameters

  • context (str) – The context in which the error occurred.

  • message (str) – The error message.

  • location_context (str) – The execution context where the error occurred.

__repr__()

Return a pretty formatted string of the object.

Returns

str

to_dict()

Return a dictionary of the class attributes.

Returns

dict

ErrorResponse

class pypureclient.flasharray.ErrorResponse(status_code, errors, headers)

A response that indicates there was an error with the request and has the list of errors.

__init__(status_code, errors, headers)

Initialize an ErrorResponse.

Parameters

  • status_code (int) – The HTTP status code.

  • errors (list[ApiError]) – The list of errors encountered.

  • headers (dict) – Response headers from the server.

__repr__()

Return a pretty formatted string of the object.

Returns

str

to_dict()

Return a dictionary of the class attributes.

Returns

dict

Models

ReferenceType

pydantic model pypureclient.flasharray.ReferenceType(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None)

It’s used for reference arg on api function. This allows user to pass collections of Model objects to the method without transforming them to ids or names.

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified.

field name: Optional[StrictStr] = None

The resource name, such as volume name, pod name, snapshot name, and so on.

ActiveDirectory

pydantic model pypureclient.flasharray.ActiveDirectory(*, name: Optional[StrictStr] = None, computer_name: Optional[StrictStr] = None, directory_servers: Optional[ConstrainedListValue[StrictStr]] = None, domain: Optional[StrictStr] = None, kerberos_servers: Optional[ConstrainedListValue[StrictStr]] = None, tls: Optional[StrictStr] = None)
field computer_name: Optional[StrictStr] = None

The name of the computer account in the Active Directory domain.

field directory_servers: Optional[ConstrainedListValue[StrictStr]] = None

A list of directory servers used for lookups related to user authorization. Servers must be specified in FQDN format. All specified servers must be registered to the domain appropriately in the configured DNS of the array and are only communicated with over the secure LDAP (LDAPS) protocol. If this field is null, the servers are resolved for the domain in DNS.

field domain: Optional[StrictStr] = None

The Active Directory domain joined.

field kerberos_servers: Optional[ConstrainedListValue[StrictStr]] = None

A list of key distribution servers to use for Kerberos protocol. Servers must be specified in FQDN format. All specified servers must be registered to the domain appropriately in the configured DNS of the array. If this field is null, the servers are resolved for the domain in DNS.

field name: Optional[StrictStr] = None

A locally unique, system-generated name. The name cannot be modified.

field tls: Optional[StrictStr] = None

TLS mode for communication with domain controllers. Valid values are required and optional. required forces TLS communication with a domain controller. optional allows the use of non-TLS communication, TLS will still be preferred, if available. If not specified, defaults to required.

ActiveDirectoryGetResponse

pydantic model pypureclient.flasharray.ActiveDirectoryGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[ActiveDirectory]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[ActiveDirectory]] = None

A list of Active Directory computer account configuration objects.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

ActiveDirectoryPatch

pydantic model pypureclient.flasharray.ActiveDirectoryPatch(*, tls: Optional[StrictStr] = None)
field tls: Optional[StrictStr] = None

TLS mode for communication with domain controllers. Valid values are required and optional. required forces TLS communication with domain controller. optional allows the use of non-TLS communication, TLS will still be preferred, if available. If not specified, defaults to required.

ActiveDirectoryPost

pydantic model pypureclient.flasharray.ActiveDirectoryPost(*, computer_name: Optional[StrictStr] = None, directory_servers: Optional[ConstrainedListValue[StrictStr]] = None, domain: Optional[StrictStr] = None, join_ou: Optional[StrictStr] = None, kerberos_servers: Optional[ConstrainedListValue[StrictStr]] = None, password: Optional[StrictStr] = None, tls: Optional[StrictStr] = None, user: Optional[StrictStr] = None)
field computer_name: Optional[StrictStr] = None

The name of the computer account to be created in the Active Directory domain. If not specified, defaults to the name of the Active Directory configuration.

field directory_servers: Optional[ConstrainedListValue[StrictStr]] = None

A list of directory servers used for lookups related to user authorization. Servers must be specified in FQDN format. All specified servers must be registered to the domain appropriately in the configured DNS of the array and are only communicated with over the secure LDAP (LDAPS) protocol. If not specified, servers are resolved for the domain in DNS.

field domain: Optional[StrictStr] = None

The Active Directory domain to join.

field join_ou: Optional[StrictStr] = None

The distinguished name of the organizational unit in which the computer account should be created when joining the domain. The DC=… components of the distinguished name can be optionally omitted. If not specified, defaults to CN=Computers.

field kerberos_servers: Optional[ConstrainedListValue[StrictStr]] = None

A list of key distribution servers to use for Kerberos protocol. Servers must be specified in FQDN format. All specified servers must be registered to the domain appropriately in the configured DNS of the array. If not specified, servers are resolved for the domain in DNS.

field password: Optional[StrictStr] = None

The login password of the user with privileges to create the computer account in the domain. This is not persisted on the array.

field tls: Optional[StrictStr] = None

TLS mode for communication with domain controllers. Valid values are required and optional. required forces TLS communication with a domain controller. optional allows the use of non-TLS communication, TLS will still be preferred, if available. If not specified, defaults to required.

field user: Optional[StrictStr] = None

The login name of the user with privileges to create the computer account in the domain. This is not persisted on the array.

ActiveDirectoryResponse

pydantic model pypureclient.flasharray.ActiveDirectoryResponse(*, items: Optional[ConstrainedListValue[ActiveDirectory]] = None)
field items: Optional[ConstrainedListValue[ActiveDirectory]] = None

A list of Active Directory computer account configuration objects.

Admin

pydantic model pypureclient.flasharray.Admin(*, name: Optional[StrictStr] = None, api_token: Optional[ApiToken] = None, is_local: Optional[StrictBool] = None, locked: Optional[StrictBool] = None, lockout_remaining: Optional[StrictInt] = None, management_access_policies: Optional[ConstrainedListValue[ReferenceWithType]] = None, password: Optional[StrictStr] = None, public_key: Optional[StrictStr] = None, role: Optional[AdminRole] = None)
field api_token: Optional[ApiToken] = None
field is_local: Optional[StrictBool] = None

Returns a value of true if the user is local to the machine.

Constraints

  • type = boolean

field locked: Optional[StrictBool] = None

Returns a value of true if the user is currently locked out. otherwise false. Change to false to unlock a user. This field is only visible to array_admin roles. For all other users, the value is always null.

Constraints

  • type = boolean

field lockout_remaining: Optional[StrictInt] = None

The remaining lockout period if the user is locked out, in milliseconds. This field is only visible to array_admin roles. For all other users, the value is always null.

field management_access_policies: Optional[ConstrainedListValue[ReferenceWithType]] = None

List of management access policies associated with the administrator.

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and cannot be changed.

field password: Optional[StrictStr] = None

Password associated with the account.

field public_key: Optional[StrictStr] = None

Public key for SSH access. Multiple public keys can be specified, separated by newlines.

field role: Optional[AdminRole] = None

AdminApiToken

pydantic model pypureclient.flasharray.AdminApiToken(*, name: Optional[StrictStr] = None, api_token: Optional[ApiToken] = None)
field api_token: Optional[ApiToken] = None
field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and cannot be changed.

AdminApiTokenGetResponse

pydantic model pypureclient.flasharray.AdminApiTokenGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[AdminApiToken]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[AdminApiToken]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

AdminApiTokenResponse

pydantic model pypureclient.flasharray.AdminApiTokenResponse(*, items: Optional[ConstrainedListValue[AdminApiToken]] = None)
field items: Optional[ConstrainedListValue[AdminApiToken]] = None

AdminCache

pydantic model pypureclient.flasharray.AdminCache(*, name: Optional[StrictStr] = None, cached_at: Optional[StrictInt] = None, management_access_policies: Optional[ConstrainedListValue[FixedReferenceWithType]] = None, role: Optional[AdminRole] = None)
field cached_at: Optional[StrictInt] = None

Time when the entry was added to the cache, in milliseconds since the UNIX epoch.

field management_access_policies: Optional[ConstrainedListValue[FixedReferenceWithType]] = None

List of management access policies associated with the administrator.

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and cannot be changed.

field role: Optional[AdminRole] = None

AdminCacheGetResponse

pydantic model pypureclient.flasharray.AdminCacheGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[AdminCache]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[AdminCache]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

AdminCacheResponse

pydantic model pypureclient.flasharray.AdminCacheResponse(*, items: Optional[ConstrainedListValue[AdminCache]] = None)
field items: Optional[ConstrainedListValue[AdminCache]] = None

AdminGetResponse

pydantic model pypureclient.flasharray.AdminGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Admin]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[Admin]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

AdminPatch

pydantic model pypureclient.flasharray.AdminPatch(*, name: Optional[StrictStr] = None, api_token: Optional[ApiToken] = None, is_local: Optional[StrictBool] = None, locked: Optional[StrictBool] = None, lockout_remaining: Optional[StrictInt] = None, management_access_policies: Optional[ConstrainedListValue[ReferenceWithType]] = None, password: Optional[StrictStr] = None, public_key: Optional[StrictStr] = None, role: Optional[AdminRole] = None, old_password: Optional[StrictStr] = None)
field api_token: Optional[ApiToken] = None
field is_local: Optional[StrictBool] = None

Returns a value of true if the user is local to the machine.

Constraints

  • type = boolean

field locked: Optional[StrictBool] = None

Returns a value of true if the user is currently locked out. otherwise false. Change to false to unlock a user. This field is only visible to array_admin roles. For all other users, the value is always null.

Constraints

  • type = boolean

field lockout_remaining: Optional[StrictInt] = None

The remaining lockout period if the user is locked out, in milliseconds. This field is only visible to array_admin roles. For all other users, the value is always null.

field management_access_policies: Optional[ConstrainedListValue[ReferenceWithType]] = None

List of management access policies associated with the administrator.

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and cannot be changed.

field old_password: Optional[StrictStr] = None

The current password.

field password: Optional[StrictStr] = None

Password associated with the account.

field public_key: Optional[StrictStr] = None

Public key for SSH access. Multiple public keys can be specified, separated by newlines.

field role: Optional[AdminRole] = None

AdminPost

pydantic model pypureclient.flasharray.AdminPost(*, management_access_policies: Optional[ConstrainedListValue[ReferenceWithType]] = None, password: Optional[StrictStr] = None, role: Optional[AdminRole] = None)
field management_access_policies: Optional[ConstrainedListValue[ReferenceWithType]] = None

List of management access policies to associate with the administrator. Policies can be specified by the name or ID parameter, but they cannot be set together.

field password: Optional[StrictStr] = None

Password associated with the account.

field role: Optional[AdminRole] = None

AdminResponse

pydantic model pypureclient.flasharray.AdminResponse(*, items: Optional[ConstrainedListValue[Admin]] = None)
field items: Optional[ConstrainedListValue[Admin]] = None

AdminRole

pydantic model pypureclient.flasharray.AdminRole(*, name: Optional[StrictStr] = None)
field name: Optional[StrictStr] = None

The resource name, such as volume name, pod name, snapshot name, and so on.

AdminSettings

pydantic model pypureclient.flasharray.AdminSettings(*, lockout_duration: Optional[ConstrainedIntValue] = None, max_login_attempts: Optional[ConstrainedIntValue] = None, min_password_length: Optional[StrictInt] = None, required_authentication_methods: Optional[AdminSettingsRequiredAuthenticationMethods] = None, single_sign_on_enabled: Optional[StrictBool] = None)

Global settings for administrative accounts.

field lockout_duration: Optional[ConstrainedIntValue] = None

The lockout duration, in milliseconds, if a user is locked out after reaching the maximum number of login attempts. Ranges from 1 second to 90 days.

Constraints

  • minimum = 1000

  • maximum = 7776000000

field max_login_attempts: Optional[ConstrainedIntValue] = None

Maximum number of failed login attempts allowed before the user is locked out.

Constraints

  • minimum = 1

  • maximum = 20

field min_password_length: Optional[StrictInt] = None

Minimum password length. If not specified, defaults to 1.

field required_authentication_methods: Optional[AdminSettingsRequiredAuthenticationMethods] = None
field single_sign_on_enabled: Optional[StrictBool] = None

If true, then single sign-on is enabled for the array.

Constraints

  • type = boolean

AdminSettingsGetResponse

pydantic model pypureclient.flasharray.AdminSettingsGetResponse(*, items: Optional[ConstrainedListValue[AdminSettings]] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None)
field items: Optional[ConstrainedListValue[AdminSettings]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

AdminSettingsRequiredAuthenticationMethods

pydantic model pypureclient.flasharray.AdminSettingsRequiredAuthenticationMethods(*, ssh: Optional[ConstrainedListValue[StrictStr]] = None, web_ui: Optional[ConstrainedListValue[StrictStr]] = None)

Authentication methods that are required for the array on specific user interfaces.

field ssh: Optional[ConstrainedListValue[StrictStr]] = None

List of authentication methods that are required for SSH. Possible values include password, key, and default. securid-am is a possible value, but it cannot be changed through PATCH. If not specified, defaults to default. Specify password and key authentication methods to set up local multi-factor authentication for SSH.

field web_ui: Optional[ConstrainedListValue[StrictStr]] = None

List of authentication methods that are required for the web UI. Possible values include password, webauthn, and default. Other possible values include saml2 and securid-am but these cannot be changed through PATCH. If not specified, defaults to default. Specify password and webauthn authentication methods to set up local multi-factor authentication for web UI. External multi-factor authentication is configured through SAML2 SSO endpoints.

AdminSettingsResponse

pydantic model pypureclient.flasharray.AdminSettingsResponse(*, items: Optional[ConstrainedListValue[AdminSettings]] = None)
field items: Optional[ConstrainedListValue[AdminSettings]] = None

AggregateReplicationPerformance

pydantic model pypureclient.flasharray.AggregateReplicationPerformance(*, bytes_per_sec: Optional[ConstrainedIntValue] = None)
field bytes_per_sec: Optional[ConstrainedIntValue] = None

The total number of bytes of replication data transmitted and received per second.

Constraints

  • minimum = 0

Alert

pydantic model pypureclient.flasharray.Alert(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, context: Optional[FixedReference] = None, actual: Optional[StrictStr] = None, category: Optional[StrictStr] = None, closed: Optional[StrictInt] = None, code: Optional[StrictInt] = None, component_name: Optional[StrictStr] = None, component_type: Optional[StrictStr] = None, created: Optional[StrictInt] = None, description: Optional[StrictStr] = None, expected: Optional[StrictStr] = None, flagged: Optional[StrictBool] = None, issue: Optional[StrictStr] = None, knowledge_base_url: Optional[StrictStr] = None, notified: Optional[StrictInt] = None, severity: Optional[StrictStr] = None, state: Optional[StrictStr] = None, summary: Optional[StrictStr] = None, updated: Optional[StrictInt] = None)
field actual: Optional[StrictStr] = None

Actual condition at the time the alert is created.

field category: Optional[StrictStr] = None

The category of the alert. Valid values include array, hardware and software.

field closed: Optional[StrictInt] = None

The time the alert was closed in milliseconds since the UNIX epoch.

field code: Optional[StrictInt] = None

The code number of the alert.

field component_name: Optional[StrictStr] = None

The name of the component that generated the alert.

field component_type: Optional[StrictStr] = None

The type of component that generated the alert.

field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field created: Optional[StrictInt] = None

The time the alert was created in milliseconds since the UNIX epoch.

field description: Optional[StrictStr] = None

A short description of the alert.

field expected: Optional[StrictStr] = None

Expected state or threshold under normal conditions.

field flagged: Optional[StrictBool] = None

If set to true, the message is flagged. Important messages can can be flagged and listed separately.

Constraints

  • type = boolean

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field issue: Optional[StrictStr] = None

Information about the alert cause.

field knowledge_base_url: Optional[StrictStr] = None

The URL of the relevant knowledge base page.

field name: Optional[StrictStr] = None

A locally unique, system-generated name. The name cannot be modified.

field notified: Optional[StrictInt] = None

The time the most recent alert notification was sent in milliseconds since the UNIX epoch.

field severity: Optional[StrictStr] = None

The severity level of the alert. Valid values include info, warning, critical, and hidden.

field state: Optional[StrictStr] = None

The current state of the alert. Valid values include open, closing, and closed.

field summary: Optional[StrictStr] = None

A summary of the alert.

field updated: Optional[StrictInt] = None

The time the alert was last updated in milliseconds since the UNIX epoch.

AlertEvent

pydantic model pypureclient.flasharray.AlertEvent(*, name: Optional[StrictStr] = None, context: Optional[FixedReference] = None, actual: Optional[StrictStr] = None, alert: Optional[FixedReference] = None, code: Optional[StrictInt] = None, component_name: Optional[StrictStr] = None, component_type: Optional[StrictStr] = None, created: Optional[StrictInt] = None, expected: Optional[StrictStr] = None, issue: Optional[StrictStr] = None, knowledge_base_url: Optional[StrictStr] = None, severity: Optional[StrictStr] = None, state: Optional[StrictStr] = None, summary: Optional[StrictStr] = None, time: Optional[StrictInt] = None)
field actual: Optional[StrictStr] = None

Actual condition at the time the alert is created.

field alert: Optional[FixedReference] = None
field code: Optional[StrictInt] = None

The parent alert number.

field component_name: Optional[StrictStr] = None

The component type of the alert.

field component_type: Optional[StrictStr] = None

The component name of the alert.

field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field created: Optional[StrictInt] = None

The time the parent alert was created.

field expected: Optional[StrictStr] = None

Expected state and threshold under normal conditions.

field issue: Optional[StrictStr] = None

Information about the alert cause.

field knowledge_base_url: Optional[StrictStr] = None

The knowledge base URL of the alert.

field name: Optional[StrictStr] = None

A locally unique, system-generated name. The name cannot be modified.

field severity: Optional[StrictStr] = None

The severity level of the alert. Valid values include info, warning, critical, and hidden.

field state: Optional[StrictStr] = None

The state of the alert. Valid values include open, closing, and closed.

field summary: Optional[StrictStr] = None

A summary of the alert.

field time: Optional[StrictInt] = None

The time the event occurred.

AlertEventGetResponse

pydantic model pypureclient.flasharray.AlertEventGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[AlertEvent]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[AlertEvent]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

AlertEventResponse

pydantic model pypureclient.flasharray.AlertEventResponse(*, items: Optional[ConstrainedListValue[AlertEvent]] = None)
field items: Optional[ConstrainedListValue[AlertEvent]] = None

AlertGetResponse

pydantic model pypureclient.flasharray.AlertGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Alert]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[Alert]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

AlertResponse

pydantic model pypureclient.flasharray.AlertResponse(*, items: Optional[ConstrainedListValue[Alert]] = None)
field items: Optional[ConstrainedListValue[Alert]] = None

AlertRules

pydantic model pypureclient.flasharray.AlertRules(*, context: Optional[FixedReference] = None, code: Optional[StrictInt] = None, parameter: Optional[StrictStr] = None, value: Optional[StrictStr] = None)
field code: Optional[StrictInt] = None

The alert code that the rule applies to. Available alert codes for customization can be found in the alert rules catalog.

field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field parameter: Optional[StrictStr] = None

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.

field value: Optional[StrictStr] = None

The value to use for the custom alert rule. Valid values for an alert code and parameter combination can be found in the alert rules catalog.

AlertRulesCatalog

pydantic model pypureclient.flasharray.AlertRulesCatalog(*, context: Optional[FixedReference] = None, allowed_values: Optional[StrictStr] = None, code: Optional[StrictInt] = None, default_value: Optional[StrictStr] = None, parameter: Optional[StrictStr] = None, subject: Optional[StrictStr] = None)
field allowed_values: Optional[StrictStr] = None

The range of values allowed to set the custom alert rule to.

field code: Optional[StrictInt] = None

The alert code that the rule applies to.

field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field default_value: Optional[StrictStr] = None

The system default values for the alert code and parameter.

field parameter: Optional[StrictStr] = None

The parameter of the custom alert rule.

field subject: Optional[StrictStr] = None

The alert code description.

AlertRulesCatalogGetResponse

pydantic model pypureclient.flasharray.AlertRulesCatalogGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[AlertRulesCatalog]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[AlertRulesCatalog]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

AlertRulesCatalogResponse

pydantic model pypureclient.flasharray.AlertRulesCatalogResponse(*, items: Optional[ConstrainedListValue[AlertRulesCatalog]] = None)
field items: Optional[ConstrainedListValue[AlertRulesCatalog]] = None

AlertRulesGetResponse

pydantic model pypureclient.flasharray.AlertRulesGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[AlertRules]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[AlertRules]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

AlertRulesResponse

pydantic model pypureclient.flasharray.AlertRulesResponse(*, items: Optional[ConstrainedListValue[AlertRules]] = None)
field items: Optional[ConstrainedListValue[AlertRules]] = None

AlertWatcher

pydantic model pypureclient.flasharray.AlertWatcher(*, name: Optional[StrictStr] = None, enabled: Optional[StrictBool] = None)
field enabled: Optional[StrictBool] = None

If set to true, email notifications will be sent to this watcher for alerts. If set to false, email notification is disabled.

Constraints

  • type = boolean

field name: Optional[StrictStr] = None

A locally unique, system-generated name. The name cannot be modified.

AlertWatcherGetResponse

pydantic model pypureclient.flasharray.AlertWatcherGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[AlertWatcher]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[AlertWatcher]] = None

A list of alert watcher objects.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

AlertWatcherPatch

pydantic model pypureclient.flasharray.AlertWatcherPatch(*, enabled: Optional[StrictBool] = None)
field enabled: Optional[StrictBool] = None

If set to true, email notifications will be sent to this watcher for alerts. If set to false, email notifications are disabled.

Constraints

  • type = boolean

AlertWatcherPost

pydantic model pypureclient.flasharray.AlertWatcherPost(*, enabled: Optional[StrictBool] = None)
field enabled: Optional[StrictBool] = None

If set to true, email notifications will be sent to this watcher for alerts. If set to false, email notifications are disabled. If not specified, defaults to true.

Constraints

  • type = boolean

AlertWatcherResponse

pydantic model pypureclient.flasharray.AlertWatcherResponse(*, items: Optional[ConstrainedListValue[AlertWatcher]] = None)
field items: Optional[ConstrainedListValue[AlertWatcher]] = None

A list of alert watcher objects.

ApiClient

pydantic model pypureclient.flasharray.ApiClient(*, access_policies: Optional[ConstrainedListValue[FixedReferenceWithType]] = None, access_token_ttl_in_ms: Optional[StrictInt] = None, enabled: Optional[StrictBool] = None, id: Optional[StrictStr] = None, issuer: Optional[StrictStr] = None, key_id: Optional[StrictStr] = None, max_role: Optional[StrictStr] = None, name: Optional[StrictStr] = None, public_key: Optional[StrictStr] = None)
field access_policies: Optional[ConstrainedListValue[FixedReferenceWithType]] = None

The access policies allowed for ID Tokens issued by this API client. The bearer of an access token will be authorized to perform actions within the intersection of these policies and those of the array user specified as the JWT sub (subject) claim.

field access_token_ttl_in_ms: Optional[StrictInt] = None

The requested TTL (Time To Live) length of time for the exchanged access token, measured in milliseconds.

field enabled: Optional[StrictBool] = None

If true, the API client is permitted to exchange ID Tokens for access tokens. API clients are disabled by default.

Constraints

  • type = boolean

field id: Optional[StrictStr] = None

The unique identifier for the associated API client. The ID represents the JWT aud (audience) claim in ID Tokens issued for this API client.

field issuer: Optional[StrictStr] = None

The name of the identity provider that will be issuing ID Tokens for this API client. This string represents the JWT iss (issuer) claim in ID Tokens issued for this API client.

field key_id: Optional[StrictStr] = None

The unique identifier for the associated public key of this API client. This string must match the JWT kid (key ID) claim in ID Tokens issued for this API client.

field max_role: Optional[StrictStr] = None

This field has been deprecated. The maximum Admin Access Policy (previously ‘role’) allowed for ID Tokens issued by this API client. The bearer of an access token will be authorized to perform actions within the intersection of this policy and that of the array user specified as the JWT sub (subject) claim. max_role is deprecated in favor of access_policies, but remains for backwards compatibility. If a client has exactly one access policy which corresponds to a valid legacy role of the same name, max_role will be the name of that policy. Otherwise, it will be null.

field name: Optional[StrictStr] = None

The API client name.

field public_key: Optional[StrictStr] = None

The API client’s PEM formatted (Base64 encoded) RSA public key.

ApiClientGetResponse

pydantic model pypureclient.flasharray.ApiClientGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[ApiClient]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[ApiClient]] = None

Returns a list of all items after filtering. The values are displayed for each name, where meaningful.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

ApiClientPatch

pydantic model pypureclient.flasharray.ApiClientPatch(*, enabled: Optional[StrictBool] = None)
field enabled: Optional[StrictBool] = None

Returns a value of true if the API client is permitted to exchange ID tokens for access tokens. API clients are disabled by default.

Constraints

  • type = boolean

ApiClientPost

pydantic model pypureclient.flasharray.ApiClientPost(*, access_policies: Optional[ConstrainedListValue[ReferenceWithType]] = None, access_token_ttl_in_ms: Optional[StrictInt] = None, issuer: Optional[StrictStr] = None, max_role: Optional[StrictStr] = None, public_key: Optional[StrictStr] = None)
field access_policies: Optional[ConstrainedListValue[ReferenceWithType]] = None

The access policies allowed for ID Tokens issued by this API client. The bearer of an access token will be authorized to perform actions within the intersection of these policies and those of the array user specified as the JWT sub (subject) claim.

field access_token_ttl_in_ms: Optional[StrictInt] = None

The TTL (Time To Live) length of time for the exchanged access token. Measured in milliseconds. If not specified, defaults to 86400000.

field issuer: Optional[StrictStr] = None

The name of the identity provider that will be issuing ID Tokens for this API client. The iss claim in the JWT issued must match this string. If not specified, defaults to the API client name.

field max_role: Optional[StrictStr] = None

Deprecated. The maximum Admin Access Policy (previously ‘role’) allowed for ID Tokens issued by this API client. The bearer of an access token will be authorized to perform actions within the intersection of this policy and that of the array user specified as the JWT sub (subject) claim. max_role is deprecated in favor of access_policies, but remains for backwards compatibility. If max_role is the name of a valid legacy role, it will be interpreted as the corresponding access policy of the same name. Otherwise, it’s invalid.

field public_key: Optional[StrictStr] = None

The API client’s PEM formatted (Base64 encoded) RSA public key. Include the —–BEGIN PUBLIC KEY—– and —–END PUBLIC KEY—– lines.

ApiClientResponse

pydantic model pypureclient.flasharray.ApiClientResponse(*, items: Optional[ConstrainedListValue[ApiClient]] = None)
field items: Optional[ConstrainedListValue[ApiClient]] = None

Returns a list of all items after filtering. The values are displayed for each name, where meaningful.

ApiToken

pydantic model pypureclient.flasharray.ApiToken(*, created_at: Optional[StrictInt] = None, expires_at: Optional[StrictInt] = None, token: Optional[StrictStr] = None)

API token

field created_at: Optional[StrictInt] = None

Creation time in milliseconds since the UNIX epoch.

field expires_at: Optional[StrictInt] = None

Expiration time in milliseconds since the UNIX epoch.

field token: Optional[StrictStr] = None

ApiVersionResponse

pydantic model pypureclient.flasharray.ApiVersionResponse(*, version: Optional[ConstrainedListValue[StrictStr]] = None)
field version: Optional[ConstrainedListValue[StrictStr]] = None

A list of supported API versions.

App

pydantic model pypureclient.flasharray.App(*, name: Optional[StrictStr] = None, description: Optional[StrictStr] = None, details: Optional[StrictStr] = None, enabled: Optional[StrictBool] = None, status: Optional[StrictStr] = None, version: Optional[StrictStr] = None, vnc_enabled: Optional[StrictBool] = None)
field description: Optional[StrictStr] = None

A description of the app.

field details: Optional[StrictStr] = None

Details of the status of the app.

field enabled: Optional[StrictBool] = None

If set to true, the app is enabled. By default, apps are disabled.

Constraints

  • type = boolean

field name: Optional[StrictStr] = None

A locally unique, system-generated name. The name cannot be modified.

field status: Optional[StrictStr] = None

The status of the app. Values include healthy and unhealthy. For cluster apps, this represents the aggregate status of the app. The aggregate status is only healthy if all nodes are healthy`&#59; otherwise, it is `unhealthy.

field version: Optional[StrictStr] = None

The app version. For cluster apps, this represents the node version if all nodes are of the same version. If the node versions differ, a value of null is returned.

field vnc_enabled: Optional[StrictBool] = None

If set to true, VNC access is enabled. By default, VNC access is disabled.

Constraints

  • type = boolean

AppGetResponse

pydantic model pypureclient.flasharray.AppGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[App]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[App]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

AppNode

pydantic model pypureclient.flasharray.AppNode(*, app: Optional[FixedReference] = None, index: Optional[StrictInt] = None, status: Optional[StrictStr] = None, version: Optional[StrictStr] = None, vnc: Optional[ConstrainedListValue[StrictStr]] = None)

An individual node of a Purity app. Nodes are indexed starting at 0.

field app: Optional[FixedReference] = None

A reference to the app of which this node is a part.

field index: Optional[StrictInt] = None

An index that represents this node.

field status: Optional[StrictStr] = None

The node status. Possible values are starting, healthy, unhealthy, critical, stopping, and disabled.

field version: Optional[StrictStr] = None

The node version.

field vnc: Optional[ConstrainedListValue[StrictStr]] = None

The VNC information used to access this node if VNC is enabled.

AppNodeGetResponse

pydantic model pypureclient.flasharray.AppNodeGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[AppNode]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[AppNode]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

AppNodeResponse

pydantic model pypureclient.flasharray.AppNodeResponse(*, items: Optional[ConstrainedListValue[AppNode]] = None)
field items: Optional[ConstrainedListValue[AppNode]] = None

AppResponse

pydantic model pypureclient.flasharray.AppResponse(*, items: Optional[ConstrainedListValue[App]] = None)
field items: Optional[ConstrainedListValue[App]] = None

ArrayConnection

pydantic model pypureclient.flasharray.ArrayConnection(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, context: Optional[FixedReference] = None, encryption: Optional[StrictStr] = None, encryption_mode: Optional[StrictStr] = None, management_address: Optional[StrictStr] = None, os: Optional[StrictStr] = None, remote: Optional[ReferenceWithType] = None, replication_addresses: Optional[ConstrainedListValue[StrictStr]] = None, replication_transport: Optional[StrictStr] = None, status: Optional[StrictStr] = None, throttle: Optional[Throttle] = None, type: Optional[StrictStr] = None, version: Optional[StrictStr] = None)
field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field encryption: Optional[StrictStr] = None

If encrypted, all traffic over this array connection will be encrypted. If unencrypted, all traffic over this array connection will be unencrypted.

field encryption_mode: Optional[StrictStr] = None

Cryptographic protocol, trust model, and encryption algorithm information. Will be null if encrypted is false.

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field management_address: Optional[StrictStr] = None

Management IP address or FQDN of the target array.

field name: Optional[StrictStr] = None

A locally unique, system-generated name. The name cannot be modified.

field os: Optional[StrictStr] = None

The operating system of the connected array.

field remote: Optional[ReferenceWithType] = None

The remote array.

field replication_addresses: Optional[ConstrainedListValue[StrictStr]] = None

IP addresses of the target arrays when replication_transport is ip. WWNs of the target arrays when replication_transport is fc.

field replication_transport: Optional[StrictStr] = None

The protocol used to transport data between the local array and the remote array. Valid values are ip and fc. The default value is ip.

field status: Optional[StrictStr] = None

Status of the connection. Valid values include connected, connecting, partially_connected, and unbalanced. A status of connected indicates that arrays are communicating. A status of connecting indicates that the array is trying to establish a connection. A status of partially_connected indicates that some replication addresses are communicating but others are not. A status of unbalanced indicates that the arrays are communicating, but the set of paths is either not redundant or not symmetrical.

field throttle: Optional[Throttle] = None
field type: Optional[StrictStr] = None

The type of connection. Valid values include async-replication, sync-replication, and fleet-management.

field version: Optional[StrictStr] = None

The Purity version on the target array.

ArrayConnectionGetResponse

pydantic model pypureclient.flasharray.ArrayConnectionGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[ArrayConnection]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[ArrayConnection]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

ArrayConnectionKey

pydantic model pypureclient.flasharray.ArrayConnectionKey(*, connection_key: Optional[StrictStr] = None)
field connection_key: Optional[StrictStr] = None

Connection-key used on another array to connect to this array.

ArrayConnectionKeyGetResponse

pydantic model pypureclient.flasharray.ArrayConnectionKeyGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[ArrayConnectionKey]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[ArrayConnectionKey]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

ArrayConnectionPatch

pydantic model pypureclient.flasharray.ArrayConnectionPatch(*, default_limit: Optional[StrictInt] = None, window: Optional[TimeWindow] = None, window_limit: Optional[StrictInt] = None, connection_key: Optional[StrictStr] = None, encryption: Optional[StrictStr] = None, management_address: Optional[StrictStr] = None, replication_addresses: Optional[ConstrainedListValue[StrictStr]] = None, throttle: Optional[Throttle] = None, type: Optional[StrictStr] = None)
field connection_key: Optional[StrictStr] = None

The connection key of the target array. It is only required when encryption is changed from unencrypted to encrypted, or when type is changed from async-replication to sync-replication.

field default_limit: Optional[StrictInt] = None

Deprecated. Default maximum bandwidth threshold for outbound traffic in bytes. Once exceeded, bandwidth throttling occurs.

field encryption: Optional[StrictStr] = None

If encrypted, encryption will be enabled for all traffic over this array connection. connection_key must be specified when encrypted is set to true. If unencrypted, encryption will be disabled for all traffic over this array connection. If not specified, the current encryption option for the array connection will remain unchanged.

field management_address: Optional[StrictStr] = None

Management IP address of the target array.

field replication_addresses: Optional[ConstrainedListValue[StrictStr]] = None

IP addresses and FQDNs of the target arrays. Configurable only when replication_transport is set to ip.

field throttle: Optional[Throttle] = None
field type: Optional[StrictStr] = None

The type of replication. Valid values are async-replication and sync-replication.

field window: Optional[TimeWindow] = None

Deprecated. The time during which the window_limit threshold is in effect.

field window_limit: Optional[StrictInt] = None

Deprecated. Maximum bandwidth threshold for outbound traffic during the specified window_limit time range in bytes. Once exceeded, bandwidth throttling occurs.

ArrayConnectionPath

pydantic model pypureclient.flasharray.ArrayConnectionPath(*, name: Optional[StrictStr] = None, encryption: Optional[StrictStr] = None, encryption_mode: Optional[StrictStr] = None, id: Optional[StrictStr] = None, local_address: Optional[StrictStr] = None, local_port: Optional[StrictStr] = None, remote: Optional[ReferenceWithType] = None, remote_address: Optional[StrictStr] = None, remote_port: Optional[StrictStr] = None, replication_transport: Optional[StrictStr] = None, status: Optional[StrictStr] = None, status_details: Optional[StrictStr] = None, type: Optional[StrictStr] = None)
field encryption: Optional[StrictStr] = None

If encrypted, all traffic over this array connection will be encrypted. If unencrypted, all traffic over this array connection will be unencrypted.

field encryption_mode: Optional[StrictStr] = None

Cryptographic protocol, trust model, and encryption algorithm information. Will be null if encrypted is false.

field id: Optional[StrictStr] = None

A globally unique, system-generated ID of an array connection.

field local_address: Optional[StrictStr] = None

IP address or WWN of the local port.

field local_port: Optional[StrictStr] = None

The local port of the path.

field name: Optional[StrictStr] = None

A locally unique, system-generated name. The name cannot be modified.

field remote: Optional[ReferenceWithType] = None

The remote array.

field remote_address: Optional[StrictStr] = None

IP address or WWN of the remote port.

field remote_port: Optional[StrictStr] = None

The remote port of the path.

field replication_transport: Optional[StrictStr] = None

The protocol used to transport data between the local array and the remote array. Valid values are ip and fc.

field status: Optional[StrictStr] = None

Status of the connection. Valid values are connected, connecting, and quarantined. A status of connected indicates that the arrays are communicating. A status of connecting indicates that the array is trying to establish a connection. A status of quarantined indicates that the path is unstable and has been temporarily embargoed for synchronous replication connections.

field status_details: Optional[StrictStr] = None

Additional information describing any issues encountered when connecting, or null if the status is connected.

field type: Optional[StrictStr] = None

The type of path. Valid values include async-replication, sync-replication, and fleet-management.

ArrayConnectionPathGetResponse

pydantic model pypureclient.flasharray.ArrayConnectionPathGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[ArrayConnectionPath]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[ArrayConnectionPath]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

ArrayConnectionPathResponse

pydantic model pypureclient.flasharray.ArrayConnectionPathResponse(*, items: Optional[ConstrainedListValue[ArrayConnectionPath]] = None)
field items: Optional[ConstrainedListValue[ArrayConnectionPath]] = None

ArrayConnectionPost

pydantic model pypureclient.flasharray.ArrayConnectionPost(*, connection_key: Optional[StrictStr] = None, encryption: Optional[StrictStr] = None, management_address: Optional[StrictStr] = None, replication_addresses: Optional[ConstrainedListValue[StrictStr]] = None, replication_transport: Optional[StrictStr] = None, type: Optional[StrictStr] = None)
field connection_key: Optional[StrictStr] = None

The connection key of the target array.

field encryption: Optional[StrictStr] = None

If encrypted, all traffic over this array connection will be encrypted. If unencrypted, all traffic over this array connection will be unencrypted. Defaults to unencrypted.

field management_address: Optional[StrictStr] = None

Management IP address of the target array.

field replication_addresses: Optional[ConstrainedListValue[StrictStr]] = None

IP addresses and FQDNs of the target arrays. Configurable only when replication_transport is set to ip. If not configured, will be set to all the replication addresses available on the target array at the time of the POST.

field replication_transport: Optional[StrictStr] = None

The protocol used to transport data between the local array and the remote array. Valid values are ip and fc. The default is ip.

field type: Optional[StrictStr] = None

The type of replication. Valid values are async-replication and sync-replication.

ArrayConnectionResponse

pydantic model pypureclient.flasharray.ArrayConnectionResponse(*, items: Optional[ConstrainedListValue[ArrayConnection]] = None)
field items: Optional[ConstrainedListValue[ArrayConnection]] = None

ArrayEncryption

pydantic model pypureclient.flasharray.ArrayEncryption(*, data_at_rest: Optional[ArrayencryptionDataAtRest] = None, module_version: Optional[StrictStr] = None)

If the user does not have sufficient access, all fields will return null.

field data_at_rest: Optional[ArrayencryptionDataAtRest] = None
field module_version: Optional[StrictStr] = None

The version of the Purity encryption module installed on the array. Security certifications are carried out on a per-version basis. On non-encrypt builds, an encryption module may be installed without being enabled. Values include FA-1.0, FA-1.1, FA-1.2, FA-1.3, and so on.

ArrayErasure

pydantic model pypureclient.flasharray.ArrayErasure(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, details: Optional[StrictStr] = None, image_download_progress: Optional[Union[StrictFloat, StrictInt]] = None, image_source: Optional[StrictStr] = None, image_version: Optional[StrictStr] = None, sanitization_certificate: Optional[StrictStr] = None, status: Optional[StrictStr] = None)
field details: Optional[StrictStr] = None

The detailed reason of the status.

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field image_download_progress: Optional[Union[StrictFloat, StrictInt]] = None

The progress of the ISO image download, displayed in decimal format.

field image_source: Optional[StrictStr] = None

Source of the ISO image to download. Valid values include auto and URLs. auto means download the image from Pure1 cloud, and a URL means download the image from the specified URL.

field image_version: Optional[StrictStr] = None

Version of the image to download and install.

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

field sanitization_certificate: Optional[StrictStr] = None

The sanitization certificate of the factory reset, which complies with the standard described in NIST SP800-88R1 section 4.8.

field status: Optional[StrictStr] = None

The status of the factory reset process. Valid values include resetting, reset_failed, reimage_failed, waiting_for_finalize, downloading, downloaded, and download_failed. A status of resetting indicates that the factory reset is running. A status of reset_failed indicates that the factory reset encountered a failure. A status of reimage_failed indicates that the factory reset failed to reimage the array. A status of waiting_for_finalize indicates that the factory reset has finished sanitizing drives, and is waiting to be finalized. A status of downloading indicates that the factory reset is downloading ISO image. A status of downloaded indicates that the factory reset completed ISO image download. A status of download_failed indicates that the factory reset failed to download ISO image.

ArrayErasureGetResponse

pydantic model pypureclient.flasharray.ArrayErasureGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[ArrayErasure]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[ArrayErasure]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

ArrayErasurePatch

pydantic model pypureclient.flasharray.ArrayErasurePatch(*, image_source: Optional[StrictStr] = None, image_version: Optional[StrictStr] = None)
field image_source: Optional[StrictStr] = None

Source of the ISO image to download. Valid values include auto and URLs. auto means download the image from Pure1 cloud, and a URL means download the image from the specified URL. Default value is auto.

field image_version: Optional[StrictStr] = None

Version of the image to download. image_version is optional, and the default value is the current running Purity version. If image_source is auto, the image with the specified version will be downloaded from Pure1 cloud. If image_source is a URL, image_version will be used to compare to the downloaded image version for the purpose of validation.

ArrayErasureResponse

pydantic model pypureclient.flasharray.ArrayErasureResponse(*, items: Optional[ConstrainedListValue[ArrayErasure]] = None)
field items: Optional[ConstrainedListValue[ArrayErasure]] = None

ArrayFactoryResetToken

pydantic model pypureclient.flasharray.ArrayFactoryResetToken(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, token: Optional[StrictInt] = None)
field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

field token: Optional[StrictInt] = None

A random number required as input to perform a factory reset of the array.

ArrayFactoryResetTokenGetResponse

pydantic model pypureclient.flasharray.ArrayFactoryResetTokenGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[ArrayFactoryResetToken]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[ArrayFactoryResetToken]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

ArrayFactoryResetTokenResponse

pydantic model pypureclient.flasharray.ArrayFactoryResetTokenResponse(*, items: Optional[ConstrainedListValue[ArrayFactoryResetToken]] = None)
field items: Optional[ConstrainedListValue[ArrayFactoryResetToken]] = None

ArrayGetResponse

pydantic model pypureclient.flasharray.ArrayGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Arrays]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[Arrays]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

ArrayPerformance

pydantic model pypureclient.flasharray.ArrayPerformance(*, bytes_per_mirrored_write: Optional[ConstrainedIntValue] = None, bytes_per_op: Optional[ConstrainedIntValue] = None, bytes_per_read: Optional[ConstrainedIntValue] = None, bytes_per_write: Optional[ConstrainedIntValue] = None, mirrored_write_bytes_per_sec: Optional[ConstrainedIntValue] = None, mirrored_writes_per_sec: Optional[ConstrainedIntValue] = None, qos_rate_limit_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None, qos_rate_limit_usec_per_read_op: Optional[ConstrainedIntValue] = None, qos_rate_limit_usec_per_write_op: Optional[ConstrainedIntValue] = None, queue_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None, queue_usec_per_read_op: Optional[ConstrainedIntValue] = None, queue_usec_per_write_op: Optional[ConstrainedIntValue] = None, read_bytes_per_sec: Optional[ConstrainedIntValue] = None, reads_per_sec: Optional[ConstrainedIntValue] = None, san_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None, san_usec_per_read_op: Optional[ConstrainedIntValue] = None, san_usec_per_write_op: Optional[ConstrainedIntValue] = None, service_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None, service_usec_per_read_op: Optional[ConstrainedIntValue] = None, service_usec_per_read_op_cache_reduction: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, service_usec_per_write_op: Optional[ConstrainedIntValue] = None, time: Optional[StrictInt] = None, usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None, usec_per_read_op: Optional[ConstrainedIntValue] = None, usec_per_write_op: Optional[ConstrainedIntValue] = None, write_bytes_per_sec: Optional[ConstrainedIntValue] = None, writes_per_sec: Optional[ConstrainedIntValue] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, local_queue_usec_per_op: Optional[ConstrainedIntValue] = None, others_per_sec: Optional[ConstrainedIntValue] = None, queue_depth: Optional[ConstrainedIntValue] = None, usec_per_other_op: Optional[ConstrainedIntValue] = None)
field bytes_per_mirrored_write: Optional[ConstrainedIntValue] = None

The average I/O size per mirrored write, measured in bytes.

Constraints

  • minimum = 0

field bytes_per_op: Optional[ConstrainedIntValue] = None

The average I/O size for both read and write (all) operations.

Constraints

  • minimum = 0

field bytes_per_read: Optional[ConstrainedIntValue] = None

The average I/O size per read, measured in bytes.

Constraints

  • minimum = 0

field bytes_per_write: Optional[ConstrainedIntValue] = None

The average I/O size per write, measured in bytes.

Constraints

  • minimum = 0

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field local_queue_usec_per_op: Optional[ConstrainedIntValue] = None

Deprecated. The number displayed here may not be accurate and in later versions of the product this field will always display null. Instead, use queue_usec_per_mirrored_write_op, queue_usec_per_read_op, and queue_usec_per_write_op fields to measure IO queuing.

Constraints

  • minimum = 0

field mirrored_write_bytes_per_sec: Optional[ConstrainedIntValue] = None

The number of mirrored bytes written per second.

Constraints

  • minimum = 0

field mirrored_writes_per_sec: Optional[ConstrainedIntValue] = None

The number of mirrored writes per second.

Constraints

  • minimum = 0

field name: Optional[StrictStr] = None

A locally unique, system-generated name. The name cannot be modified.

field others_per_sec: Optional[ConstrainedIntValue] = None

The number of other requests processed per second.

Constraints

  • minimum = 0

field qos_rate_limit_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None

The average time it takes the array to process a mirrored I/O write request, measured in microseconds.

Constraints

  • minimum = 0

field qos_rate_limit_usec_per_read_op: Optional[ConstrainedIntValue] = None

The average time spent waiting due to QoS rate limiting for a read request, measured in microseconds.

Constraints

  • minimum = 0

field qos_rate_limit_usec_per_write_op: Optional[ConstrainedIntValue] = None

The average time that a write I/O request spends waiting as a result of the volume reaching its QoS bandwidth limit, measured in microseconds.

Constraints

  • minimum = 0

field queue_depth: Optional[ConstrainedIntValue] = None

Deprecated. The number displayed here may not be accurate and in later versions of the product this field will always display null. Instead, use queue_usec_per_mirrored_write_op, queue_usec_per_read_op, and queue_usec_per_write_op fields to measure IO queuing.

Constraints

  • minimum = 0

field queue_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None

The average time that a mirrored write I/O request spends in the array waiting to be served, measured in microseconds.

Constraints

  • minimum = 0

field queue_usec_per_read_op: Optional[ConstrainedIntValue] = None

The average time that a read I/O request spends in the array waiting to be served, measured in microseconds.

Constraints

  • minimum = 0

field queue_usec_per_write_op: Optional[ConstrainedIntValue] = None

The average time that a write I/O request spends in the array waiting to be served, measured in microseconds.

Constraints

  • minimum = 0

field read_bytes_per_sec: Optional[ConstrainedIntValue] = None

The number of bytes read per second.

Constraints

  • minimum = 0

field reads_per_sec: Optional[ConstrainedIntValue] = None

The number of read requests processed per second.

Constraints

  • minimum = 0

field san_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None

The average time required to transfer data from the initiator to the array for a mirrored write request, measured in microseconds.

Constraints

  • minimum = 0

field san_usec_per_read_op: Optional[ConstrainedIntValue] = None

The average time required to transfer data from the array to the initiator for a read request, measured in microseconds.

Constraints

  • minimum = 0

field san_usec_per_write_op: Optional[ConstrainedIntValue] = None

The average time required to transfer data from the initiator to the array for a write request, measured in microseconds.

Constraints

  • minimum = 0

field service_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None

The average time required for the array to service a mirrored write request, measured in microseconds.

Constraints

  • minimum = 0

field service_usec_per_read_op: Optional[ConstrainedIntValue] = None

The average time required for the array to service a read request, measured in microseconds.

Constraints

  • minimum = 0

field service_usec_per_read_op_cache_reduction: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

The percentage reduction in service_usec_per_read_op due to data cache hits. For example, a value of 0.25 indicates that the value of service_usec_per_read_op is 25&#37; lower than it would have been without any data cache hits.

field service_usec_per_write_op: Optional[ConstrainedIntValue] = None

The average time required for the array to service a write request, measured in microseconds.

Constraints

  • minimum = 0

field time: Optional[StrictInt] = None

The time when the sample performance data was taken, measured in milliseconds since the UNIX epoch.

field usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None

The average time it takes the array to process a mirrored I/O write request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.

Constraints

  • minimum = 0

field usec_per_other_op: Optional[ConstrainedIntValue] = None

The average time it takes the array to process an I/O other request, measured in microseconds.

Constraints

  • minimum = 0

field usec_per_read_op: Optional[ConstrainedIntValue] = None

The average time it takes the array to process an I/O read request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.

Constraints

  • minimum = 0

field usec_per_write_op: Optional[ConstrainedIntValue] = None

The average time it takes the array to process an I/O write request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.

Constraints

  • minimum = 0

field write_bytes_per_sec: Optional[ConstrainedIntValue] = None

The number of bytes written per second.

Constraints

  • minimum = 0

field writes_per_sec: Optional[ConstrainedIntValue] = None

The number of write requests processed per second.

Constraints

  • minimum = 0

ArrayPerformanceByLinkGetResponse

pydantic model pypureclient.flasharray.ArrayPerformanceByLinkGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[ArrayPerformanceByLink]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[ArrayPerformanceByLink]] = None

Array-level front-end I/O performance metrics grouped by link. A link represents a set of arrays that an I/O operation depends on.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

ArrayPerformanceByLinkResponse

pydantic model pypureclient.flasharray.ArrayPerformanceByLinkResponse(*, items: Optional[ConstrainedListValue[ArrayPerformanceByLink]] = None)
field items: Optional[ConstrainedListValue[ArrayPerformanceByLink]] = None

Array-level front-end I/O performance metrics grouped by link. A link represents a set of arrays that an I/O operation depends on.

ArrayPerformanceGetResponse

pydantic model pypureclient.flasharray.ArrayPerformanceGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[ArrayPerformance]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[ArrayPerformance]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

ArrayResponse

pydantic model pypureclient.flasharray.ArrayResponse(*, items: Optional[ConstrainedListValue[Arrays]] = None)
field items: Optional[ConstrainedListValue[Arrays]] = None

ArraySpace

pydantic model pypureclient.flasharray.ArraySpace(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, context: Optional[FixedReference] = None, capacity: Optional[StrictInt] = None, capacity_installed: Optional[StrictInt] = None, parity: Optional[Union[StrictFloat, StrictInt]] = None, space: Optional[Space] = None, time: Optional[StrictInt] = None)
field capacity: Optional[StrictInt] = None

Currently entitled usable capacity.

field capacity_installed: Optional[StrictInt] = None

Usable capacity of the array if entitled to full capacity for all drives.

field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field name: Optional[StrictStr] = None

A locally unique, system-generated name. The name cannot be modified.

field parity: Optional[Union[StrictFloat, StrictInt]] = None

A representation of data redundancy on the array. Data redundancy is rebuilt automatically by the system whenever parity is less than 1.0.

field space: Optional[Space] = None
field time: Optional[StrictInt] = None

ArraySpaceGetResponse

pydantic model pypureclient.flasharray.ArraySpaceGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None, items: Optional[ConstrainedListValue[ArraySpace]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[ArraySpace]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

ArrayencryptionDataAtRest

pydantic model pypureclient.flasharray.ArrayencryptionDataAtRest(*, algorithm: Optional[StrictStr] = None, enabled: Optional[StrictBool] = None)

Data at rest encryption properties.

field algorithm: Optional[StrictStr] = None

The algorithm used to encrypt data on the array. Values include AES-256-CTR and null.

field enabled: Optional[StrictBool] = None

Returns a value of true if data at rest encryption is enabled on the array.

Constraints

  • type = boolean

Arrays

pydantic model pypureclient.flasharray.Arrays(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, context: Optional[FixedReference] = None, _as_of: Optional[StrictInt] = None, banner: Optional[StrictStr] = None, capacity: Optional[StrictInt] = None, console_lock_enabled: Optional[StrictBool] = None, encryption: Optional[ArrayEncryption] = None, eradication_config: Optional[EradicationConfig] = None, idle_timeout: Optional[StrictInt] = None, ntp_servers: Optional[ConstrainedListValue[StrictStr]] = None, ntp_symmetric_key: Optional[StrictStr] = None, os: Optional[StrictStr] = None, parity: Optional[Union[StrictFloat, StrictInt]] = None, scsi_timeout: Optional[StrictInt] = None, space: Optional[Space] = None, time_zone: Optional[StrictStr] = None, version: Optional[StrictStr] = None)
field as_of: Optional[StrictInt] = None (alias '_as_of')

The time in milliseconds since UNIX epoch.

field banner: Optional[StrictStr] = None
field capacity: Optional[StrictInt] = None

The usable capacity in bytes. If the user does not have sufficient access, this field will return null.

field console_lock_enabled: Optional[StrictBool] = None

If true, console lock is enabled for the array. If the user does not have sufficient access, this field will return null.

Constraints

  • type = boolean

field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field encryption: Optional[ArrayEncryption] = None
field eradication_config: Optional[EradicationConfig] = None
field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field idle_timeout: Optional[StrictInt] = None

The idle timeout in milliseconds. Valid values include 0 and any multiple of 60000 in the range of 300000 and 10800000. Any other values are rounded down to the nearest multiple of 60000.

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

field ntp_servers: Optional[ConstrainedListValue[StrictStr]] = None

NTP Servers. If the user does not have sufficient access, this field will return null.

field ntp_symmetric_key: Optional[StrictStr] = None

The text of ntp symmetric authentication key. Supported formats include a hex-encoded string no longer than 64 characters, or an ASCII string no longer than 20 characters, excluding “#”. Any configured key will be masked as “****” on return. If the user does not have sufficient access, this field will return null.

field os: Optional[StrictStr] = None

Specifies the operating system. Valid values are Purity, Purity//FA, and Purity//FB.

field parity: Optional[Union[StrictFloat, StrictInt]] = None

A representation of data redundancy on the array. Data redundancy is rebuilt automatically by the system whenever parity is less than 1.0. If the user does not have sufficient access, this field will return null.

field scsi_timeout: Optional[StrictInt] = None

The SCSI timeout. If not specified, defaults to 60s. If the user does not have sufficient access, this field will return null.

field space: Optional[Space] = None
field time_zone: Optional[StrictStr] = None

The time zone of the array.

field version: Optional[StrictStr] = None

Audit

pydantic model pypureclient.flasharray.Audit(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, context: Optional[FixedReference] = None, arguments: Optional[StrictStr] = None, command: Optional[StrictStr] = None, origin: Optional[FixedReference] = None, subcommand: Optional[StrictStr] = None, time: Optional[StrictInt] = None, user: Optional[StrictStr] = None, user_interface: Optional[StrictStr] = None)
field arguments: Optional[StrictStr] = None

The arguments provided to the command.

field command: Optional[StrictStr] = None

The top level command that starts with the string “pure” as a convention.

field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field name: Optional[StrictStr] = None

A locally unique, system-generated name. The name cannot be modified.

field origin: Optional[FixedReference] = None

The array from which the command originated.

field subcommand: Optional[StrictStr] = None

The command and subcommand combination determines which action the user attempted to perform.

field time: Optional[StrictInt] = None

The time at which the command was run in milliseconds since the UNIX epoch.

field user: Optional[StrictStr] = None

The user who ran the command.

field user_interface: Optional[StrictStr] = None

The user interface through which the user session event was performed. Valid values are CLI, GUI, and REST.

AuditGetResponse

pydantic model pypureclient.flasharray.AuditGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Audit]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[Audit]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

AuditResponse

pydantic model pypureclient.flasharray.AuditResponse(*, items: Optional[ConstrainedListValue[Audit]] = None)
field items: Optional[ConstrainedListValue[Audit]] = None

BasePort

pydantic model pypureclient.flasharray.BasePort(*, name: Optional[StrictStr] = None, iqn: Optional[StrictStr] = None, nqn: Optional[StrictStr] = None, portal: Optional[StrictStr] = None, wwn: Optional[StrictStr] = None, failover: Optional[StrictStr] = None)
field failover: Optional[StrictStr] = None

If the array port has failed over, returns the name of the port to which this port has failed over.

field iqn: Optional[StrictStr] = None

The iSCSI Qualified Name (or null if target is not iSCSI).

field name: Optional[StrictStr] = None

A locally unique, system-generated name. The name cannot be modified.

field nqn: Optional[StrictStr] = None

NVMe Qualified Name (or null if target is not NVMeoF).

field portal: Optional[StrictStr] = None

IP and port number (or null if target is not iSCSI).

field wwn: Optional[StrictStr] = None

Fibre Channel World Wide Name (or null if target is not Fibre Channel).

BuiltIn

pydantic model pypureclient.flasharray.BuiltIn(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None)

A built-in resource. Many are singletons predefined by Purity (e.g., support settings). Some correspond to a piece of software, like an app, or hardware, like a controller. Others are created by the system in response to some event (e.g., alerts, audit records). Typically, a user can’t create, delete or rename a built-in resource. A few can be created or deleted, but not renamed because the names are meaningful to Purity (e.g., VIFs).

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field name: Optional[StrictStr] = None

A locally unique, system-generated name. The name cannot be modified.

BuiltInRelationship

pydantic model pypureclient.flasharray.BuiltInRelationship(*, id: Optional[StrictStr] = None)
field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

BuiltInResourceNoId

pydantic model pypureclient.flasharray.BuiltInResourceNoId(*, name: Optional[StrictStr] = None)

A built-in resource. Many are singletons predefined by Purity (e.g., support settings). Some correspond to a piece of software, like an app, or hardware, like a controller. Others are created by the system in response to some event (e.g., alerts, audit records). Typically, a user can’t create, delete or rename a built-in resource. A few can be created or deleted, but not renamed because the names are meaningful to Purity (e.g., VIFs, file systems, file system snapshots, volume snapshot).

field name: Optional[StrictStr] = None

A locally unique, system-generated name. The name cannot be modified.

Certificate

pydantic model pypureclient.flasharray.Certificate(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, certificate: Optional[StrictStr] = None, certificate_type: Optional[StrictStr] = None, common_name: Optional[StrictStr] = None, country: Optional[StrictStr] = None, email: Optional[StrictStr] = None, intermediate_certificate: Optional[StrictStr] = None, issued_by: Optional[StrictStr] = None, issued_to: Optional[StrictStr] = None, key_algorithm: Optional[StrictStr] = None, key_size: Optional[StrictInt] = None, locality: Optional[StrictStr] = None, organization: Optional[StrictStr] = None, organizational_unit: Optional[StrictStr] = None, state: Optional[StrictStr] = None, status: Optional[StrictStr] = None, subject_alternative_names: Optional[ConstrainedListValue[StrictStr]] = None, valid_from: Optional[StrictInt] = None, valid_to: Optional[StrictInt] = None)
field certificate: Optional[StrictStr] = None

The text of the certificate.

field certificate_type: Optional[StrictStr] = None

The type of certificate. Values include appliance and external. Certificates of type appliance are used by the array to verify its identity to clients. Certificates of type external are used by the array to identify external servers to which it is configured to communicate.

field common_name: Optional[StrictStr] = None

The common name field listed in the certificate.

field country: Optional[StrictStr] = None

Two-letter country (ISO) code listed in the certificate.

field email: Optional[StrictStr] = None

The email field listed in the certificate.

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field intermediate_certificate: Optional[StrictStr] = None

The text of the intermediate certificate chains.

field issued_by: Optional[StrictStr] = None

The party that issued the certificate.

field issued_to: Optional[StrictStr] = None

The party to whom the certificate is issued.

field key_algorithm: Optional[StrictStr] = None

The key algorithm used to generate the certificate. This field can only be specified when creating a new self-signed certificate. Defaults to rsa if not specified. Valid values when creating a new self-signed certificate only include rsa, ec, ed448 and ed25519.

field key_size: Optional[StrictInt] = None

The size (in bits) of the private key for the certificate. Default is 2048 bits for rsa key_algorithm, 256 for ec and ed25519. The ed448 default key size is 456. This field can only be specified when creating a new self-signed certificate.

field locality: Optional[StrictStr] = None

The locality field listed in the certificate.

field name: Optional[StrictStr] = None

A locally unique, system-generated name. The name cannot be modified.

field organization: Optional[StrictStr] = None

The organization field listed in the certificate.

field organizational_unit: Optional[StrictStr] = None

The organizational unit field listed in the certificate.

field state: Optional[StrictStr] = None

The state/province field listed in the certificate.

field status: Optional[StrictStr] = None

The type of certificate. Valid values are self-signed and imported.

field subject_alternative_names: Optional[ConstrainedListValue[StrictStr]] = None

The alternative names that are secured by this certificate. Alternative names may be IP addresses, DNS names, or URIs.

field valid_from: Optional[StrictInt] = None

The date when the certificate starts being valid.

field valid_to: Optional[StrictInt] = None

The date when the certificate stops being valid.

CertificateBase

pydantic model pypureclient.flasharray.CertificateBase(*, certificate: Optional[StrictStr] = None, certificate_type: Optional[StrictStr] = None, common_name: Optional[StrictStr] = None, country: Optional[StrictStr] = None, email: Optional[StrictStr] = None, intermediate_certificate: Optional[StrictStr] = None, issued_by: Optional[StrictStr] = None, issued_to: Optional[StrictStr] = None, key_algorithm: Optional[StrictStr] = None, key_size: Optional[StrictInt] = None, locality: Optional[StrictStr] = None, organization: Optional[StrictStr] = None, organizational_unit: Optional[StrictStr] = None, state: Optional[StrictStr] = None, status: Optional[StrictStr] = None, subject_alternative_names: Optional[ConstrainedListValue[StrictStr]] = None, valid_from: Optional[StrictInt] = None, valid_to: Optional[StrictInt] = None)

SSL certificate managed by Purity.

field certificate: Optional[StrictStr] = None

The text of the certificate.

field certificate_type: Optional[StrictStr] = None

The type of certificate. Values include appliance and external. Certificates of type appliance are used by the array to verify its identity to clients. Certificates of type external are used by the array to identify external servers to which it is configured to communicate.

field common_name: Optional[StrictStr] = None

The common name field listed in the certificate.

field country: Optional[StrictStr] = None

Two-letter country (ISO) code listed in the certificate.

field email: Optional[StrictStr] = None

The email field listed in the certificate.

field intermediate_certificate: Optional[StrictStr] = None

The text of the intermediate certificate chains.

field issued_by: Optional[StrictStr] = None

The party that issued the certificate.

field issued_to: Optional[StrictStr] = None

The party to whom the certificate is issued.

field key_algorithm: Optional[StrictStr] = None

The key algorithm used to generate the certificate. This field can only be specified when creating a new self-signed certificate. Defaults to rsa if not specified. Valid values when creating a new self-signed certificate only include rsa, ec, ed448 and ed25519.

field key_size: Optional[StrictInt] = None

The size (in bits) of the private key for the certificate. Default is 2048 bits for rsa key_algorithm, 256 for ec and ed25519. The ed448 default key size is 456. This field can only be specified when creating a new self-signed certificate.

field locality: Optional[StrictStr] = None

The locality field listed in the certificate.

field organization: Optional[StrictStr] = None

The organization field listed in the certificate.

field organizational_unit: Optional[StrictStr] = None

The organizational unit field listed in the certificate.

field state: Optional[StrictStr] = None

The state/province field listed in the certificate.

field status: Optional[StrictStr] = None

The type of certificate. Valid values are self-signed and imported.

field subject_alternative_names: Optional[ConstrainedListValue[StrictStr]] = None

The alternative names that are secured by this certificate. Alternative names may be IP addresses, DNS names, or URIs.

field valid_from: Optional[StrictInt] = None

The date when the certificate starts being valid.

field valid_to: Optional[StrictInt] = None

The date when the certificate stops being valid.

CertificateCertificateGroupGetResponse

pydantic model pypureclient.flasharray.CertificateCertificateGroupGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[MemberWithType]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[MemberWithType]] = None

A list of certificate and certificate group relationships.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

CertificateCertificateGroupResponse

pydantic model pypureclient.flasharray.CertificateCertificateGroupResponse(*, items: Optional[ConstrainedListValue[MemberWithType]] = None)
field items: Optional[ConstrainedListValue[MemberWithType]] = None

A list of certificate and certificate group relationships.

CertificateGetResponse

pydantic model pypureclient.flasharray.CertificateGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Certificate]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[Certificate]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

CertificateGroup

pydantic model pypureclient.flasharray.CertificateGroup(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None)
field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field name: Optional[StrictStr] = None

A locally unique, system-generated name. The name cannot be modified.

CertificateGroupCertificateGetResponse

pydantic model pypureclient.flasharray.CertificateGroupCertificateGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[MemberWithType]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[MemberWithType]] = None

A list of certificate and certificate group relationships.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

CertificateGroupCertificateResponse

pydantic model pypureclient.flasharray.CertificateGroupCertificateResponse(*, items: Optional[ConstrainedListValue[MemberWithType]] = None)
field items: Optional[ConstrainedListValue[MemberWithType]] = None

A list of certificate and certificate group relationships.

CertificateGroupGetResponse

pydantic model pypureclient.flasharray.CertificateGroupGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[CertificateGroup]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[CertificateGroup]] = None

A list of certificate group objects.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

CertificateGroupResponse

pydantic model pypureclient.flasharray.CertificateGroupResponse(*, items: Optional[ConstrainedListValue[CertificateGroup]] = None)
field items: Optional[ConstrainedListValue[CertificateGroup]] = None

A list of certificate group objects.

CertificateGroupUse

pydantic model pypureclient.flasharray.CertificateGroupUse(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, use: Optional[FixedReferenceWithType] = None)
field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field name: Optional[StrictStr] = None

A locally unique, system-generated name. The name cannot be modified.

field use: Optional[FixedReferenceWithType] = None

A reference to an object using this certificate group.

CertificateGroupUseGetResponse

pydantic model pypureclient.flasharray.CertificateGroupUseGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[CertificateGroupUse]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[CertificateGroupUse]] = None

A list of certificate group use objects.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

CertificatePost

pydantic model pypureclient.flasharray.CertificatePost(*, certificate: Optional[StrictStr] = None, certificate_type: Optional[StrictStr] = None, common_name: Optional[StrictStr] = None, country: Optional[StrictStr] = None, email: Optional[StrictStr] = None, intermediate_certificate: Optional[StrictStr] = None, issued_by: Optional[StrictStr] = None, issued_to: Optional[StrictStr] = None, key_algorithm: Optional[StrictStr] = None, key_size: Optional[StrictInt] = None, locality: Optional[StrictStr] = None, organization: Optional[StrictStr] = None, organizational_unit: Optional[StrictStr] = None, state: Optional[StrictStr] = None, status: Optional[StrictStr] = None, subject_alternative_names: Optional[ConstrainedListValue[StrictStr]] = None, valid_from: Optional[StrictInt] = None, valid_to: Optional[StrictInt] = None, days: Optional[StrictInt] = None, key: Optional[StrictStr] = None, passphrase: Optional[StrictStr] = None)
field certificate: Optional[StrictStr] = None

The text of the certificate.

field certificate_type: Optional[StrictStr] = None

The type of certificate. Values include appliance and external. Certificates of type appliance are used by the array to verify its identity to clients. Certificates of type external are used by the array to identify external servers to which it is configured to communicate.

field common_name: Optional[StrictStr] = None

The common name field listed in the certificate.

field country: Optional[StrictStr] = None

Two-letter country (ISO) code listed in the certificate.

field days: Optional[StrictInt] = None

The number of days that the self-signed certificate is valid. Defaults to 3650. This field can only be specified when creating a new self-signed certificate.

field email: Optional[StrictStr] = None

The email field listed in the certificate.

field intermediate_certificate: Optional[StrictStr] = None

The text of the intermediate certificate chains.

field issued_by: Optional[StrictStr] = None

The party that issued the certificate.

field issued_to: Optional[StrictStr] = None

The party to whom the certificate is issued.

field key: Optional[StrictStr] = None

The text of the private key. This field can only be specified when importing a certificate and key pair.

field key_algorithm: Optional[StrictStr] = None

The key algorithm used to generate the certificate. This field can only be specified when creating a new self-signed certificate. Defaults to rsa if not specified. Valid values when creating a new self-signed certificate only include rsa, ec, ed448 and ed25519.

field key_size: Optional[StrictInt] = None

The size (in bits) of the private key for the certificate. Default is 2048 bits for rsa key_algorithm, 256 for ec and ed25519. The ed448 default key size is 456. This field can only be specified when creating a new self-signed certificate.

field locality: Optional[StrictStr] = None

The locality field listed in the certificate.

field organization: Optional[StrictStr] = None

The organization field listed in the certificate.

field organizational_unit: Optional[StrictStr] = None

The organizational unit field listed in the certificate.

field passphrase: Optional[StrictStr] = None

The passphrase used to encrypt key. This field can only be specified when importing a certificate and key pair.

field state: Optional[StrictStr] = None

The state/province field listed in the certificate.

field status: Optional[StrictStr] = None

The type of certificate. Valid values are self-signed and imported.

field subject_alternative_names: Optional[ConstrainedListValue[StrictStr]] = None

The alternative names that are secured by this certificate. Alternative names may be IP addresses, DNS names, or URIs.

field valid_from: Optional[StrictInt] = None

The date when the certificate starts being valid.

field valid_to: Optional[StrictInt] = None

The date when the certificate stops being valid.

CertificateResponse

pydantic model pypureclient.flasharray.CertificateResponse(*, items: Optional[ConstrainedListValue[Certificate]] = None)
field items: Optional[ConstrainedListValue[Certificate]] = None

CertificateSigningRequest

pydantic model pypureclient.flasharray.CertificateSigningRequest(*, certificate_signing_request: Optional[StrictStr] = None)

SSL certificate managed by Purity//FA.

field certificate_signing_request: Optional[StrictStr] = None

The text of a new certificate signing request.

CertificateSigningRequestPost

pydantic model pypureclient.flasharray.CertificateSigningRequestPost(*, certificate: Optional[ReferenceNoId] = None, common_name: Optional[StrictStr] = None, country: Optional[StrictStr] = None, email: Optional[StrictStr] = None, locality: Optional[StrictStr] = None, organization: Optional[StrictStr] = None, organizational_unit: Optional[StrictStr] = None, state: Optional[StrictStr] = None, subject_alternative_names: Optional[ConstrainedListValue[StrictStr]] = None)

SSL Certificate managed by Purity//FA.

field certificate: Optional[ReferenceNoId] = None
field common_name: Optional[StrictStr] = None

The common name field listed in the certificate.

field country: Optional[StrictStr] = None

Two-letter country (ISO) code listed in the certificate.

field email: Optional[StrictStr] = None

The email field listed in the certificate.

field locality: Optional[StrictStr] = None

The locality field listed in the certificate.

field organization: Optional[StrictStr] = None

The organization field listed in the certificate.

field organizational_unit: Optional[StrictStr] = None

The organizational unit field listed in the certificate.

field state: Optional[StrictStr] = None

The state/province field listed in the certificate.

field subject_alternative_names: Optional[ConstrainedListValue[StrictStr]] = None

The alternative names that are secured by this certificate. Alternative names include IP addresses, DNS names, or URIs.

CertificateSigningRequestResponse

pydantic model pypureclient.flasharray.CertificateSigningRequestResponse(*, items: Optional[ConstrainedListValue[CertificateSigningRequest]] = None)
field items: Optional[ConstrainedListValue[CertificateSigningRequest]] = None

CertificateUse

pydantic model pypureclient.flasharray.CertificateUse(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, group: Optional[FixedReferenceWithType] = None, use: Optional[FixedReferenceWithType] = None)
field group: Optional[FixedReferenceWithType] = None

A reference to the certificate group that is being used, if any, where this certificate is a member of the certificate-group. Returns null if the referenced user object is not associated with a group and is directly using this certificate.

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field name: Optional[StrictStr] = None

A locally unique, system-generated name. The name cannot be modified.

field use: Optional[FixedReferenceWithType] = None

A reference to an object using this certificate.

CertificateUseGetResponse

pydantic model pypureclient.flasharray.CertificateUseGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[CertificateUse]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[CertificateUse]] = None

A list of certificate use objects.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

Chap

pydantic model pypureclient.flasharray.Chap(*, host_password: Optional[StrictStr] = None, host_user: Optional[StrictStr] = None, target_password: Optional[StrictStr] = None, target_user: Optional[StrictStr] = None)

Challenge-Handshake Authentication Protocol (CHAP).

field host_password: Optional[StrictStr] = None

The host password for CHAP authentication. The password must be between 12 and 255 characters (inclusive) and cannot be the same as the target password.

field host_user: Optional[StrictStr] = None

The host username for CHAP authentication.

field target_password: Optional[StrictStr] = None

The target password for CHAP authentication. The password must be between 12 and 255 characters (inclusive) and cannot be the same as the host password.

field target_user: Optional[StrictStr] = None

The target username for CHAP authentication.

CloudCapacityGetResponse

pydantic model pypureclient.flasharray.CloudCapacityGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[CloudCapacityStatus]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[CloudCapacityStatus]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

CloudCapacityPatchResponse

pydantic model pypureclient.flasharray.CloudCapacityPatchResponse(*, items: Optional[ConstrainedListValue[CloudCapacityStatus]] = None)
field items: Optional[ConstrainedListValue[CloudCapacityStatus]] = None

CloudCapacityStatus

pydantic model pypureclient.flasharray.CloudCapacityStatus(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, current_capacity: Optional[StrictInt] = None, details: Optional[StrictStr] = None, requested_capacity: Optional[StrictInt] = None, status: Optional[StrictStr] = None)
field current_capacity: Optional[StrictInt] = None

The current raw capacity of the CBS array in bytes.

field details: Optional[StrictStr] = None

Details about the capacity update. This field can contain error details when status is failed or progress information when status is expanding. For status idle the value is null.

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field name: Optional[StrictStr] = None

A locally unique, system-generated name. The name cannot be modified.

field requested_capacity: Optional[StrictInt] = None

The requested raw capacity of the CBS array in bytes. When the capacity update process finishes, it should be the same as current_capacity.

field status: Optional[StrictStr] = None

The status of the capacity update process. Can be one of idle, failed, expanding.

CloudCapacityStep

pydantic model pypureclient.flasharray.CloudCapacityStep(*, supported_capacity: Optional[StrictInt] = None)
field supported_capacity: Optional[StrictInt] = None

A possible supported raw capacity of the CBS array in bytes.

CloudCapacityStepsGetResponse

pydantic model pypureclient.flasharray.CloudCapacityStepsGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[CloudCapacityStep]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[CloudCapacityStep]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

CloudConfig

pydantic model pypureclient.flasharray.CloudConfig(*, id: Optional[StrictStr] = None, model: Optional[CloudConfigModel] = None, name: Optional[StrictStr] = None)
field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field model: Optional[CloudConfigModel] = None

The model configuration of the CBS array.

field name: Optional[StrictStr] = None

A locally unique, system-generated name. The name cannot be modified.

CloudConfigGetResponse

pydantic model pypureclient.flasharray.CloudConfigGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[CloudConfig]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[CloudConfig]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

CloudConfigModel

pydantic model pypureclient.flasharray.CloudConfigModel(*, current: Optional[StrictStr] = None, details: Optional[StrictStr] = None, override_checks: Optional[ConstrainedListValue[StrictStr]] = None, requested: Optional[StrictStr] = None, status: Optional[StrictStr] = None, step: Optional[StrictStr] = None)
field current: Optional[StrictStr] = None

The current model of the CBS array.

field details: Optional[StrictStr] = None

Details about the hardware upgrade. This field can contain error details or progress information when the status is upgrading. The default value is an empty string.

field override_checks: Optional[ConstrainedListValue[StrictStr]] = None

A list of upgrade checks to be overridden.

field requested: Optional[StrictStr] = None

A requested model of the CBS array.

field status: Optional[StrictStr] = None

The status of the hardware upgrade process. Can be one of idle, paused, upgrading.

field step: Optional[StrictStr] = None

The current step of the hardware upgrade process. Can be pre-upgrade-check, upgrade-ct0, failover and so on. The default value is an empty string.

CloudConfigModelPatch

pydantic model pypureclient.flasharray.CloudConfigModelPatch(*, add_override_checks: Optional[ConstrainedListValue[StrictStr]] = None, requested: Optional[StrictStr] = None)
field add_override_checks: Optional[ConstrainedListValue[StrictStr]] = None

A list of upgrade checks to be overridden.

field requested: Optional[StrictStr] = None

A supported model for the CBS array.

CloudConfigPatch

pydantic model pypureclient.flasharray.CloudConfigPatch(*, model: Optional[CloudConfigModelPatch] = None)
field model: Optional[CloudConfigModelPatch] = None

The requested model configuration of the CBS array.

CloudConfigPatchResponse

pydantic model pypureclient.flasharray.CloudConfigPatchResponse(*, items: Optional[ConstrainedListValue[CloudConfig]] = None)
field items: Optional[ConstrainedListValue[CloudConfig]] = None

CloudConfigSupported

pydantic model pypureclient.flasharray.CloudConfigSupported(*, supported_models: Optional[ConstrainedListValue[StrictStr]] = None)
field supported_models: Optional[ConstrainedListValue[StrictStr]] = None

List of supported models for an upgrade.

CloudConfigSupportedConfigsGetResponse

pydantic model pypureclient.flasharray.CloudConfigSupportedConfigsGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[CloudConfigSupported]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[CloudConfigSupported]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

CloudProviderTag

pydantic model pypureclient.flasharray.CloudProviderTag(*, details: Optional[StrictStr] = None, key: Optional[StrictStr] = None, value: Optional[StrictStr] = None)
field details: Optional[StrictStr] = None

Details about the status of the tag if not healthy.

field key: Optional[StrictStr] = None

Key of the tag. Supports UTF-8 Unicode characters. Please refer to the offical document from cloud providers for limitations.

field value: Optional[StrictStr] = None

Value of the tag. Supports UTF-8 Unicode characters. Please refer to the offical document from cloud providers for limitations.

CloudProviderTagGetResponse

pydantic model pypureclient.flasharray.CloudProviderTagGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[CloudProviderTag]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[CloudProviderTag]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

CloudProviderTagResponse

pydantic model pypureclient.flasharray.CloudProviderTagResponse(*, items: Optional[ConstrainedListValue[CloudProviderTag]] = None)
field items: Optional[ConstrainedListValue[CloudProviderTag]] = None

Connection

pydantic model pypureclient.flasharray.Connection(*, context: Optional[FixedReference] = None, host: Optional[ReferenceNoId] = None, host_group: Optional[ReferenceNoId] = None, lun: Optional[StrictInt] = None, nsid: Optional[StrictInt] = None, protocol_endpoint: Optional[Reference] = None, volume: Optional[FixedReference] = None)
field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field host: Optional[ReferenceNoId] = None

The host computer that sends and receives I/O requests to and from volumes on the FlashArray array.

field host_group: Optional[ReferenceNoId] = None

A virtual collection of hosts with common connectivity to volumes.

field lun: Optional[StrictInt] = None

The logical unit number (LUN) by which the specified hosts are to address the specified volume. A LUN is set for SCSI connections only. A LUN can be in one of two formats: a simple LUN, or a LUN and Sublun with virtual volumes. The first format is simply the LUN. The second format is a single int64 combining both ((LUN << 32) + Sublun) or (LUN * 4294967296 + Sublun). In the FA UI, a combined LUN and Sublun is represented as LUN:Sublun. The maximum int64 LUN:Sublun value is 17587891081215.

field nsid: Optional[StrictInt] = None

Namespace identifier allocated for the NVMe namespace backing the volume. NSID is set for NVMe connections only.

field protocol_endpoint: Optional[Reference] = None

A protocol endpoint (also known as a conglomerate volume) which acts as a proxy through which virtual volumes are created and then connected to VMware ESXi hosts or host groups. The protocol endpoint itself does not serve I/Os; instead, its job is to form connections between FlashArray volumes and ESXi hosts and host groups.

field volume: Optional[FixedReference] = None

A container that manages the storage space on the array.

ConnectionGetResponse

pydantic model pypureclient.flasharray.ConnectionGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Connection]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[Connection]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

ConnectionPost

pydantic model pypureclient.flasharray.ConnectionPost(*, lun: Optional[ConstrainedIntValue] = None, protocol_endpoint: Optional[Reference] = None)
field lun: Optional[ConstrainedIntValue] = None

The logical unit number (LUN) by which the specified hosts are to address the specified volume. If the LUN is not specified, the system automatically assigns a LUN to the connection. To automatically assign a LUN to a private connection, the system starts at LUN 1 and counts up to the maximum LUN 4095, assigning the first available LUN to the connection. For shared connections, the system starts at LUN 254 and counts down to the minimum LUN 1, assigning the first available LUN to the connection. If all LUNs in the [1…254] range are taken, the system starts at LUN 255 and counts up to the maximum LUN 4095, assigning the first available LUN to the connection. Should not be used together with an NVMe host or host group.

Constraints

  • minimum = 1

  • maximum = 4095

field protocol_endpoint: Optional[Reference] = None

A protocol endpoint (also known as a conglomerate volume) which acts as a proxy through which virtual volumes are created and then connected to VMware ESXi hosts or host groups. The protocol endpoint itself does not serve I/Os; instead, its job is to form connections between FlashArray volumes and ESXi hosts and host groups.

ConnectionResponse

pydantic model pypureclient.flasharray.ConnectionResponse(*, items: Optional[ConstrainedListValue[Connection]] = None)
field items: Optional[ConstrainedListValue[Connection]] = None

ContainerDefaultProtection

pydantic model pypureclient.flasharray.ContainerDefaultProtection(*, context: Optional[FixedReference] = None, default_protections: Optional[ConstrainedListValue[DefaultProtectionReference]] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, type: Optional[StrictStr] = None)
field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field default_protections: Optional[ConstrainedListValue[DefaultProtectionReference]] = None

The default protection that is applied to newly created volumes. Volumes can opt out of the default protection at creation. The pod’s default_protections defaults to the array’s default_protections at pod creation. To clear the list of default protections, set to an empty list [].

field id: Optional[StrictStr] = None

The id of an administrative domain, a data container, and a namespace for volumes and protection groups. Values can be pod id or null. Null represents the local array id.

field name: Optional[StrictStr] = None

The name of an administrative domain, a data container, and a namespace for volumes and protection groups. Values can be pod name or null. null represents the local array name.

field type: Optional[StrictStr] = None

The type of an administrative domain, a data container, and a namespace for volumes and protection groups. Values can be pod or null. null represents the local array type.

ContainerDefaultProtectionGetResponse

pydantic model pypureclient.flasharray.ContainerDefaultProtectionGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[ContainerDefaultProtection]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[ContainerDefaultProtection]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

ContainerDefaultProtectionResponse

pydantic model pypureclient.flasharray.ContainerDefaultProtectionResponse(*, items: Optional[ConstrainedListValue[ContainerDefaultProtection]] = None)
field items: Optional[ConstrainedListValue[ContainerDefaultProtection]] = None

ContainerEradicationConfig

pydantic model pypureclient.flasharray.ContainerEradicationConfig(*, manual_eradication: Optional[StrictStr] = None)

The status of the eradication functionality

field manual_eradication: Optional[StrictStr] = None

The manual eradication status of the container. If all-enabled, the container and its contents can be eradicated. If partially-disabled, the container cannot be eradicated because the container contains some non-empty protection groups that are retention-locked. If all-disabled, the container and its contents cannot be eradicated. Values include all-disabled, all-enabled, and partially-disabled.

ContainerPerformance

pydantic model pypureclient.flasharray.ContainerPerformance(*, bytes_per_mirrored_write: Optional[ConstrainedIntValue] = None, bytes_per_op: Optional[ConstrainedIntValue] = None, bytes_per_read: Optional[ConstrainedIntValue] = None, bytes_per_write: Optional[ConstrainedIntValue] = None, mirrored_write_bytes_per_sec: Optional[ConstrainedIntValue] = None, mirrored_writes_per_sec: Optional[ConstrainedIntValue] = None, qos_rate_limit_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None, qos_rate_limit_usec_per_read_op: Optional[ConstrainedIntValue] = None, qos_rate_limit_usec_per_write_op: Optional[ConstrainedIntValue] = None, queue_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None, queue_usec_per_read_op: Optional[ConstrainedIntValue] = None, queue_usec_per_write_op: Optional[ConstrainedIntValue] = None, read_bytes_per_sec: Optional[ConstrainedIntValue] = None, reads_per_sec: Optional[ConstrainedIntValue] = None, san_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None, san_usec_per_read_op: Optional[ConstrainedIntValue] = None, san_usec_per_write_op: Optional[ConstrainedIntValue] = None, service_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None, service_usec_per_read_op: Optional[ConstrainedIntValue] = None, service_usec_per_read_op_cache_reduction: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, service_usec_per_write_op: Optional[ConstrainedIntValue] = None, time: Optional[StrictInt] = None, usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None, usec_per_read_op: Optional[ConstrainedIntValue] = None, usec_per_write_op: Optional[ConstrainedIntValue] = None, write_bytes_per_sec: Optional[ConstrainedIntValue] = None, writes_per_sec: Optional[ConstrainedIntValue] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, context: Optional[FixedReference] = None, others_per_sec: Optional[ConstrainedIntValue] = None, usec_per_other_op: Optional[ConstrainedIntValue] = None)
field bytes_per_mirrored_write: Optional[ConstrainedIntValue] = None

The average I/O size per mirrored write, measured in bytes.

Constraints

  • minimum = 0

field bytes_per_op: Optional[ConstrainedIntValue] = None

The average I/O size for both read and write (all) operations.

Constraints

  • minimum = 0

field bytes_per_read: Optional[ConstrainedIntValue] = None

The average I/O size per read, measured in bytes.

Constraints

  • minimum = 0

field bytes_per_write: Optional[ConstrainedIntValue] = None

The average I/O size per write, measured in bytes.

Constraints

  • minimum = 0

field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field mirrored_write_bytes_per_sec: Optional[ConstrainedIntValue] = None

The number of mirrored bytes written per second.

Constraints

  • minimum = 0

field mirrored_writes_per_sec: Optional[ConstrainedIntValue] = None

The number of mirrored writes per second.

Constraints

  • minimum = 0

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

field others_per_sec: Optional[ConstrainedIntValue] = None

The number of other requests processed per second.

Constraints

  • minimum = 0

field qos_rate_limit_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None

The average time it takes the array to process a mirrored I/O write request, measured in microseconds.

Constraints

  • minimum = 0

field qos_rate_limit_usec_per_read_op: Optional[ConstrainedIntValue] = None

The average time spent waiting due to QoS rate limiting for a read request, measured in microseconds.

Constraints

  • minimum = 0

field qos_rate_limit_usec_per_write_op: Optional[ConstrainedIntValue] = None

The average time that a write I/O request spends waiting as a result of the volume reaching its QoS bandwidth limit, measured in microseconds.

Constraints

  • minimum = 0

field queue_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None

The average time that a mirrored write I/O request spends in the array waiting to be served, measured in microseconds.

Constraints

  • minimum = 0

field queue_usec_per_read_op: Optional[ConstrainedIntValue] = None

The average time that a read I/O request spends in the array waiting to be served, measured in microseconds.

Constraints

  • minimum = 0

field queue_usec_per_write_op: Optional[ConstrainedIntValue] = None

The average time that a write I/O request spends in the array waiting to be served, measured in microseconds.

Constraints

  • minimum = 0

field read_bytes_per_sec: Optional[ConstrainedIntValue] = None

The number of bytes read per second.

Constraints

  • minimum = 0

field reads_per_sec: Optional[ConstrainedIntValue] = None

The number of read requests processed per second.

Constraints

  • minimum = 0

field san_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None

The average time required to transfer data from the initiator to the array for a mirrored write request, measured in microseconds.

Constraints

  • minimum = 0

field san_usec_per_read_op: Optional[ConstrainedIntValue] = None

The average time required to transfer data from the array to the initiator for a read request, measured in microseconds.

Constraints

  • minimum = 0

field san_usec_per_write_op: Optional[ConstrainedIntValue] = None

The average time required to transfer data from the initiator to the array for a write request, measured in microseconds.

Constraints

  • minimum = 0

field service_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None

The average time required for the array to service a mirrored write request, measured in microseconds.

Constraints

  • minimum = 0

field service_usec_per_read_op: Optional[ConstrainedIntValue] = None

The average time required for the array to service a read request, measured in microseconds.

Constraints

  • minimum = 0

field service_usec_per_read_op_cache_reduction: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

The percentage reduction in service_usec_per_read_op due to data cache hits. For example, a value of 0.25 indicates that the value of service_usec_per_read_op is 25&#37; lower than it would have been without any data cache hits.

field service_usec_per_write_op: Optional[ConstrainedIntValue] = None

The average time required for the array to service a write request, measured in microseconds.

Constraints

  • minimum = 0

field time: Optional[StrictInt] = None

The time when the sample performance data was taken, measured in milliseconds since the UNIX epoch.

field usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None

The average time it takes the array to process a mirrored I/O write request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.

Constraints

  • minimum = 0

field usec_per_other_op: Optional[ConstrainedIntValue] = None

The average time it takes the pod to process an I/O other request, measured in microseconds.

Constraints

  • minimum = 0

field usec_per_read_op: Optional[ConstrainedIntValue] = None

The average time it takes the array to process an I/O read request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.

Constraints

  • minimum = 0

field usec_per_write_op: Optional[ConstrainedIntValue] = None

The average time it takes the array to process an I/O write request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.

Constraints

  • minimum = 0

field write_bytes_per_sec: Optional[ConstrainedIntValue] = None

The number of bytes written per second.

Constraints

  • minimum = 0

field writes_per_sec: Optional[ConstrainedIntValue] = None

The number of write requests processed per second.

Constraints

  • minimum = 0

ContainerPerformanceGetResponse

pydantic model pypureclient.flasharray.ContainerPerformanceGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None, items: Optional[ConstrainedListValue[ContainerPerformance]] = None, total: Optional[ConstrainedListValue[ContainerPerformance]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[ContainerPerformance]] = None

Performance data. If total_only=true, the items list will be empty.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total: Optional[ConstrainedListValue[ContainerPerformance]] = None

The aggregate value of all items after filtering. When applicable, the average value is displayed instead. If applicable, the values are displayed for each field.

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

ContainerQos

pydantic model pypureclient.flasharray.ContainerQos(*, bandwidth_limit: Optional[ConstrainedIntValue] = None, iops_limit: Optional[ConstrainedIntValue] = None)
field bandwidth_limit: Optional[ConstrainedIntValue] = None

The maximum QoS bandwidth limit for the container. Whenever throughput exceeds the bandwidth limit, throttling occurs. Measured in bytes per second. Maximum limit is 512 GB/s.

Constraints

  • minimum = 1048576

  • maximum = 549755813888

field iops_limit: Optional[ConstrainedIntValue] = None

The QoS IOPs limit for the container.

Constraints

  • minimum = 100

  • maximum = 100000000

Context

pydantic model pypureclient.flasharray.Context(*, context: Optional[FixedReference] = None)
field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

Controller

pydantic model pypureclient.flasharray.Controller(*, name: Optional[StrictStr] = None, mode: Optional[StrictStr] = None, mode_since: Optional[StrictInt] = None, model: Optional[StrictStr] = None, status: Optional[StrictStr] = None, type: Optional[StrictStr] = None, version: Optional[StrictStr] = None)
field mode: Optional[StrictStr] = None

Mode of controller. Values include not present, offline, primary, and secondary.

field mode_since: Optional[StrictInt] = None

The time at which the current mode of the controller was last set. It is measured in milliseconds since the UNIX epoch. If the controller mode is not present or offline, this field will be null.

field model: Optional[StrictStr] = None
field name: Optional[StrictStr] = None

A locally unique, system-generated name. The name cannot be modified.

field status: Optional[StrictStr] = None

Status of controller. Values include not ready, ready, unknown, and updating.

field type: Optional[StrictStr] = None

Type of controller. Values include array_controller and shelf_controller.

field version: Optional[StrictStr] = None

ControllerGetResponse

pydantic model pypureclient.flasharray.ControllerGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Controller]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[Controller]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

DefaultProtectionReference

pydantic model pypureclient.flasharray.DefaultProtectionReference(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, type: Optional[StrictStr] = None)
field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified.

field name: Optional[StrictStr] = None

The resource name, such as volume name, pod name, snapshot name, and so on.

field type: Optional[StrictStr] = None

The type of default protection. Currently, the only valid value is protection_group.

DestroyedPatchPost

pydantic model pypureclient.flasharray.DestroyedPatchPost(*, destroyed: Optional[StrictBool] = None)
field destroyed: Optional[StrictBool] = None

If set to true, destroys a resource. Once set to true, the time_remaining value will display the amount of time left until the destroyed resource is permanently eradicated. Before the time_remaining period has elapsed, the destroyed resource can be recovered by setting destroyed=false. Once the time_remaining period has elapsed, the resource is permanently eradicated and can no longer be recovered.

Constraints

  • type = boolean

Directory

pydantic model pypureclient.flasharray.Directory(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, context: Optional[FixedReference] = None, created: Optional[StrictInt] = None, destroyed: Optional[StrictBool] = None, directory_name: Optional[StrictStr] = None, file_system: Optional[FixedReference] = None, limited_by: Optional[LimitedBy] = None, path: Optional[StrictStr] = None, space: Optional[Space] = None, time_remaining: Optional[StrictInt] = None)
field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field created: Optional[StrictInt] = None

The managed directory creation time, measured in milliseconds since the UNIX epoch.

field destroyed: Optional[StrictBool] = None

Returns a value of true if the managed directory has been destroyed and is pending eradication. The time_remaining value displays the amount of time left until the destroyed managed directory is permanently eradicated. Once the time_remaining period has elapsed, the managed directory is permanently eradicated and can no longer be recovered.

Constraints

  • type = boolean

field directory_name: Optional[StrictStr] = None

The managed directory name without the file system name prefix. A full managed directory name is constructed in the form of FILE_SYSTEM:DIR where FILE_SYSTEM is the file system name and DIR is the value of this field.

field file_system: Optional[FixedReference] = None

The file system that this managed directory is in.

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field limited_by: Optional[LimitedBy] = None

The quota policy that is limiting usage on this managed directory. This policy defines the total amount of space provisioned to this managed directory and its descendants. The returned value contains two parts&#58; the name of the policy and the managed directory to which the policy is attached.

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

field path: Optional[StrictStr] = None

Absolute path of the managed directory in the file system.

field space: Optional[Space] = None

Displays size and space consumption details.

field time_remaining: Optional[StrictInt] = None

The amount of time left, measured in milliseconds until the destroyed managed directory is permanently eradicated.

DirectoryExport

pydantic model pypureclient.flasharray.DirectoryExport(*, enabled: Optional[StrictBool] = None, export_name: Optional[StrictStr] = None, status: Optional[StrictStr] = None, context: Optional[FixedReference] = None, destroyed: Optional[StrictBool] = None, directory: Optional[FixedReferenceWithType] = None, path: Optional[StrictStr] = None, policy: Optional[FixedReferenceWithType] = None)
field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field destroyed: Optional[StrictBool] = None

Returns a value of true if the managed directory of the export has been destroyed and is pending eradication. The export can be recovered by recovering the destroyed managed directory.

Constraints

  • type = boolean

field directory: Optional[FixedReferenceWithType] = None

The managed directory of the export.

field enabled: Optional[StrictBool] = None

Returns a value of true if the export policy that manages this export is enabled.

Constraints

  • type = boolean

field export_name: Optional[StrictStr] = None

The export name for accessing this export.

field path: Optional[StrictStr] = None

The path of the exported managed directory.

field policy: Optional[FixedReferenceWithType] = None

The export policy that manages this export. An export can be managed by at most one export policy.

field status: Optional[StrictStr] = None

Explains why enabled is false, or whether there is a name conflict with another export. Valid values include policy_disabled, export_disabled, and name_conflict.

DirectoryExportGetResponse

pydantic model pypureclient.flasharray.DirectoryExportGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[DirectoryExport]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[DirectoryExport]] = None

Displays a list of all items after filtering. The values are displayed for each name if meaningful.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

DirectoryExportPatch

pydantic model pypureclient.flasharray.DirectoryExportPatch(*, export_enabled: Optional[StrictBool] = None, export_name: Optional[StrictStr] = None)
field export_enabled: Optional[StrictBool] = None

If set to true, the export is enabled. If not specified, defaults to true.

Constraints

  • type = boolean

field export_name: Optional[StrictStr] = None

The new name of the export. Export names must be unique within the same protocol.

DirectoryExportPost

pydantic model pypureclient.flasharray.DirectoryExportPost(*, export_enabled: Optional[StrictBool] = None, export_name: Optional[StrictStr] = None)
field export_enabled: Optional[StrictBool] = None

If set to true, the export is enabled. If not specified, defaults to true.

Constraints

  • type = boolean

field export_name: Optional[StrictStr] = None

The name of the export to create. Export names must be unique within the same protocol.

DirectoryExportResponse

pydantic model pypureclient.flasharray.DirectoryExportResponse(*, items: Optional[ConstrainedListValue[DirectoryExport]] = None)
field items: Optional[ConstrainedListValue[DirectoryExport]] = None

Displays a list of all items after filtering. The values are displayed for each name if meaningful.

DirectoryGetResponse

pydantic model pypureclient.flasharray.DirectoryGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Directory]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None, total: Optional[ConstrainedListValue[Directory]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[Directory]] = None

Displays a list of all items after filtering. If applicable, the values are displayed for each name.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total: Optional[ConstrainedListValue[Directory]] = None

The aggregate value of all items after filtering. When applicable, the average value is displayed instead. If applicable, the values are displayed for each field.

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

DirectoryLockNlmReclamation

pydantic model pypureclient.flasharray.DirectoryLockNlmReclamation(*, context: Optional[FixedReference] = None, end: Optional[StrictInt] = None, start: Optional[StrictInt] = None)
field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field end: Optional[StrictInt] = None

End time of the NLM reclamation in milliseconds since the UNIX epoch.

field start: Optional[StrictInt] = None

Start time of the NLM reclamation in milliseconds since the UNIX epoch.

DirectoryLockNlmReclamationResponse

pydantic model pypureclient.flasharray.DirectoryLockNlmReclamationResponse(*, items: Optional[ConstrainedListValue[DirectoryLockNlmReclamation]] = None)
field items: Optional[ConstrainedListValue[DirectoryLockNlmReclamation]] = None

DirectoryPatch

pydantic model pypureclient.flasharray.DirectoryPatch(*, name: Optional[StrictStr] = None, directory_name: Optional[StrictStr] = None)
field directory_name: Optional[StrictStr] = None

The managed directory name without the file system name prefix. A full managed directory name is constructed in the form of FILE_SYSTEM:DIR where FILE_SYSTEM is the file system name and DIR is the value of this field.

field name: Optional[StrictStr] = None

The new name for the resource.

DirectoryPerformance

pydantic model pypureclient.flasharray.DirectoryPerformance(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, context: Optional[FixedReference] = None, bytes_per_op: Optional[ConstrainedIntValue] = None, bytes_per_read: Optional[ConstrainedIntValue] = None, bytes_per_write: Optional[ConstrainedIntValue] = None, others_per_sec: Optional[ConstrainedIntValue] = None, read_bytes_per_sec: Optional[ConstrainedIntValue] = None, reads_per_sec: Optional[ConstrainedIntValue] = None, time: Optional[StrictInt] = None, usec_per_other_op: Optional[ConstrainedIntValue] = None, usec_per_read_op: Optional[ConstrainedIntValue] = None, usec_per_write_op: Optional[ConstrainedIntValue] = None, write_bytes_per_sec: Optional[ConstrainedIntValue] = None, writes_per_sec: Optional[ConstrainedIntValue] = None)
field bytes_per_op: Optional[ConstrainedIntValue] = None

The average I/O size for both read and write (all) operations.

Constraints

  • minimum = 0

field bytes_per_read: Optional[ConstrainedIntValue] = None

The average I/O size per read, measured in bytes.

Constraints

  • minimum = 0

field bytes_per_write: Optional[ConstrainedIntValue] = None

The average I/O size per write, measured in bytes.

Constraints

  • minimum = 0

field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

field others_per_sec: Optional[ConstrainedIntValue] = None

The number of other requests processed per second.

Constraints

  • minimum = 0

field read_bytes_per_sec: Optional[ConstrainedIntValue] = None

The number of bytes read per second.

Constraints

  • minimum = 0

field reads_per_sec: Optional[ConstrainedIntValue] = None

The number of read requests processed per second.

Constraints

  • minimum = 0

field time: Optional[StrictInt] = None

The time when the sample performance data was taken. Measured in milliseconds since the UNIX epoch.

field usec_per_other_op: Optional[ConstrainedIntValue] = None

The average time it takes the array to process an I/O other request, measured in microseconds.

Constraints

  • minimum = 0

field usec_per_read_op: Optional[ConstrainedIntValue] = None

The average time it takes the array to process an I/O read request, measured in microseconds.

Constraints

  • minimum = 0

field usec_per_write_op: Optional[ConstrainedIntValue] = None

The average time it takes the array to process an I/O write request, measured in microseconds.

Constraints

  • minimum = 0

field write_bytes_per_sec: Optional[ConstrainedIntValue] = None

The number of bytes written per second.

Constraints

  • minimum = 0

field writes_per_sec: Optional[ConstrainedIntValue] = None

The number of write requests processed per second.

Constraints

  • minimum = 0

DirectoryPerformanceGetResponse

pydantic model pypureclient.flasharray.DirectoryPerformanceGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None, items: Optional[ConstrainedListValue[DirectoryPerformance]] = None, total: Optional[ConstrainedListValue[DirectoryPerformance]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[DirectoryPerformance]] = None

Performance data. If total_only=true, the items list will be empty.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total: Optional[ConstrainedListValue[DirectoryPerformance]] = None

The aggregate value of all items after filtering. When it makes sense, the average value is displayed instead. The values are displayed for each field if meaningful.

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

DirectoryPolicyExportPost

pydantic model pypureclient.flasharray.DirectoryPolicyExportPost(*, policies: Optional[ConstrainedListValue[DirectorypolicyexportpostPolicies]] = None)
field policies: Optional[ConstrainedListValue[DirectorypolicyexportpostPolicies]] = None

A list of export policies to apply to the directory. The id and name fields in each policy parameter are required, but cannot be set together.

DirectoryPolicyPost

pydantic model pypureclient.flasharray.DirectoryPolicyPost(*, policies: Optional[ConstrainedListValue[DirectorypolicypostPolicies]] = None)
field policies: Optional[ConstrainedListValue[DirectorypolicypostPolicies]] = None

A list of policies to apply to the resource. The id or name field in each policy parameter is required, but they cannot be set together.

DirectoryPost

pydantic model pypureclient.flasharray.DirectoryPost(*, directory_name: Optional[StrictStr] = None, path: Optional[StrictStr] = None)
field directory_name: Optional[StrictStr] = None

The managed directory name without the file system name prefix. A full managed directory name is constructed in the form of FILE_SYSTEM:DIR where FILE_SYSTEM is the file system name and DIR is the value of this field. directory_name is required if file_system_names or file_system_ids is set. directory_name cannot be set if names is set.

field path: Optional[StrictStr] = None

Path of the managed directory in the file system.

DirectoryQuota

pydantic model pypureclient.flasharray.DirectoryQuota(*, context: Optional[FixedReference] = None, directory: Optional[FixedReferenceWithType] = None, enabled: Optional[StrictBool] = None, enforced: Optional[StrictBool] = None, path: Optional[StrictStr] = None, percentage_used: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, policy: Optional[FixedReferenceWithType] = None, quota_limit: Optional[ConstrainedIntValue] = None, rule_name: Optional[StrictStr] = None, usage: Optional[ConstrainedIntValue] = None)
field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field directory: Optional[FixedReferenceWithType] = None

The directory to which the quota applies.

field enabled: Optional[StrictBool] = None

Returns a value of true if the policy is enabled.

Constraints

  • type = boolean

field enforced: Optional[StrictBool] = None

Defines whether the quota rule is enforced or unenforced. If the quota rule is enforced and logical space usage exceeds the quota limit, any modification operations that result in a need for more space are blocked. If the quota rule is unenforced and logical space usage exceeds the quota limit, notification emails are sent to targets that are specified using the notification parameter. No client operations are blocked when an unenforced limit is exceeded. If set to true, the limit is enforced. If set to false, notification targets are informed when the usage exceeds 80 percent of the limit.

Constraints

  • type = boolean

field path: Optional[StrictStr] = None

Absolute path of the directory in the file system.

field percentage_used: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

The percentage of the space used in the directory with respect to the quota limit.

field policy: Optional[FixedReferenceWithType] = None

The effective quota policy that imposes the limit. This is the policy with the lowest limit.

field quota_limit: Optional[ConstrainedIntValue] = None

Effective quota limit imposed by the quota policy rule attached to the directory, measured in bytes.

Constraints

  • minimum = 0

field rule_name: Optional[StrictStr] = None

Name of the rule that results in this quota and behavior being applied to this directory.

field usage: Optional[ConstrainedIntValue] = None

The amount of logically written data for the directory, measured in bytes.

Constraints

  • minimum = 0

DirectoryQuotasGetResponse

pydantic model pypureclient.flasharray.DirectoryQuotasGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[DirectoryQuota]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[DirectoryQuota]] = None

Displays a list of all items after filtering. The values are displayed for each name, if meaningful.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

DirectoryQuotasResponse

pydantic model pypureclient.flasharray.DirectoryQuotasResponse(*, items: Optional[ConstrainedListValue[DirectoryQuota]] = None)
field items: Optional[ConstrainedListValue[DirectoryQuota]] = None

Displays a list of all items after filtering. The values are displayed for each name, if meaningful.

DirectoryResponse

pydantic model pypureclient.flasharray.DirectoryResponse(*, items: Optional[ConstrainedListValue[Directory]] = None)
field items: Optional[ConstrainedListValue[Directory]] = None

Displays a list of all items after filtering. If applicable, the values are displayed for each name.

DirectoryService

pydantic model pypureclient.flasharray.DirectoryService(*, name: Optional[StrictStr] = None, context: Optional[FixedReference] = None, base_dn: Optional[StrictStr] = None, bind_password: Optional[StrictStr] = None, bind_user: Optional[StrictStr] = None, ca_certificate: Optional[StrictStr] = None, check_peer: Optional[StrictBool] = None, enabled: Optional[StrictBool] = None, management: Optional[DirectoryServiceManagement] = None, services: Optional[ConstrainedListValue[StrictStr]] = None, uris: Optional[ConstrainedListValue[ConstrainedStrValue]] = None)
field base_dn: Optional[StrictStr] = None

Base of the Distinguished Name (DN) of the directory service groups.

field bind_password: Optional[StrictStr] = None

Masked password used to query the directory.

field bind_user: Optional[StrictStr] = None

Username used to query the directory.

field ca_certificate: Optional[StrictStr] = None

The certificate of the Certificate Authority (CA) that signed the certificates of the directory servers, which is used to validate the authenticity of the configured servers.

field check_peer: Optional[StrictBool] = None

Whether or not server authenticity is enforced when a certificate is provided.

Constraints

  • type = boolean

field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field enabled: Optional[StrictBool] = None

Whether or not the directory service is enabled.

Constraints

  • type = boolean

field management: Optional[DirectoryServiceManagement] = None
field name: Optional[StrictStr] = None

A locally unique, system-generated name. The name cannot be modified.

field services: Optional[ConstrainedListValue[StrictStr]] = None

The services the directory service configuration is used for.

field uris: Optional[ConstrainedListValue[ConstrainedStrValue]] = None

List of URIs for the configured directory servers.

DirectoryServiceGetResponse

pydantic model pypureclient.flasharray.DirectoryServiceGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[DirectoryService]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[DirectoryService]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

DirectoryServiceManagement

pydantic model pypureclient.flasharray.DirectoryServiceManagement(*, ssh_public_key_attribute: Optional[StrictStr] = None, user_login_attribute: Optional[StrictStr] = None, user_object_class: Optional[StrictStr] = None)

Properties specific to the management service.

field ssh_public_key_attribute: Optional[StrictStr] = None

SSH public key attribute in the structure of the configured LDAP servers. The attribute field that holds the user’s SSH public key. This attribute can represent a single-valued or multi-valued field. If this attribute resolves to a multi-valued field, all valid SSH keys will be used. If the user has specified keys under Admin endpoints, these are used as well.

field user_login_attribute: Optional[StrictStr] = None

User login attribute in the structure of the configured LDAP servers. Typically the attribute field that holds the user’s unique login name. Default value is sAMAccountName for Active Directory or uid for all other directory services.

field user_object_class: Optional[StrictStr] = None

Value of the object class for a management LDAP user. Defaults to User for Active Directory servers, posixAccount or shadowAccount for OpenLDAP servers dependent on the group type of the server, or person for all other directory servers.

DirectoryServiceResponse

pydantic model pypureclient.flasharray.DirectoryServiceResponse(*, items: Optional[ConstrainedListValue[DirectoryService]] = None)
field items: Optional[ConstrainedListValue[DirectoryService]] = None

DirectoryServiceRole

pydantic model pypureclient.flasharray.DirectoryServiceRole(*, name: Optional[StrictStr] = None, context: Optional[FixedReference] = None, group: Optional[StrictStr] = None, group_base: Optional[StrictStr] = None, management_access_policies: Optional[ConstrainedListValue[FixedReferenceWithType]] = None, role: Optional[ReferenceNoId] = None)
field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field group: Optional[StrictStr] = None

Group name that contains users with the abilities granted by the associated policies.

field group_base: Optional[StrictStr] = None

Specifies where the configured group is located in the directory tree.

field management_access_policies: Optional[ConstrainedListValue[FixedReferenceWithType]] = None

List of management access policies associated with the group.

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and cannot be changed.

field role: Optional[ReferenceNoId] = None

This field has been deprecated. Predecessor to management access policies.

DirectoryServiceRoleGetResponse

pydantic model pypureclient.flasharray.DirectoryServiceRoleGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[DirectoryServiceRole]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[DirectoryServiceRole]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

DirectoryServiceRolePost

pydantic model pypureclient.flasharray.DirectoryServiceRolePost(*, group: Optional[StrictStr] = None, group_base: Optional[StrictStr] = None, management_access_policies: Optional[ConstrainedListValue[ReferenceWithType]] = None, role: Optional[ReferenceNoId] = None)
field group: Optional[StrictStr] = None

Group name that contains users with the abilities granted by the associated policies.

field group_base: Optional[StrictStr] = None

Specifies where the configured group is located in the directory tree.

field management_access_policies: Optional[ConstrainedListValue[ReferenceWithType]] = None

List of management access policies to associate with the group.

field role: Optional[ReferenceNoId] = None

This field has been deprecated. Predecessor to management access policies. Can be set to the premade policy of the same name. Cannot be set with management_access_policies.

DirectoryServiceRoleResponse

pydantic model pypureclient.flasharray.DirectoryServiceRoleResponse(*, items: Optional[ConstrainedListValue[DirectoryServiceRole]] = None)
field items: Optional[ConstrainedListValue[DirectoryServiceRole]] = None

DirectorySnapshot

pydantic model pypureclient.flasharray.DirectorySnapshot(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, context: Optional[FixedReference] = None, client_name: Optional[StrictStr] = None, created: Optional[StrictInt] = None, destroyed: Optional[StrictBool] = None, policy: Optional[FixedReference] = None, source: Optional[FixedReference] = None, space: Optional[Space] = None, suffix: Optional[StrictInt] = None, time_remaining: Optional[StrictInt] = None)
field client_name: Optional[StrictStr] = None

The customizable portion of the client-visible snapshot name. A full snapshot name is constructed in the form of DIR.CLIENT_NAME.SUFFIX where DIR is the full managed directory name, CLIENT_NAME is the client name, and SUFFIX is the suffix. The client-visible snapshot name is CLIENT_NAME.SUFFIX.

field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field created: Optional[StrictInt] = None

The snapshot creation time, measured in milliseconds since the UNIX epoch.

field destroyed: Optional[StrictBool] = None

Returns a value of true if the snapshot has been destroyed and is pending eradication. The time_remaining value displays the amount of time left until the destroyed directory snapshot is permanently eradicated. Before the time_remaining period has elapsed, the destroyed directory snapshot can be recovered by setting destroyed=false. Once the time_remaining period has elapsed, the directory snapshot is permanently eradicated and can no longer be recovered.

Constraints

  • type = boolean

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

field policy: Optional[FixedReference] = None

The snapshot policy that manages this snapshot, if applicable.

field source: Optional[FixedReference] = None

The directory from which this snapshot was taken.

field space: Optional[Space] = None

Displays size and space consumption details.

field suffix: Optional[StrictInt] = None

The suffix that is appended to the source_name value and the client_name value to generate the full directory snapshot name in the form of DIR.CLIENT_NAME.SUFFIX where DIR is the managed directory name, CLIENT_NAME is the client name, and SUFFIX is the suffix. If the suffix is a string, this field returns null. See the name value for the full snapshot name including the suffix.

field time_remaining: Optional[StrictInt] = None

The amount of time left until the directory snapshot is permanently eradicated, measured in milliseconds. Before the time_remaining period has elapsed, the snapshot can be recovered by setting destroyed=false if it is destroyed, by setting policy=”” if it is managed by a snapshot policy, or by setting keep_for=”” if it is a manual snapshot.

DirectorySnapshotGetResponse

pydantic model pypureclient.flasharray.DirectorySnapshotGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[DirectorySnapshot]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None, total: Optional[ConstrainedListValue[DirectorySnapshot]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[DirectorySnapshot]] = None

Displays a list of all items after filtering. If applicable, the values are displayed for each name.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total: Optional[ConstrainedListValue[DirectorySnapshot]] = None

The aggregate value of all items after filtering. When applicable, the average value is displayed instead. If applicable, the values are displayed for each field.

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

DirectorySnapshotPatch

pydantic model pypureclient.flasharray.DirectorySnapshotPatch(*, destroyed: Optional[StrictBool] = None, client_name: Optional[StrictStr] = None, keep_for: Optional[StrictInt] = None, name: Optional[StrictStr] = None, policy: Optional[Reference] = None, suffix: Optional[StrictStr] = None)
field client_name: Optional[StrictStr] = None

The client name portion of the client-visible snapshot name. A full snapshot name is constructed in the form of DIR.CLIENT_NAME.SUFFIX where DIR is the managed directory name, CLIENT_NAME is the value of this field, and SUFFIX is the suffix. The client-visible snapshot name is CLIENT_NAME.SUFFIX. The client name of a directory snapshot managed by a snapshot policy is not changeable. If the name and client_name parameters are both specified, client_name must match the client name portion of name.

field destroyed: Optional[StrictBool] = None

If set to true, destroys a resource. Once set to true, the time_remaining value will display the amount of time left until the destroyed resource is permanently eradicated. Before the time_remaining period has elapsed, the destroyed resource can be recovered by setting destroyed=false. Once the time_remaining period has elapsed, the resource is permanently eradicated and can no longer be recovered.

Constraints

  • type = boolean

field keep_for: Optional[StrictInt] = None

The amount of time to keep the snapshots, in milliseconds. Can only be set on snapshots that are not managed by any snapshot policy. Set to “” to clear the keep_for value.

field name: Optional[StrictStr] = None

The new name of a directory snapshot. The name of a directory snapshot managed by a snapshot policy is not changeable.

field policy: Optional[Reference] = None

The snapshot policy that manages this snapshot. Set to name or id to “” to clear the policy.

field suffix: Optional[StrictStr] = None

The suffix portion of the client-visible snapshot name. A full snapshot name is constructed in the form of DIR.CLIENT_NAME.SUFFIX where DIR is the managed directory name, CLIENT_NAME is the client name, and SUFFIX is the value of this field. The client-visible snapshot name is CLIENT_NAME.SUFFIX. The suffix of a directory snapshot managed by a snapshot policy is not changeable. If the name and suffix parameters are both specified, suffix must match the suffix portion of name.

DirectorySnapshotPost

pydantic model pypureclient.flasharray.DirectorySnapshotPost(*, client_name: Optional[StrictStr] = None, keep_for: Optional[StrictInt] = None, suffix: Optional[StrictStr] = None)
field client_name: Optional[StrictStr] = None

The client name portion of the client visible snapshot name. A full snapshot name is constructed in the form of DIR.CLIENT_NAME.SUFFIX where DIR is the managed directory name, CLIENT_NAME is the value of this field, and SUFFIX is the suffix. The client visible snapshot name is CLIENT_NAME.SUFFIX.

field keep_for: Optional[StrictInt] = None

The time to keep the snapshots for, in milliseconds.

field suffix: Optional[StrictStr] = None

The suffix portion of the client visible snapshot name. A full snapshot name is constructed in the form of DIR.CLIENT_NAME.SUFFIX where DIR is the managed directory name, CLIENT_NAME is the client name, and SUFFIX is the value of this field. The client visible snapshot name is CLIENT_NAME.SUFFIX. If not specified, defaults to a monotonically increasing number generated by the system.

DirectorySnapshotResponse

pydantic model pypureclient.flasharray.DirectorySnapshotResponse(*, items: Optional[ConstrainedListValue[DirectorySnapshot]] = None)
field items: Optional[ConstrainedListValue[DirectorySnapshot]] = None

Displays a list of all items after filtering. If applicable, the values are displayed for each name.

DirectorypolicyexportpostPolicies

pydantic model pypureclient.flasharray.DirectorypolicyexportpostPolicies(*, export_enabled: Optional[StrictBool] = None, export_name: Optional[StrictStr] = None, policy: Optional[Reference] = None)
field export_enabled: Optional[StrictBool] = None

If set to true, the export is enabled. If not specified, defaults to true.

Constraints

  • type = boolean

field export_name: Optional[StrictStr] = None

The name of the export to create when applying the export policy to the directory.

field policy: Optional[Reference] = None

Reference to the export policy to apply to the directory.

DirectorypolicypostPolicies

pydantic model pypureclient.flasharray.DirectorypolicypostPolicies(*, policy: Optional[Reference] = None)
field policy: Optional[Reference] = None

Reference to the policy to apply to the resource.

Dns

pydantic model pypureclient.flasharray.Dns(*, name: Optional[StrictStr] = None, ca_certificate: Optional[ReferenceWithType] = None, ca_certificate_group: Optional[ReferenceWithType] = None, domain: Optional[StrictStr] = None, nameservers: Optional[ConstrainedListValue[StrictStr]] = None, services: Optional[ConstrainedListValue[StrictStr]] = None, source: Optional[ReferenceNoId] = None)
field ca_certificate: Optional[ReferenceWithType] = None

A reference to the certificate to use for validating nameservers with HTTPS connections. This property is mutually exclusive with ca_certificate_group property and may only be configured when nameservers begin with HTTPS.

field ca_certificate_group: Optional[ReferenceWithType] = None

A reference to the certificate group to use for validating nameservers with HTTPS connections. This property is mutually exclusive with ca_certificate property and may only be configured when nameservers begin with HTTPS.

field domain: Optional[StrictStr] = None

The domain suffix to be appended by the appliance when performing DNS lookups.

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

field nameservers: Optional[ConstrainedListValue[StrictStr]] = None

The list of DNS servers either in the form of IP addresses or HTTPS endpoints. Domain names in HTTPS endpoints are not supported. IP addresses must be used instead. If nameservers begin with https://, then DNS queries will be performed over HTTPS. Otherwise, unencrypted DNS queries will be performed. Using a combination of nameservers that begin with https:// and that do not begin with https:// is not supported. If servers are specified with https:// one of ca_certificate and ca_certificate_group parameters must be set.

field services: Optional[ConstrainedListValue[StrictStr]] = None

The list of services utilizing the DNS configuration.

field source: Optional[ReferenceNoId] = None

The network interface used for communication with the DNS server.

DnsGetResponse

pydantic model pypureclient.flasharray.DnsGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Dns]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[Dns]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

DnsPatch

pydantic model pypureclient.flasharray.DnsPatch(*, name: Optional[StrictStr] = None, ca_certificate: Optional[ReferenceWithType] = None, ca_certificate_group: Optional[ReferenceWithType] = None, domain: Optional[StrictStr] = None, nameservers: Optional[ConstrainedListValue[StrictStr]] = None, services: Optional[ConstrainedListValue[StrictStr]] = None, source: Optional[ReferenceNoId] = None)
field ca_certificate: Optional[ReferenceWithType] = None

A reference to the certificate to use for validating nameservers with HTTPS connections. This property is mutually exclusive with ca_certificate_group property and may only be configured when nameservers begin with HTTPS.

field ca_certificate_group: Optional[ReferenceWithType] = None

A reference to the certificate group to use for validating nameservers with HTTPS connections. This property is mutually exclusive with ca_certificate property and may only be configured when nameservers begin with HTTPS.

field domain: Optional[StrictStr] = None

The domain suffix to be appended by the appliance when performing DNS lookups.

field name: Optional[StrictStr] = None

The new name for the resource.

field nameservers: Optional[ConstrainedListValue[StrictStr]] = None

The list of DNS servers either in the form of IP addresses or HTTPS endpoints. Domain names in HTTPS endpoints are not supported. IP addresses must be used instead. If nameservers begin with https://, then DNS queries will be performed over HTTPS. Otherwise, unencrypted DNS queries will be performed. Using a combination of nameservers that begin with https:// and that do not begin with https:// is not supported. If servers are specified with https:// one of ca_certificate and ca_certificate_group parameters must be set.

field services: Optional[ConstrainedListValue[StrictStr]] = None

The list of services utilizing the DNS configuration.

field source: Optional[ReferenceNoId] = None

The network interface used for communication with the DNS server.

DnsPost

pydantic model pypureclient.flasharray.DnsPost(*, ca_certificate: Optional[ReferenceWithType] = None, ca_certificate_group: Optional[ReferenceWithType] = None, domain: Optional[StrictStr] = None, nameservers: Optional[ConstrainedListValue[StrictStr]] = None, services: Optional[ConstrainedListValue[StrictStr]] = None, source: Optional[ReferenceNoId] = None)

Configuration information for the domain name servers.

field ca_certificate: Optional[ReferenceWithType] = None

A reference to the certificate to use for validating nameservers with HTTPS connections. This property is mutually exclusive with ca_certificate_group property and may only be configured when nameservers begin with HTTPS.

field ca_certificate_group: Optional[ReferenceWithType] = None

A reference to the certificate group to use for validating nameservers with HTTPS connections. This property is mutually exclusive with ca_certificate property and may only be configured when nameservers begin with HTTPS.

field domain: Optional[StrictStr] = None

The domain suffix to be appended by the appliance when performing DNS lookups.

field nameservers: Optional[ConstrainedListValue[StrictStr]] = None

The list of DNS servers either in the form of IP addresses or HTTPS endpoints. Domain names in HTTPS endpoints are not supported. IP addresses must be used instead. If nameservers begin with https://, then DNS queries will be performed over HTTPS. Otherwise, unencrypted DNS queries will be performed. Using a combination of nameservers that begin with https:// and that do not begin with https:// is not supported. If servers are specified with https:// one of ca_certificate and ca_certificate_group parameters must be set.

field services: Optional[ConstrainedListValue[StrictStr]] = None

The list of services utilizing the DNS configuration.

field source: Optional[ReferenceNoId] = None

The network interface used for communication with the DNS server.

DnsResponse

pydantic model pypureclient.flasharray.DnsResponse(*, items: Optional[ConstrainedListValue[Dns]] = None)
field items: Optional[ConstrainedListValue[Dns]] = None

Drive

pydantic model pypureclient.flasharray.Drive(*, name: Optional[StrictStr] = None, capacity: Optional[StrictInt] = None, capacity_installed: Optional[StrictInt] = None, details: Optional[StrictStr] = None, protocol: Optional[StrictStr] = None, status: Optional[StrictStr] = None, type: Optional[StrictStr] = None)
field capacity: Optional[StrictInt] = None

Entitled capacity of individual drive in bytes.

field capacity_installed: Optional[StrictInt] = None

Raw capacity of individual drive in bytes.

field details: Optional[StrictStr] = None

Details about the status of the module if not healthy.

field name: Optional[StrictStr] = None

A locally unique, system-generated name. The name cannot be modified.

field protocol: Optional[StrictStr] = None

Storage protocol of the module. Valid values are NVMe and SAS.

field status: Optional[StrictStr] = None

Current status of the module. Valid values are empty, failed, healthy, identifying, missing, recovering, unadmitted, unhealthy, unrecognized, and updating.

field type: Optional[StrictStr] = None

The type of the module. Valid values are cache, NVRAM, SSD, and virtual.

DriveGetResponse

pydantic model pypureclient.flasharray.DriveGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Drive]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[Drive]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

DriveResponse

pydantic model pypureclient.flasharray.DriveResponse(*, items: Optional[ConstrainedListValue[Drive]] = None)
field items: Optional[ConstrainedListValue[Drive]] = None

EradicationConfig

pydantic model pypureclient.flasharray.EradicationConfig(*, disabled_delay: Optional[StrictInt] = None, enabled_delay: Optional[StrictInt] = None, eradication_delay: Optional[StrictInt] = None, manual_eradication: Optional[StrictStr] = None)

The configuration of eradication feature.

field disabled_delay: Optional[StrictInt] = None

The eradication delay in milliseconds for destroyed objects that cannot be manually eradicated. Destroyed objects that cannot be manually eradicated will be automatically eradicated after the configured delay time passes. Valid values are 86400000 and any multiple of 86400000 in the range of 86400000 and 2592000000. Any other values are rounded down to the nearest multiple of 86400000.

field enabled_delay: Optional[StrictInt] = None

The eradication delay in milliseconds for destroyed objects that can be manually eradicated. Destroyed objects that can be manually eradicated will be automatically eradicated after the configured delay time passes. Valid values are 86400000 and any multiple of 86400000 in the range of 86400000 and 2592000000. Any other values are rounded down to the nearest multiple of 86400000.

field eradication_delay: Optional[StrictInt] = None

Eradication delay in milliseconds for all destroyed objects. Automatically eradicate destroyed objects after the configured delay time passes. Updating this field will update both eradication_disabled_delay and eradication_enabled_delay if both eradication_disabled_delay and eradication_enabled_delay have the same value. If eradication_disabled_delay and eradication_enabled_delay have different values, trying to configure eradication_delay will result in an error. This field has been deprecated and will be removed in a future REST version. Valid values are 86400000 and any multiple of 86400000 in the range of 86400000 and 2592000000. Any other values are rounded down to the nearest multiple of 86400000.

field manual_eradication: Optional[StrictStr] = None

Manual eradication status applied on the array level. If status is all-disabled, you cannot eradicate objects, files, and directories. If at least one local object has manual_eradication disabled, then the status will be partially-disabled. Values include all-disabled, partially-disabled, and all-enabled. If the user does not have sufficient access, this field will return null.

ErrorContextResponse

pydantic model pypureclient.flasharray.ErrorContextResponse(*, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None)
field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

ErrorcontextresponseErrors

pydantic model pypureclient.flasharray.ErrorcontextresponseErrors(*, context: Optional[StrictStr] = None, location_context: Optional[FixedReferenceWithType] = None, message: Optional[StrictStr] = None)
field context: Optional[StrictStr] = None

Contains information relating to the cause of this error, or the name of the object that was being processed when the error was encountered. This may be null for more general errors.

field location_context: Optional[FixedReferenceWithType] = None

Contains information relating to the context in which the request was executing when the error occurred. For example, this may be the name of an array in the same fleet. This may be null for more general errors, or if no explicit context parameter was provided with the request.

field message: Optional[StrictStr] = None

A description of the error which occurred.

Eula

pydantic model pypureclient.flasharray.Eula(*, agreement: Optional[StrictStr] = None, signature: Optional[EulaSignature] = None)
field agreement: Optional[StrictStr] = None

The End User Agreement text.

field signature: Optional[EulaSignature] = None

EulaGetResponse

pydantic model pypureclient.flasharray.EulaGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Eula]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[Eula]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

EulaResponse

pydantic model pypureclient.flasharray.EulaResponse(*, items: Optional[ConstrainedListValue[Eula]] = None)
field items: Optional[ConstrainedListValue[Eula]] = None

EulaSignature

pydantic model pypureclient.flasharray.EulaSignature(*, accepted: Optional[StrictInt] = None, company: Optional[StrictStr] = None, name: Optional[StrictStr] = None, title: Optional[StrictStr] = None)
field accepted: Optional[StrictInt] = None

Accepted time in milliseconds since the UNIX epoch.

field company: Optional[StrictStr] = None

The company of the person who accepted the End User Agreement. This field is deprecated and the response will be null. Modification to this field will be ignored.

field name: Optional[StrictStr] = None

The name of the person who accepted the End User Agreement. This field is deprecated and the response will be null. Modification to this field will be ignored.

field title: Optional[StrictStr] = None

The title of the person who accepted the End User Agreement. This field is deprecated and the response will be null. Modification to this field will be ignored.

ExportPolicyAttachmentMixin

pydantic model pypureclient.flasharray.ExportPolicyAttachmentMixin(*, enabled: Optional[StrictBool] = None, export_name: Optional[StrictStr] = None, status: Optional[StrictStr] = None)
field enabled: Optional[StrictBool] = None

Returns a value of true if and only if the export policy that manages this export is enabled AND this export is enabled.

Constraints

  • type = boolean

field export_name: Optional[StrictStr] = None

The export name for accessing this export.

field status: Optional[StrictStr] = None

Explains why enabled is false, or whether there is a name conflict with another export. Valid values include policy_disabled, export_disabled, and name_conflict.

FilePost

pydantic model pypureclient.flasharray.FilePost(*, source: Optional[ReferenceWithType] = None, source_path: Optional[StrictStr] = None)
field source: Optional[ReferenceWithType] = None

The source information of a file copy.

field source_path: Optional[StrictStr] = None

The source file path relative to the source directory.

FileSystem

pydantic model pypureclient.flasharray.FileSystem(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, context: Optional[FixedReference] = None, created: Optional[StrictInt] = None, destroyed: Optional[StrictBool] = None, pod: Optional[Reference] = None, time_remaining: Optional[StrictInt] = None)
field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field created: Optional[StrictInt] = None

The file system creation time, measured in milliseconds since the UNIX epoch.

field destroyed: Optional[StrictBool] = None

Returns a value of true if the file system has been destroyed and is pending eradication. The time_remaining value displays the amount of time left until the destroyed file system is permanently eradicated. Before the time_remaining period has elapsed, the destroyed file system can be recovered by setting destroyed=false. Once the time_remaining period has elapsed, the file system is permanently eradicated and can no longer be recovered.

Constraints

  • type = boolean

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

field pod: Optional[Reference] = None

The reference to the pod this file systems belongs to, or null if it is not in a pod.

field time_remaining: Optional[StrictInt] = None

The amount of time left, measured in milliseconds until the destroyed file system is permanently eradicated. Before the time_remaining period has elapsed, the destroyed file system can be recovered by setting destroyed=false.

FileSystemGetResponse

pydantic model pypureclient.flasharray.FileSystemGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[FileSystem]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[FileSystem]] = None

Displays a list of all items after filtering. If applicable, the values are displayed for each name.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

FileSystemPatch

pydantic model pypureclient.flasharray.FileSystemPatch(*, destroyed: Optional[StrictBool] = None, name: Optional[StrictStr] = None, pod: Optional[Reference] = None)
field destroyed: Optional[StrictBool] = None

If set to true, destroys a resource. Once set to true, the time_remaining value will display the amount of time left until the destroyed resource is permanently eradicated. Before the time_remaining period has elapsed, the destroyed resource can be recovered by setting destroyed=false. Once the time_remaining period has elapsed, the resource is permanently eradicated and can no longer be recovered.

Constraints

  • type = boolean

field name: Optional[StrictStr] = None

The new name for the resource.

field pod: Optional[Reference] = None

The pod to move existing file systems into.

FileSystemResponse

pydantic model pypureclient.flasharray.FileSystemResponse(*, items: Optional[ConstrainedListValue[FileSystem]] = None)
field items: Optional[ConstrainedListValue[FileSystem]] = None

Displays a list of all items after filtering. If applicable, the values are displayed for each name.

FixedNameResourceNoId

pydantic model pypureclient.flasharray.FixedNameResourceNoId(*, name: Optional[StrictStr] = None)

An ordinary (as opposed to built-in) resource that can be created, named, or deleted by the user. This might be a virtual resource (e.g., a volume) or correspond to something in the environment, like a host or server.

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and cannot be changed.

FixedReference

pydantic model pypureclient.flasharray.FixedReference(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None)
field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified.

field name: Optional[StrictStr] = None

The resource name, such as volume name, pod name, snapshot name, and so on.

FixedReferenceNoId

pydantic model pypureclient.flasharray.FixedReferenceNoId(*, name: Optional[StrictStr] = None)
field name: Optional[StrictStr] = None

The resource name, such as volume name, pod name, snapshot name, and so on.

FixedReferenceWithType

pydantic model pypureclient.flasharray.FixedReferenceWithType(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, resource_type: Optional[StrictStr] = None)
field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified.

field name: Optional[StrictStr] = None

The resource name, such as volume name, pod name, snapshot name, and so on.

field resource_type: Optional[StrictStr] = None

Type of the object (full name of the endpoint). Valid values include hosts, host-groups, network-interfaces, pods, ports, pod-replica-links, subnets, volumes, volume-snapshots, volume-groups, directories, policies/nfs, policies/smb, policies/snapshot, and policies/quota, etc.

FixedReferenceWithTypeAndLocation

pydantic model pypureclient.flasharray.FixedReferenceWithTypeAndLocation(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, is_local: Optional[StrictBool] = None, resource_type: Optional[StrictStr] = None)
field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified.

field is_local: Optional[StrictBool] = None

If set to true, the location reference is to the local array. If set to false, the location reference is to a remote location, such as a remote array or offload target.

Constraints

  • type = boolean

field name: Optional[StrictStr] = None

The resource name, such as volume name, pod name, snapshot name, and so on.

field resource_type: Optional[StrictStr] = None

Type of the object (full name of the endpoint). Valid values are the unique part of the resource’s REST endpoint. For example, a reference to a fleet would have a resource_type of fleets.

Fleet

pydantic model pypureclient.flasharray.Fleet(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, is_local: Optional[StrictBool] = None)
field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field is_local: Optional[StrictBool] = None

If set to true, the current array is a member of the fleet.

Constraints

  • type = boolean

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

FleetGetResponse

pydantic model pypureclient.flasharray.FleetGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Fleet]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[Fleet]] = None

Returns a list of all items after filtering. If applicable, the values are displayed for each name.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

FleetKey

pydantic model pypureclient.flasharray.FleetKey(*, created: Optional[StrictInt] = None, expires: Optional[StrictInt] = None, fleet_key: Optional[StrictStr] = None)
field created: Optional[StrictInt] = None

Creation time in milliseconds since UNIX epoch.

field expires: Optional[StrictInt] = None

Expiration time in milliseconds since UNIX epoch.

field fleet_key: Optional[StrictStr] = None

Fleet key, used for fleet connections. After creation, listing will only show ****.

FleetKeyGetResponse

pydantic model pypureclient.flasharray.FleetKeyGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[FleetKey]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[FleetKey]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

FleetKeyResponse

pydantic model pypureclient.flasharray.FleetKeyResponse(*, items: Optional[ConstrainedListValue[FleetKey]] = None)
field items: Optional[ConstrainedListValue[FleetKey]] = None

FleetMember

pydantic model pypureclient.flasharray.FleetMember(*, fleet: Optional[FixedReferenceWithTypeAndLocation] = None, member: Optional[FixedReferenceWithTypeAndLocation] = None, status: Optional[StrictStr] = None, status_details: Optional[StrictStr] = None)
field fleet: Optional[FixedReferenceWithTypeAndLocation] = None
field member: Optional[FixedReferenceWithTypeAndLocation] = None
field status: Optional[StrictStr] = None

Current fleet membership status Valid values are one of: joining, joined, or removing A status of joining indicates that the member is attempting to join the fleet. A status of joined indicates that the member has joined the fleet. A status of removing indicates that the member is being removed from the fleet.

field status_details: Optional[StrictStr] = None

Describes the error, if any.

FleetMemberGetResponse

pydantic model pypureclient.flasharray.FleetMemberGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[FleetMember]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[FleetMember]] = None

Returns a list of all items after filtering. If applicable, the values are displayed for each name.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

FleetMemberPost

pydantic model pypureclient.flasharray.FleetMemberPost(*, members: Optional[ConstrainedListValue[FleetmemberpostMembers]] = None)
field members: Optional[ConstrainedListValue[FleetmemberpostMembers]] = None

Details about the members being added to fleet.

FleetMemberResponse

pydantic model pypureclient.flasharray.FleetMemberResponse(*, items: Optional[ConstrainedListValue[FleetMember]] = None)
field items: Optional[ConstrainedListValue[FleetMember]] = None

Returns a list of all items after filtering. If applicable, the values are displayed for each name.

FleetPatch

pydantic model pypureclient.flasharray.FleetPatch(*, name: Optional[StrictStr] = None)
field name: Optional[StrictStr] = None

The new name for the resource.

FleetResponse

pydantic model pypureclient.flasharray.FleetResponse(*, items: Optional[ConstrainedListValue[Fleet]] = None)
field items: Optional[ConstrainedListValue[Fleet]] = None

Returns a list of all items after filtering. If applicable, the values are displayed for each name.

FleetmemberpostMember

pydantic model pypureclient.flasharray.FleetmemberpostMember(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, resource_type: Optional[StrictStr] = None)
field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified.

field name: Optional[StrictStr] = None

The resource name.

field resource_type: Optional[StrictStr] = None

Type of the object (e.g. remote-arrays)

FleetmemberpostMembers

pydantic model pypureclient.flasharray.FleetmemberpostMembers(*, key: Optional[StrictStr] = None, member: Optional[FleetmemberpostMember] = None)
field key: Optional[StrictStr] = None

Provide the fleet key generated from any array in the fleet.

field member: Optional[FleetmemberpostMember] = None

Hardware

pydantic model pypureclient.flasharray.Hardware(*, name: Optional[StrictStr] = None, details: Optional[StrictStr] = None, identify_enabled: Optional[StrictBool] = None, index: Optional[StrictInt] = None, model: Optional[StrictStr] = None, serial: Optional[StrictStr] = None, slot: Optional[StrictInt] = None, speed: Optional[StrictInt] = None, status: Optional[StrictStr] = None, temperature: Optional[StrictInt] = None, type: Optional[StrictStr] = None, voltage: Optional[StrictInt] = None)
field details: Optional[StrictStr] = None

Details about the status of the component if not healthy.

field identify_enabled: Optional[StrictBool] = None

If true, the ID LED is lit to visually identify the component.

Constraints

  • type = boolean

field index: Optional[StrictInt] = None

Number that identifies the relative position of a hardware component within the array.

field model: Optional[StrictStr] = None

Model number of the hardware component.

field name: Optional[StrictStr] = None

A locally unique, system-generated name. The name cannot be modified.

field serial: Optional[StrictStr] = None

Serial number of the hardware component.

field slot: Optional[StrictInt] = None

Slot number occupied by the PCI Express card that hosts the component.

field speed: Optional[StrictInt] = None

Speed (in bytes per second) at which the component is operating.

field status: Optional[StrictStr] = None

Component status. Values include critical, healthy, identifying, unhealthy, unknown, and unused.

field temperature: Optional[StrictInt] = None

Temperature (in degrees Celsius) reported by the component.

field type: Optional[StrictStr] = None

Type of hardware component. Values include bay, ct, ch, eth, fan, fb, fc, fm, ib, iom, nvb, pwr, sas, sh, and tmp.

field voltage: Optional[StrictInt] = None

Voltage (in Volts) reported by the component.

HardwareGetResponse

pydantic model pypureclient.flasharray.HardwareGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Hardware]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[Hardware]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

HardwarePatch

pydantic model pypureclient.flasharray.HardwarePatch(*, name: Optional[StrictStr] = None, identify_enabled: Optional[StrictBool] = None, index: Optional[StrictInt] = None)
field identify_enabled: Optional[StrictBool] = None

State of an LED used to visually identify the component.

Constraints

  • type = boolean

field index: Optional[StrictInt] = None

Number that identifies the relative position of a hardware component within the array.

field name: Optional[StrictStr] = None

A locally unique, system-generated name. The name cannot be modified.

HardwareResponse

pydantic model pypureclient.flasharray.HardwareResponse(*, items: Optional[ConstrainedListValue[Hardware]] = None)
field items: Optional[ConstrainedListValue[Hardware]] = None

Host

pydantic model pypureclient.flasharray.Host(*, name: Optional[StrictStr] = None, context: Optional[FixedReference] = None, chap: Optional[Chap] = None, connection_count: Optional[StrictInt] = None, destroyed: Optional[StrictBool] = None, host_group: Optional[ReferenceNoId] = None, iqns: Optional[ConstrainedListValue[StrictStr]] = None, is_local: Optional[StrictBool] = None, nqns: Optional[ConstrainedListValue[StrictStr]] = None, personality: Optional[StrictStr] = None, port_connectivity: Optional[HostPortConnectivity] = None, preferred_arrays: Optional[ConstrainedListValue[Reference]] = None, space: Optional[Space] = None, time_remaining: Optional[StrictInt] = None, vlan: Optional[StrictStr] = None, wwns: Optional[ConstrainedListValue[StrictStr]] = None)
field chap: Optional[Chap] = None
field connection_count: Optional[StrictInt] = None

The number of volumes connected to the specified host.

field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field destroyed: Optional[StrictBool] = None

Returns a value of true if the host has been destroyed with its container realm and is pending eradication. The time_remaining value displays the amount of time left until the destroyed host is permanently eradicated. Before the time_remaining period has elapsed, the destroyed host will be recovered if its container realm is recovered. Once the time_remaining period has elapsed, the host is permanently eradicated and can no longer be recovered.

Constraints

  • type = boolean

field host_group: Optional[ReferenceNoId] = None

The host group to which the host should be associated.

field iqns: Optional[ConstrainedListValue[StrictStr]] = None

The iSCSI qualified name (IQN) associated with the host.

field is_local: Optional[StrictBool] = None

If set to true, the location reference is to the local array. If set to false, the location reference is to a remote location, such as a remote array or offload target.

Constraints

  • type = boolean

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

field nqns: Optional[ConstrainedListValue[StrictStr]] = None

The NVMe Qualified Name (NQN) associated with the host.

field personality: Optional[StrictStr] = None

Determines how the system tunes the array to ensure that it works optimally with the host. Set personality to the name of the host operating system or virtual memory system. Valid values are aix, esxi, hitachi-vsp, hpux, oracle-vm-server, solaris, and vms. If your system is not listed as one of the valid host personalities, do not set the option. By default, the personality is not set.

field port_connectivity: Optional[HostPortConnectivity] = None
field preferred_arrays: Optional[ConstrainedListValue[Reference]] = None

For synchronous replication configurations, sets a host’s preferred array to specify which array exposes active/optimized paths to that host. Enter multiple preferred arrays in comma-separated format. If a preferred array is set for a host, then the other arrays in the same pod will expose active/non-optimized paths to that host. If the host is in a host group, preferred_arrays cannot be set because host groups have their own preferred arrays. On a preferred array of a certain host, all the paths on all the ports (for both the primary and secondary controllers) are set up as A/O (active/optimized) paths, while on a non-preferred array, all the paths are A/N (Active/Non-optimized) paths.

field space: Optional[Space] = None

Displays provisioned (virtual) size and physical storage consumption information for the sum of all volumes connected to the specified host.

field time_remaining: Optional[StrictInt] = None

The amount of time left until the destroyed host is permanently eradicated, measured in milliseconds.

field vlan: Optional[StrictStr] = None

The VLAN ID that the host is associated with. If set to any, the host can access any VLAN. If set to untagged, the host can only access untagged VLANs. If set to a number between 1 and 4094, the host can only access the specified VLAN with that number.

field wwns: Optional[ConstrainedListValue[StrictStr]] = None

The Fibre Channel World Wide Name (WWN) associated with the host.

HostGetResponse

pydantic model pypureclient.flasharray.HostGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Host]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[Host]] = None

Displays a list of all items after filtering. If applicable, the values are displayed for each name.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

HostGroup

pydantic model pypureclient.flasharray.HostGroup(*, name: Optional[StrictStr] = None, context: Optional[FixedReference] = None, connection_count: Optional[StrictInt] = None, destroyed: Optional[StrictBool] = None, host_count: Optional[StrictInt] = None, is_local: Optional[StrictBool] = None, space: Optional[Space] = None, time_remaining: Optional[StrictInt] = None)
field connection_count: Optional[StrictInt] = None

The number of volumes connected to the host group.

field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field destroyed: Optional[StrictBool] = None

Returns a value of true if the host group has been destroyed with its container realm and is pending eradication. The time_remaining value displays the amount of time left until the destroyed host group is permanently eradicated. Before the time_remaining period has elapsed, the destroyed host group will be recovered if its container realm is recovered. Once the time_remaining period has elapsed, the host group is permanently eradicated and can no longer be recovered.

Constraints

  • type = boolean

field host_count: Optional[StrictInt] = None

The number of hosts in the host group.

field is_local: Optional[StrictBool] = None

Returns a value of true if the host or host group belongs to the current array. Returns a value of false if the host or host group belongs to a remote array.

Constraints

  • type = boolean

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

field space: Optional[Space] = None

Displays provisioned (virtual) size and physical storage consumption information for the sum of all volumes connected to the specified host.

field time_remaining: Optional[StrictInt] = None

The amount of time left until the destroyed host group is permanently eradicated, measured in milliseconds.

HostGroupGetResponse

pydantic model pypureclient.flasharray.HostGroupGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[HostGroup]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[HostGroup]] = None

Returns a list of all items after filtering. If applicable, the values are displayed for each name.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

HostGroupPatch

pydantic model pypureclient.flasharray.HostGroupPatch(*, name: Optional[StrictStr] = None)
field name: Optional[StrictStr] = None

The new name for the resource.

HostGroupPost

pydantic model pypureclient.flasharray.HostGroupPost(*, tags: Optional[ConstrainedListValue[NonCopyableTag]] = None)
field tags: Optional[ConstrainedListValue[NonCopyableTag]] = None

The list of tags to be upserted with the object.

HostGroupResponse

pydantic model pypureclient.flasharray.HostGroupResponse(*, items: Optional[ConstrainedListValue[HostGroup]] = None)
field items: Optional[ConstrainedListValue[HostGroup]] = None

Returns a list of all items after filtering. If applicable, the values are displayed for each name.

HostPatch

pydantic model pypureclient.flasharray.HostPatch(*, name: Optional[StrictStr] = None, add_iqns: Optional[ConstrainedListValue[StrictStr]] = None, add_nqns: Optional[ConstrainedListValue[StrictStr]] = None, add_wwns: Optional[ConstrainedListValue[StrictStr]] = None, chap: Optional[Chap] = None, host_group: Optional[ReferenceNoId] = None, iqns: Optional[ConstrainedListValue[StrictStr]] = None, nqns: Optional[ConstrainedListValue[StrictStr]] = None, personality: Optional[StrictStr] = None, preferred_arrays: Optional[ConstrainedListValue[Reference]] = None, remove_iqns: Optional[ConstrainedListValue[StrictStr]] = None, remove_nqns: Optional[ConstrainedListValue[StrictStr]] = None, remove_wwns: Optional[ConstrainedListValue[StrictStr]] = None, vlan: Optional[StrictStr] = None, wwns: Optional[ConstrainedListValue[StrictStr]] = None)
field add_iqns: Optional[ConstrainedListValue[StrictStr]] = None

Adds the specified iSCSI Qualified Names (IQNs) to those already associated with the specified host.

field add_nqns: Optional[ConstrainedListValue[StrictStr]] = None

Adds the specified NVMe Qualified Names (NQNs) to those already associated with the specified host.

field add_wwns: Optional[ConstrainedListValue[StrictStr]] = None

Adds the specified Fibre Channel World Wide Names (WWNs) to those already associated with the specified host.

field chap: Optional[Chap] = None
field host_group: Optional[ReferenceNoId] = None

The host group to which the host should be associated.

field iqns: Optional[ConstrainedListValue[StrictStr]] = None

The iSCSI qualified name (IQN) associated with the host.

field name: Optional[StrictStr] = None

The new name for the resource.

field nqns: Optional[ConstrainedListValue[StrictStr]] = None

The NVMe Qualified Name (NQN) associated with the host.

field personality: Optional[StrictStr] = None

Determines how the system tunes the array to ensure that it works optimally with the host. Set personality to the name of the host operating system or virtual memory system. Valid values are aix, esxi, hitachi-vsp, hpux, oracle-vm-server, solaris, and vms. If your system is not listed as one of the valid host personalities, do not set the option. By default, the personality is not set.

field preferred_arrays: Optional[ConstrainedListValue[Reference]] = None

For synchronous replication configurations, sets a host’s preferred array to specify which array exposes active/optimized paths to that host. Enter multiple preferred arrays in comma-separated format. If a preferred array is set for a host, then the other arrays in the same pod will expose active/non-optimized paths to that host. If the host is in a host group, preferred_arrays cannot be set because host groups have their own preferred arrays. On a preferred array of a certain host, all the paths on all the ports (for both the primary and secondary controllers) are set up as A/O (active/optimized) paths, while on a non-preferred array, all the paths are A/N (Active/Non-optimized) paths.

field remove_iqns: Optional[ConstrainedListValue[StrictStr]] = None

Disassociates the specified iSCSI Qualified Names (IQNs) from the specified host.

field remove_nqns: Optional[ConstrainedListValue[StrictStr]] = None

Disassociates the specified NVMe Qualified Names (NQNs) from the specified host.

field remove_wwns: Optional[ConstrainedListValue[StrictStr]] = None

Disassociates the specified Fibre Channel World Wide Names (WWNs) from the specified host.

field vlan: Optional[StrictStr] = None

The VLAN ID that the host is associated with. If not set, there is no change in VLAN. If set to any, the host can access any VLAN. If set to untagged, the host can only access untagged VLANs. If set to a number between 1 and 4094, the host can only access the specified VLAN with that number.

field wwns: Optional[ConstrainedListValue[StrictStr]] = None

The Fibre Channel World Wide Name (WWN) associated with the host.

HostPerformanceBalance

pydantic model pypureclient.flasharray.HostPerformanceBalance(*, name: Optional[StrictStr] = None, context: Optional[FixedReference] = None, fraction_relative_to_max: Optional[Union[StrictFloat, StrictInt]] = None, initiator: Optional[PortCommon] = None, op_count: Optional[StrictInt] = None, target: Optional[PortInitiatorTarget] = None, time: Optional[StrictInt] = None)
field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field fraction_relative_to_max: Optional[Union[StrictFloat, StrictInt]] = None

The path with the highest number of operation counts is displayed with a fraction_relative_to_max of 1.0. The fraction values of all other paths in the host are then calculated relative to the path with the highest number of operation counts.

field initiator: Optional[PortCommon] = None
field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

field op_count: Optional[StrictInt] = None

Count of I/O operations for the host path, over the specified resolution.

field target: Optional[PortInitiatorTarget] = None
field time: Optional[StrictInt] = None

Sample time in milliseconds since UNIX epoch.

HostPerformanceBalanceGetResponse

pydantic model pypureclient.flasharray.HostPerformanceBalanceGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None, items: Optional[ConstrainedListValue[HostPerformanceBalance]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[HostPerformanceBalance]] = None

A list of entries indicating count and percentage of I/O operations across various data paths between the host and the array.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

HostPortConnectivity

pydantic model pypureclient.flasharray.HostPortConnectivity(*, details: Optional[StrictStr] = None, status: Optional[StrictStr] = None)

The connectivity status between the host and the ports on each controller.

field details: Optional[StrictStr] = None

The host connection status. Values include Redundant, N/A, Redundant-Failover, Uneven, Unused Port, Single Controller, Single Controller-Failover, and None.

field status: Optional[StrictStr] = None

The host connection health status. Values include healthy, unhealthy, and critical.

HostPost

pydantic model pypureclient.flasharray.HostPost(*, chap: Optional[Chap] = None, iqns: Optional[ConstrainedListValue[StrictStr]] = None, nqns: Optional[ConstrainedListValue[StrictStr]] = None, personality: Optional[StrictStr] = None, preferred_arrays: Optional[ConstrainedListValue[Reference]] = None, tags: Optional[ConstrainedListValue[NonCopyableTag]] = None, vlan: Optional[StrictStr] = None, wwns: Optional[ConstrainedListValue[StrictStr]] = None)
field chap: Optional[Chap] = None
field iqns: Optional[ConstrainedListValue[StrictStr]] = None

The iSCSI qualified name (IQN) associated with the host.

field nqns: Optional[ConstrainedListValue[StrictStr]] = None

The NVMe Qualified Name (NQN) associated with the host.

field personality: Optional[StrictStr] = None

Determines how the system tunes the array to ensure that it works optimally with the host. Set personality to the name of the host operating system or virtual memory system. Valid values are aix, esxi, hitachi-vsp, hpux, oracle-vm-server, solaris, and vms. If your system is not listed as one of the valid host personalities, do not set the option. By default, the personality is not set.

field preferred_arrays: Optional[ConstrainedListValue[Reference]] = None

For synchronous replication configurations, sets a host’s preferred array to specify which array exposes active/optimized paths to that host. Enter multiple preferred arrays in comma-separated format. If a preferred array is set for a host, then the other arrays in the same pod will expose active/non-optimized paths to that host. If the host is in a host group, preferred_arrays cannot be set because host groups have their own preferred arrays. On a preferred array of a certain host, all the paths on all the ports (for both the primary and secondary controllers) are set up as A/O (active/optimized) paths, while on a non-preferred array, all the paths are A/N (Active/Non-optimized) paths.

field tags: Optional[ConstrainedListValue[NonCopyableTag]] = None

The list of tags to be upserted with the object.

field vlan: Optional[StrictStr] = None

The VLAN ID that the host is associated with. If not set or set to any, the host can access any VLAN. If set to untagged, the host can only access untagged VLANs. If set to a number between 1 and 4094, the host can only access the specified VLAN with that number.

field wwns: Optional[ConstrainedListValue[StrictStr]] = None

The Fibre Channel World Wide Name (WWN) associated with the host.

HostResponse

pydantic model pypureclient.flasharray.HostResponse(*, items: Optional[ConstrainedListValue[Host]] = None)
field items: Optional[ConstrainedListValue[Host]] = None

Displays a list of all items after filtering. If applicable, the values are displayed for each name.

Kmip

pydantic model pypureclient.flasharray.Kmip(*, ca_certificate: Optional[ConstrainedStrValue] = None, certificate: Optional[KmipCertificate] = None, kmip_objects: Optional[ConstrainedListValue[KmipObject]] = None, name: Optional[StrictStr] = None, uris: Optional[ConstrainedListValue[StrictStr]] = None)

A built-in resource. Many are singletons predefined by Purity (e.g., support settings). Some correspond to a piece of software, like an app, or hardware, like a controller. Others are created by the system in response to some event (e.g., alerts, audit records). Typically, a user can’t create, delete or rename a built-in resource. A few can be created or deleted, but not renamed because the names are meaningful to Purity (e.g., VIFs, file systems, file system snapshots, volume snapshot).

field ca_certificate: Optional[ConstrainedStrValue] = None

CA certificate text for the KMIP server.

Constraints

  • maxLength = 3000

field certificate: Optional[KmipCertificate] = None

The certificate used to verify FlashArray authenticity to the KMIP servers.

field kmip_objects: Optional[ConstrainedListValue[KmipObject]] = None

List of the name and UID of the KMIP objects.

field name: Optional[StrictStr] = None

A locally unique, system-generated name. The name cannot be modified.

field uris: Optional[ConstrainedListValue[StrictStr]] = None

List of URIs for the configured KMIP servers.

KmipCertificate

pydantic model pypureclient.flasharray.KmipCertificate(*, name: Optional[StrictStr] = None)
field name: Optional[StrictStr] = None

The resource name, such as volume name, pod name, snapshot name, and so on.

KmipGetResponse

pydantic model pypureclient.flasharray.KmipGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Kmip]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[Kmip]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

KmipObject

pydantic model pypureclient.flasharray.KmipObject(*, name: Optional[StrictStr] = None, uid: Optional[StrictStr] = None)
field name: Optional[StrictStr] = None

Name of the KMIP object.

field uid: Optional[StrictStr] = None

User ID of the KMIP object.

KmipPatch

pydantic model pypureclient.flasharray.KmipPatch(*, ca_certificate: Optional[ConstrainedStrValue] = None, certificate: Optional[ReferenceNoId] = None, uris: Optional[ConstrainedListValue[StrictStr]] = None)
field ca_certificate: Optional[ConstrainedStrValue] = None

The text of the CA certificate for the KMIP server.

Constraints

  • maxLength = 3000

field certificate: Optional[ReferenceNoId] = None

The certificate used to verify FlashArray authenticity to the KMIP servers.

field uris: Optional[ConstrainedListValue[StrictStr]] = None

List of URIs for the configured KMIP servers.

KmipPost

pydantic model pypureclient.flasharray.KmipPost(*, ca_certificate: Optional[ConstrainedStrValue] = None, certificate: Optional[ReferenceNoId] = None, uris: Optional[ConstrainedListValue[StrictStr]] = None)
field ca_certificate: Optional[ConstrainedStrValue] = None

The text of the CA certificate for the KMIP server.

Constraints

  • maxLength = 3000

field certificate: Optional[ReferenceNoId] = None

The certificate used to verify FlashArray authenticity to the KMIP servers.

field uris: Optional[ConstrainedListValue[StrictStr]] = None

List of URIs for the configured KMIP servers.

KmipResponse

pydantic model pypureclient.flasharray.KmipResponse(*, items: Optional[ConstrainedListValue[Kmip]] = None)
field items: Optional[ConstrainedListValue[Kmip]] = None

KmipTestResult

pydantic model pypureclient.flasharray.KmipTestResult(*, component_address: Optional[StrictStr] = None, component_name: Optional[StrictStr] = None, description: Optional[StrictStr] = None, destination: Optional[StrictStr] = None, enabled: Optional[StrictBool] = None, result_details: Optional[StrictStr] = None, success: Optional[StrictBool] = None, test_type: Optional[StrictStr] = None)
field component_address: Optional[StrictStr] = None

Address of the component running the test.

field component_name: Optional[StrictStr] = None

Name of the component running the test.

field description: Optional[StrictStr] = None

Description of what is being tested.

field destination: Optional[StrictStr] = None

The URI of the target server being tested.

field enabled: Optional[StrictBool] = None

Expresses whether the service is enabled or not.

Constraints

  • type = boolean

field result_details: Optional[StrictStr] = None

Additional information about the test result.

field success: Optional[StrictBool] = None

Expresses whether communication between the FlashArray and the KMIP server succeeded or not.

Constraints

  • type = boolean

field test_type: Optional[StrictStr] = None

Description of what is being tested.

KmipTestResultGetResponse

pydantic model pypureclient.flasharray.KmipTestResultGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[KmipTestResult]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[KmipTestResult]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

LimitedBy

pydantic model pypureclient.flasharray.LimitedBy(*, member: Optional[FixedReferenceWithType] = None, policy: Optional[FixedReferenceWithType] = None)
field member: Optional[FixedReferenceWithType] = None

Reference to the resource to which the effective quota policy is attached.

field policy: Optional[FixedReferenceWithType] = None

Reference to the effective quota policy.

LocalGroup

pydantic model pypureclient.flasharray.LocalGroup(*, built_in: Optional[StrictBool] = None, email: Optional[StrictStr] = None, gid: Optional[StrictInt] = None, name: Optional[StrictStr] = None, sid: Optional[StrictStr] = None)
field built_in: Optional[StrictBool] = None

Returns a value of true if the local group is built in. Returns a value of false if the group has been created manually.

Constraints

  • type = boolean

field email: Optional[StrictStr] = None

The email address of the local group.

field gid: Optional[StrictInt] = None

The POSIX user ID of this object (group ID).

field name: Optional[StrictStr] = None

The local group name.

field sid: Optional[StrictStr] = None

The SID (security ID) of the local group.

LocalGroupGetResponse

pydantic model pypureclient.flasharray.LocalGroupGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[LocalGroup]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[LocalGroup]] = None

Displays a list of all items after filtering. The values are displayed for each name, if meaningful.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

LocalGroupMembershipPost

pydantic model pypureclient.flasharray.LocalGroupMembershipPost(*, members: Optional[ConstrainedListValue[LocalgroupmembershippostMembers]] = None)
field members: Optional[ConstrainedListValue[LocalgroupmembershippostMembers]] = None

A list of resources to be a member of the group.

LocalGroupPost

pydantic model pypureclient.flasharray.LocalGroupPost(*, email: Optional[StrictStr] = None, gid: Optional[StrictInt] = None)
field email: Optional[StrictStr] = None

Optional field to set the email address of the local group.

field gid: Optional[StrictInt] = None

Optional field to set the GID of the local group.

LocalGroupResponse

pydantic model pypureclient.flasharray.LocalGroupResponse(*, items: Optional[ConstrainedListValue[LocalGroup]] = None)
field items: Optional[ConstrainedListValue[LocalGroup]] = None

Displays a list of all items after filtering. The values are displayed for each name, if meaningful.

LocalMember

pydantic model pypureclient.flasharray.LocalMember(*, group: Optional[FixedReferenceWithType] = None, group_gid: Optional[StrictInt] = None, is_primary_group: Optional[StrictBool] = None, member: Optional[FixedReferenceWithType] = None, member_id: Optional[StrictInt] = None)
field group: Optional[FixedReferenceWithType] = None

Reference to the group to which the member belongs.

field group_gid: Optional[StrictInt] = None

GID of the group to which the member belongs.

field is_primary_group: Optional[StrictBool] = None

When a membership of member_type has the value User, this specifies whether this membership is a primary-group mapping or not. In any other case, this field will be false.

Constraints

  • type = boolean

field member: Optional[FixedReferenceWithType] = None

Reference to the member of the group.

field member_id: Optional[StrictInt] = None

GID if the member_type is Group and UID if the member_type is User.

LocalMembershipGetResponse

pydantic model pypureclient.flasharray.LocalMembershipGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[LocalMember]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[LocalMember]] = None

Displays a list of all items after filtering. The values are displayed for each name, if meaningful.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

LocalMembershipResponse

pydantic model pypureclient.flasharray.LocalMembershipResponse(*, items: Optional[ConstrainedListValue[LocalMember]] = None)
field items: Optional[ConstrainedListValue[LocalMember]] = None

Displays a list of all items after filtering. The values are displayed for each name, if meaningful.

LocalUser

pydantic model pypureclient.flasharray.LocalUser(*, built_in: Optional[StrictBool] = None, email: Optional[StrictStr] = None, enabled: Optional[StrictBool] = None, name: Optional[StrictStr] = None, primary_group: Optional[ReferenceWithType] = None, sid: Optional[StrictStr] = None, uid: Optional[StrictInt] = None)
field built_in: Optional[StrictBool] = None

Returns a value of true if the local user is built in. Otherwise returns a value of false if the user has been created manually.

Constraints

  • type = boolean

field email: Optional[StrictStr] = None

The email address of the local user.

field enabled: Optional[StrictBool] = None

Returns a value of true if the local user is enabled.

Constraints

  • type = boolean

field name: Optional[StrictStr] = None

The name of the local user.

field primary_group: Optional[ReferenceWithType] = None

Primary group of the local user.

field sid: Optional[StrictStr] = None

The SID (security ID) of the local user.

field uid: Optional[StrictInt] = None

The POSIX user ID of this object (user ID).

LocalUserGetResponse

pydantic model pypureclient.flasharray.LocalUserGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[LocalUser]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[LocalUser]] = None

Displays a list of all items after filtering. The values are displayed for each name, if meaningful.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

LocalUserMembershipPost

pydantic model pypureclient.flasharray.LocalUserMembershipPost(*, groups: Optional[ConstrainedListValue[LocalusermembershippostGroups]] = None, is_primary: Optional[StrictBool] = False)
field groups: Optional[ConstrainedListValue[LocalusermembershippostGroups]] = None

A list of groups of which the user is a member.

field is_primary: Optional[StrictBool] = False

Determines whether memberships are primary group memberships or not.

Constraints

  • type = boolean

LocalUserPatch

pydantic model pypureclient.flasharray.LocalUserPatch(*, email: Optional[StrictStr] = None, enabled: Optional[StrictBool] = None, name: Optional[StrictStr] = None, password: Optional[StrictStr] = None, primary_group: Optional[ReferenceWithType] = None, uid: Optional[StrictInt] = None)
field email: Optional[StrictStr] = None

Optional field to set the email of the local user.

field enabled: Optional[StrictBool] = None

If this field is false, the local user will be disabled on creation. Otherwise, the local user will be enabled and functional from the beginning.

Constraints

  • type = boolean

field name: Optional[StrictStr] = None

The local user name.

field password: Optional[StrictStr] = None

The password of the local user. This field is only required if the enabled field is true.

field primary_group: Optional[ReferenceWithType] = None

Local group that would be assigned as the primary group of the local user.

field uid: Optional[StrictInt] = None

Optional field to set the UID of the local user.

LocalUserPost

pydantic model pypureclient.flasharray.LocalUserPost(*, email: Optional[StrictStr] = None, enabled: Optional[StrictBool] = None, password: Optional[StrictStr] = None, primary_group: Optional[ReferenceWithType] = None, uid: Optional[StrictInt] = None)
field email: Optional[StrictStr] = None

Optional field to set the email of the local user.

field enabled: Optional[StrictBool] = None

If this field is false, the local user will be disabled on creation. Otherwise, the local user will be enabled and functional.

Constraints

  • type = boolean

field password: Optional[StrictStr] = None

The password of the local user. This field is only required if the enabled field is true.

field primary_group: Optional[ReferenceWithType] = None

Local group that would be assigned as the primary group of the local user.

field uid: Optional[StrictInt] = None

Optional field to set the UID of the local user.

LocalUserResponse

pydantic model pypureclient.flasharray.LocalUserResponse(*, items: Optional[ConstrainedListValue[LocalUser]] = None)
field items: Optional[ConstrainedListValue[LocalUser]] = None

Displays a list of all items after filtering. The values are displayed for each name, if meaningful.

LocalgroupmembershippostMembers

pydantic model pypureclient.flasharray.LocalgroupmembershippostMembers(*, member: Optional[ReferenceWithType] = None, member_id: Optional[StrictInt] = None)
field member: Optional[ReferenceWithType] = None

Reference to the resource that will be a member of the group. The id or name parameter is required, but cannot be set together.

field member_id: Optional[StrictInt] = None

The member ID that should be mapped.

LocalusermembershippostGroups

pydantic model pypureclient.flasharray.LocalusermembershippostGroups(*, group: Optional[ReferenceWithType] = None, group_gid: Optional[StrictInt] = None)
field group: Optional[ReferenceWithType] = None

Reference to a group of which the user is a member. The id or name parameter is required, but cannot be set together.

field group_gid: Optional[StrictInt] = None

The group GID that should be mapped.

LocationReference

pydantic model pypureclient.flasharray.LocationReference(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, is_local: Optional[StrictBool] = None)
field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified.

field is_local: Optional[StrictBool] = None

If set to true, the location reference is to the local array. If set to false, the location reference is to a remote location, such as a remote array or offload target.

Constraints

  • type = boolean

field name: Optional[StrictStr] = None

The resource name, such as volume name, pod name, snapshot name, and so on.

LogTarget

pydantic model pypureclient.flasharray.LogTarget(*, name: Optional[StrictStr] = None, context: Optional[FixedReference] = None, target_type: Optional[StrictStr] = None)
field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and cannot be changed.

field target_type: Optional[StrictStr] = None

The type of log target. Valid values include file, and syslog.

LogTargetFile

pydantic model pypureclient.flasharray.LogTargetFile(*, name: Optional[StrictStr] = None, context: Optional[FixedReference] = None, target_type: Optional[StrictStr] = None, directory: Optional[ReferenceWithType] = None, keep_for: Optional[ConstrainedIntValue] = None, keep_size: Optional[ConstrainedIntValue] = None)
field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field directory: Optional[ReferenceWithType] = None

Directory name to be used as log target.

field keep_for: Optional[ConstrainedIntValue] = None

Specifies the period that audit logs are retained before they are deleted, in milliseconds. Default value is null which means size based retention does not apply. Use 0 to reset the value to null. At least one of the keep_for or keep_size parameters is required, and they can be set together.

Constraints

  • minimum = 86400000

field keep_size: Optional[ConstrainedIntValue] = None

Specifies the maximum size of audit logs to be retained. Measured in bytes. When exceeded, older logs will be deleted. Default value is null which means size-based retention does not apply. Use 0 to reset the value to null.

Constraints

  • minimum = 1000000

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and cannot be changed.

field target_type: Optional[StrictStr] = None

The type of log target. Valid values include file, and syslog.

LogTargetFileGetResponse

pydantic model pypureclient.flasharray.LogTargetFileGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[LogTargetFile]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[LogTargetFile]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

LogTargetFileResponse

pydantic model pypureclient.flasharray.LogTargetFileResponse(*, items: Optional[ConstrainedListValue[LogTargetFile]] = None)
field items: Optional[ConstrainedListValue[LogTargetFile]] = None

LogTargetsGetResponse

pydantic model pypureclient.flasharray.LogTargetsGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[LogTarget]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[LogTarget]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

LogTargetsResponse

pydantic model pypureclient.flasharray.LogTargetsResponse(*, items: Optional[ConstrainedListValue[LogTarget]] = None)
field items: Optional[ConstrainedListValue[LogTarget]] = None

MaintenanceWindow

pydantic model pypureclient.flasharray.MaintenanceWindow(*, name: Optional[StrictStr] = None, created: Optional[StrictInt] = None, expires: Optional[StrictInt] = None)
field created: Optional[StrictInt] = None

The maintenance window start time, measured in milliseconds since the UNIX epoch.

field expires: Optional[StrictInt] = None

The maintenance window end time, measured in milliseconds since the UNIX epoch.

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

MaintenanceWindowPost

pydantic model pypureclient.flasharray.MaintenanceWindowPost(*, timeout: Optional[StrictInt] = None)
field timeout: Optional[StrictInt] = None

The specified length of time that alerts are suppressed during a maintenance window, measured in milliseconds. The maintenance window timeout value must be between 60000 (1 minute) and 86400000 (24 hours). The value entered is rounded down to the nearest minute. The names and timeout parameters must be set together, and the names parameter must be set to environment.

MaintenanceWindowsGetResponse

pydantic model pypureclient.flasharray.MaintenanceWindowsGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[MaintenanceWindow]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[MaintenanceWindow]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

MaintenanceWindowsResponse

pydantic model pypureclient.flasharray.MaintenanceWindowsResponse(*, items: Optional[ConstrainedListValue[MaintenanceWindow]] = None)
field items: Optional[ConstrainedListValue[MaintenanceWindow]] = None

MappingPolicy

pydantic model pypureclient.flasharray.MappingPolicy(*, id: Optional[StrictStr] = None, context: Optional[FixedReference] = None, direction: Optional[StrictStr] = None, local_policy: Optional[ReferenceWithType] = None, mapping: Optional[StrictStr] = None, pod_replica_link: Optional[PodReplicaLinkReference] = None, policy_type: Optional[StrictStr] = None, remote_policy: Optional[ReferenceWithType] = None)
field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field direction: Optional[StrictStr] = None

The direction of replication. Valid values include inbound and outbound.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field local_policy: Optional[ReferenceWithType] = None

Reference to a local policy.

field mapping: Optional[StrictStr] = None

The mapping for this policy mapping. Valid values are connected and disconnected.

Reference to a pod replica link.

field policy_type: Optional[StrictStr] = None

The type of policies involved in this policy mapping.

field remote_policy: Optional[ReferenceWithType] = None

Reference to a remote policy.

MappingPolicyPatch

pydantic model pypureclient.flasharray.MappingPolicyPatch(*, mapping: Optional[StrictStr] = None)
field mapping: Optional[StrictStr] = None

The mapping to set on this policy mapping. Valid values are connected and disconnected.

Member

pydantic model pypureclient.flasharray.Member(*, context: Optional[FixedReference] = None, group: Optional[Reference] = None, member: Optional[Reference] = None)
field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field group: Optional[Reference] = None
field member: Optional[Reference] = None

MemberGetResponse

pydantic model pypureclient.flasharray.MemberGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Member]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[Member]] = None

Displays a list of all items after filtering. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

MemberNoIdAll

pydantic model pypureclient.flasharray.MemberNoIdAll(*, context: Optional[FixedReference] = None, group: Optional[ReferenceNoId] = None, member: Optional[ReferenceNoId] = None)
field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field group: Optional[ReferenceNoId] = None

The resource in which the host, volume, or other item in the environment is a member.

field member: Optional[ReferenceNoId] = None

The member of the resource.

MemberNoIdAllGetResponse

pydantic model pypureclient.flasharray.MemberNoIdAllGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[MemberNoIdAll]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[MemberNoIdAll]] = None

Displays a list of all items after filtering. The values are displayed for each name where meaningful.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

MemberNoIdAllResponse

pydantic model pypureclient.flasharray.MemberNoIdAllResponse(*, items: Optional[ConstrainedListValue[MemberNoIdAll]] = None)
field items: Optional[ConstrainedListValue[MemberNoIdAll]] = None

Displays a list of all items after filtering. The values are displayed for each name where meaningful.

MemberNoIdGroup

pydantic model pypureclient.flasharray.MemberNoIdGroup(*, group: Optional[ReferenceNoId] = None, member: Optional[Reference] = None)
field group: Optional[ReferenceNoId] = None
field member: Optional[Reference] = None

MemberNoIdMember

pydantic model pypureclient.flasharray.MemberNoIdMember(*, context: Optional[FixedReference] = None, group: Optional[Reference] = None, member: Optional[ReferenceNoId] = None)
field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field group: Optional[Reference] = None

The resource in which the host, volume, or other item in the environment is a member.

field member: Optional[ReferenceNoId] = None

The member of the resource.

MemberNoIdMemberGetResponse

pydantic model pypureclient.flasharray.MemberNoIdMemberGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[MemberNoIdMember]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[MemberNoIdMember]] = None

Displays a list of all items after filtering. The values are displayed for each name, if meaningful.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

MemberNoIdMemberResponse

pydantic model pypureclient.flasharray.MemberNoIdMemberResponse(*, items: Optional[ConstrainedListValue[MemberNoIdMember]] = None)
field items: Optional[ConstrainedListValue[MemberNoIdMember]] = None

Displays a list of all items after filtering. The values are displayed for each name, if meaningful.

MemberResponse

pydantic model pypureclient.flasharray.MemberResponse(*, items: Optional[ConstrainedListValue[Member]] = None)
field items: Optional[ConstrainedListValue[Member]] = None

Displays a list of all items after filtering. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

MemberWithType

pydantic model pypureclient.flasharray.MemberWithType(*, group: Optional[ReferenceWithType] = None, member: Optional[ReferenceWithType] = None)
field group: Optional[ReferenceWithType] = None
field member: Optional[ReferenceWithType] = None

NetworkInterface

pydantic model pypureclient.flasharray.NetworkInterface(*, name: Optional[StrictStr] = None, enabled: Optional[StrictBool] = None, eth: Optional[NetworkInterfaceEth] = None, fc: Optional[NetworkInterfaceFc] = None, interface_type: Optional[StrictStr] = None, services: Optional[ConstrainedListValue[StrictStr]] = None, speed: Optional[StrictInt] = None)
field enabled: Optional[StrictBool] = None

Returns a value of true if the specified network interface or Fibre Channel port is enabled. Returns a value of false if the specified network interface or Fibre Channel port is disabled.

Constraints

  • type = boolean

field eth: Optional[NetworkInterfaceEth] = None
field fc: Optional[NetworkInterfaceFc] = None
field interface_type: Optional[StrictStr] = None

The interface type. Valid values are eth and fc.

field name: Optional[StrictStr] = None

A locally unique, system-generated name. The name cannot be modified.

field services: Optional[ConstrainedListValue[StrictStr]] = None

The services provided by the specified network interface or Fibre Channel port.

field speed: Optional[StrictInt] = None

Configured speed of the specified network interface or Fibre Channel port (in Gb/s). Typically this is the maximum speed of the port or bond represented by the network interface.

NetworkInterfaceEth

pydantic model pypureclient.flasharray.NetworkInterfaceEth(*, address: Optional[StrictStr] = None, gateway: Optional[StrictStr] = None, mac_address: Optional[StrictStr] = None, mtu: Optional[StrictInt] = None, netmask: Optional[StrictStr] = None, subinterfaces: Optional[ConstrainedListValue[FixedReferenceNoId]] = None, subnet: Optional[ReferenceNoId] = None, subtype: Optional[StrictStr] = None, vlan: Optional[StrictInt] = None)

Ethernet network interface properties.

field address: Optional[StrictStr] = None

The IPv4 or IPv6 address to be associated with the specified network interface.

field gateway: Optional[StrictStr] = None

The IPv4 or IPv6 address of the gateway through which the specified network interface is to communicate with the network.

field mac_address: Optional[StrictStr] = None

The media access control address associated with the specified network interface.

field mtu: Optional[StrictInt] = None

Maximum message transfer unit (packet) size for the network interface, in bytes. MTU setting cannot exceed the MTU of the corresponding physical interface.

field netmask: Optional[StrictStr] = None

Netmask of the specified network interface that, when combined with the address of the interface, determines the network address of the interface.

field subinterfaces: Optional[ConstrainedListValue[FixedReferenceNoId]] = None

List of network interfaces configured to be a subinterface of the specified network interface.

field subnet: Optional[ReferenceNoId] = None

Subnet that is associated with the specified network interface.

field subtype: Optional[StrictStr] = None

The subtype of the specified network interface. Only interfaces of subtype virtual can be created. Configurable on POST only. Valid values are failover_bond, lacp_bond, physical, and virtual.

field vlan: Optional[StrictInt] = None

VLAN ID

NetworkInterfaceFc

pydantic model pypureclient.flasharray.NetworkInterfaceFc(*, wwn: Optional[StrictStr] = None)

Fibre Channel port properties.

field wwn: Optional[StrictStr] = None

World Wide Name of the specified Fibre Channel port.

NetworkInterfaceGetResponse

pydantic model pypureclient.flasharray.NetworkInterfaceGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[NetworkInterface]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[NetworkInterface]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

NetworkInterfaceNeighbor

pydantic model pypureclient.flasharray.NetworkInterfaceNeighbor(*, initial_ttl_in_sec: Optional[StrictInt] = None, local_port: Optional[FixedReferenceNoId] = None, neighbor_chassis: Optional[NetworkInterfaceNeighborNeighborChassis] = None, neighbor_port: Optional[NetworkInterfaceNeighborNeighborPort] = None)
field initial_ttl_in_sec: Optional[StrictInt] = None

The initial time to live in seconds from when the local port received notice that the neighbor information is regarded as valid. The time is not measured from when this endpoint was queried.

field local_port: Optional[FixedReferenceNoId] = None

A reference to the local network interface the neighbor is connected to.

field neighbor_chassis: Optional[NetworkInterfaceNeighborNeighborChassis] = None
field neighbor_port: Optional[NetworkInterfaceNeighborNeighborPort] = None

NetworkInterfaceNeighborCapability

pydantic model pypureclient.flasharray.NetworkInterfaceNeighborCapability(*, enabled: Optional[StrictBool] = None, supported: Optional[StrictBool] = None)
field enabled: Optional[StrictBool] = None

If true, this capability is enabled by this neighbor; false otherwise.

Constraints

  • type = boolean

field supported: Optional[StrictBool] = None

If true, this capability is supported by this neighbor; false otherwise.

Constraints

  • type = boolean

NetworkInterfaceNeighborGetResponse

pydantic model pypureclient.flasharray.NetworkInterfaceNeighborGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[NetworkInterfaceNeighbor]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[NetworkInterfaceNeighbor]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

NetworkInterfaceNeighborNeighborChassis

pydantic model pypureclient.flasharray.NetworkInterfaceNeighborNeighborChassis(*, addresses: Optional[ConstrainedListValue[StrictStr]] = None, bridge: Optional[NetworkInterfaceNeighborCapability] = None, description: Optional[StrictStr] = None, docsis_cable_device: Optional[NetworkInterfaceNeighborCapability] = None, id: Optional[NetworkInterfaceNeighborNeighborChassisId] = None, name: Optional[StrictStr] = None, repeater: Optional[NetworkInterfaceNeighborCapability] = None, router: Optional[NetworkInterfaceNeighborCapability] = None, station_only: Optional[NetworkInterfaceNeighborCapability] = None, telephone: Optional[NetworkInterfaceNeighborCapability] = None, wlan_access_point: Optional[NetworkInterfaceNeighborCapability] = None)

The neighboring physical component incorporating one or more IEEE 802 LAN stations and their associated application functionality.

field addresses: Optional[ConstrainedListValue[StrictStr]] = None

Management IP addresses of the neighbor.

field bridge: Optional[NetworkInterfaceNeighborCapability] = None

Bridge capability of the neighbor system.

field description: Optional[StrictStr] = None

The textual description of the neighbor. The description may include the full name and version identification of the system hardware type, software operating system, and networking software.

field docsis_cable_device: Optional[NetworkInterfaceNeighborCapability] = None

DOCSIS cable device capability of the neighbor system.

field id: Optional[NetworkInterfaceNeighborNeighborChassisId] = None
field name: Optional[StrictStr] = None

Administratively assigned name of the neighbour.

field repeater: Optional[NetworkInterfaceNeighborCapability] = None

Neighbor system’s repeater capability.

field router: Optional[NetworkInterfaceNeighborCapability] = None

IP router capability of the neighbor system.

field station_only: Optional[NetworkInterfaceNeighborCapability] = None

Station only status of the neighbor system.

field telephone: Optional[NetworkInterfaceNeighborCapability] = None

Telephone capability of the neighbor system.

field wlan_access_point: Optional[NetworkInterfaceNeighborCapability] = None

WLAN access point capability of the neighbor system.

NetworkInterfaceNeighborNeighborChassisId

pydantic model pypureclient.flasharray.NetworkInterfaceNeighborNeighborChassisId(*, type: Optional[StrictStr] = None, value: Optional[StrictStr] = None)

An administratively assigned identifier of the particular neighboring chassis.

field type: Optional[StrictStr] = None

The chassis ID subtype. Valid values are ifname, ifalias, local, mac, ip, and unhandled.

field value: Optional[StrictStr] = None

The specific identifier for the particular chassis.

NetworkInterfaceNeighborNeighborPort

pydantic model pypureclient.flasharray.NetworkInterfaceNeighborNeighborPort(*, description: Optional[StrictStr] = None, id: Optional[NetworkInterfaceNeighborNeighborPortId] = None)

The neighboring port connected to the FlashArray local port.

field description: Optional[StrictStr] = None

A description of the neighbor port.

field id: Optional[NetworkInterfaceNeighborNeighborPortId] = None

NetworkInterfaceNeighborNeighborPortId

pydantic model pypureclient.flasharray.NetworkInterfaceNeighborNeighborPortId(*, type: Optional[StrictStr] = None, value: Optional[StrictStr] = None)

An administratively assigned identifier of the particular neighboring port.

field type: Optional[StrictStr] = None

The port ID subtype. Valid values are ifname, ifalias, local, mac, ip, and unhandled.

field value: Optional[StrictStr] = None

The specific identifier for the particular port.

NetworkInterfaceNeighborResponse

pydantic model pypureclient.flasharray.NetworkInterfaceNeighborResponse(*, items: Optional[ConstrainedListValue[NetworkInterfaceNeighbor]] = None)
field items: Optional[ConstrainedListValue[NetworkInterfaceNeighbor]] = None

NetworkInterfacePatch

pydantic model pypureclient.flasharray.NetworkInterfacePatch(*, enabled: Optional[StrictBool] = None, eth: Optional[NetworkinterfacepatchEth] = None, override_npiv_check: Optional[StrictBool] = None, services: Optional[ConstrainedListValue[StrictStr]] = None)
field enabled: Optional[StrictBool] = None

Returns a value of true if the specified network interface or Fibre Channel port is enabled. Returns a value of false if the specified network interface or Fibre Channel port is disabled.

Constraints

  • type = boolean

field eth: Optional[NetworkinterfacepatchEth] = None
field override_npiv_check: Optional[StrictBool] = None

N-Port ID Virtualization (NPIV) requires a balanced configuration of Fibre Channel ports configured for SCSI on both controllers. Enabling or Disabling a Fibre Channel port configured for SCSI might cause the NPIV status to change from enabled to disabled or vice versa. Set this option to proceed with enabling or disabling the port.

Constraints

  • type = boolean

field services: Optional[ConstrainedListValue[StrictStr]] = None

The services provided by the specified network interface or Fibre Channel port.

NetworkInterfacePerformance

pydantic model pypureclient.flasharray.NetworkInterfacePerformance(*, name: Optional[StrictStr] = None, eth: Optional[NetworkInterfacePerformanceEth] = None, fc: Optional[NetworkInterfacePerformanceFc] = None, interface_type: Optional[StrictStr] = None, time: Optional[StrictInt] = None)
field eth: Optional[NetworkInterfacePerformanceEth] = None
field fc: Optional[NetworkInterfacePerformanceFc] = None
field interface_type: Optional[StrictStr] = None

The interface type. Valid values are eth and fc.

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

field time: Optional[StrictInt] = None

Sample time in milliseconds since UNIX epoch.

NetworkInterfacePerformanceEth

pydantic model pypureclient.flasharray.NetworkInterfacePerformanceEth(*, flow_control_received_congestion_packets_per_sec: Optional[ConstrainedIntValue] = None, flow_control_received_discarded_packets_per_sec: Optional[ConstrainedIntValue] = None, flow_control_received_lossless_bytes_per_sec: Optional[ConstrainedIntValue] = None, flow_control_received_pause_frames_per_sec: Optional[ConstrainedIntValue] = None, flow_control_transmitted_congestion_packets_per_sec: Optional[ConstrainedIntValue] = None, flow_control_transmitted_discarded_packets_per_sec: Optional[ConstrainedIntValue] = None, flow_control_transmitted_lossless_bytes_per_sec: Optional[ConstrainedIntValue] = None, flow_control_transmitted_pause_frames_per_sec: Optional[ConstrainedIntValue] = None, other_errors_per_sec: Optional[ConstrainedIntValue] = None, rdma_received_req_cqe_errors_per_sec: Optional[ConstrainedIntValue] = None, rdma_received_sequence_errors_per_sec: Optional[ConstrainedIntValue] = None, rdma_transmitted_local_ack_timeout_errors_per_sec: Optional[ConstrainedIntValue] = None, received_bytes_per_sec: Optional[ConstrainedIntValue] = None, received_crc_errors_per_sec: Optional[ConstrainedIntValue] = None, received_frame_errors_per_sec: Optional[ConstrainedIntValue] = None, received_packets_per_sec: Optional[ConstrainedIntValue] = None, total_errors_per_sec: Optional[ConstrainedIntValue] = None, transmitted_bytes_per_sec: Optional[ConstrainedIntValue] = None, transmitted_carrier_errors_per_sec: Optional[ConstrainedIntValue] = None, transmitted_dropped_errors_per_sec: Optional[ConstrainedIntValue] = None, transmitted_packets_per_sec: Optional[ConstrainedIntValue] = None)

Ethernet network interface statistics.

field flow_control_received_congestion_packets_per_sec: Optional[ConstrainedIntValue] = None

Number of congestion control packets received per second.

Constraints

  • minimum = 0

field flow_control_received_discarded_packets_per_sec: Optional[ConstrainedIntValue] = None

Number of received packets that were physically discarded by the NIC per second due to errors or other reasons.

Constraints

  • minimum = 0

field flow_control_received_lossless_bytes_per_sec: Optional[ConstrainedIntValue] = None

Bytes received per second with lossless flow control settings.

Constraints

  • minimum = 0

field flow_control_received_pause_frames_per_sec: Optional[ConstrainedIntValue] = None

Received pause frames per second.

Constraints

  • minimum = 0

field flow_control_transmitted_congestion_packets_per_sec: Optional[ConstrainedIntValue] = None

Number of congestion control packets transmitted per second.

Constraints

  • minimum = 0

field flow_control_transmitted_discarded_packets_per_sec: Optional[ConstrainedIntValue] = None

Number of transmitted packets that were physically discarded by the NIC per second due to errors or other reasons.

Constraints

  • minimum = 0

field flow_control_transmitted_lossless_bytes_per_sec: Optional[ConstrainedIntValue] = None

Bytes transmitted per second with lossless flow control settings.

Constraints

  • minimum = 0

field flow_control_transmitted_pause_frames_per_sec: Optional[ConstrainedIntValue] = None

Transmitted pause frames per second.

Constraints

  • minimum = 0

field other_errors_per_sec: Optional[ConstrainedIntValue] = None

This field has been deprecated. Since Purity version 6.6.8, this will always return null. The sum of unspecified reception and transmission errors per second.

Constraints

  • minimum = 0

field rdma_received_req_cqe_errors_per_sec: Optional[ConstrainedIntValue] = None

The number of times port detected RDMA CQEs with error per second.

Constraints

  • minimum = 0

field rdma_received_sequence_errors_per_sec: Optional[ConstrainedIntValue] = None

The number of received RDMA packet sequence errors per second.

Constraints

  • minimum = 0

field rdma_transmitted_local_ack_timeout_errors_per_sec: Optional[ConstrainedIntValue] = None

The number of times RDMA ack timer expired for QPs per second.

Constraints

  • minimum = 0

field received_bytes_per_sec: Optional[ConstrainedIntValue] = None

Bytes received per second.

Constraints

  • minimum = 0

field received_crc_errors_per_sec: Optional[ConstrainedIntValue] = None

Reception CRC errors per second.

Constraints

  • minimum = 0

field received_frame_errors_per_sec: Optional[ConstrainedIntValue] = None

Received packet frame errors per second.

Constraints

  • minimum = 0

field received_packets_per_sec: Optional[ConstrainedIntValue] = None

Packets received per second.

Constraints

  • minimum = 0

field total_errors_per_sec: Optional[ConstrainedIntValue] = None

The sum of all reception and transmission errors per second.

Constraints

  • minimum = 0

field transmitted_bytes_per_sec: Optional[ConstrainedIntValue] = None

Bytes transmitted per second.

Constraints

  • minimum = 0

field transmitted_carrier_errors_per_sec: Optional[ConstrainedIntValue] = None

Transmission carrier errors per second.

Constraints

  • minimum = 0

field transmitted_dropped_errors_per_sec: Optional[ConstrainedIntValue] = None

Transmitted packets dropped per second.

Constraints

  • minimum = 0

field transmitted_packets_per_sec: Optional[ConstrainedIntValue] = None

Packets transmitted per second.

Constraints

  • minimum = 0

NetworkInterfacePerformanceFc

pydantic model pypureclient.flasharray.NetworkInterfacePerformanceFc(*, received_bytes_per_sec: Optional[ConstrainedIntValue] = None, received_crc_errors_per_sec: Optional[ConstrainedIntValue] = None, received_frames_per_sec: Optional[ConstrainedIntValue] = None, received_link_failures_per_sec: Optional[ConstrainedIntValue] = None, received_loss_of_signal_per_sec: Optional[ConstrainedIntValue] = None, received_loss_of_sync_per_sec: Optional[ConstrainedIntValue] = None, total_errors_per_sec: Optional[ConstrainedIntValue] = None, transmitted_bytes_per_sec: Optional[ConstrainedIntValue] = None, transmitted_frames_per_sec: Optional[ConstrainedIntValue] = None, transmitted_invalid_words_per_sec: Optional[ConstrainedIntValue] = None)

Fibre Channel port statistics.

field received_bytes_per_sec: Optional[ConstrainedIntValue] = None

Bytes received per second.

Constraints

  • minimum = 0

field received_crc_errors_per_sec: Optional[ConstrainedIntValue] = None

Fibre Channel frame CRC errors per second.

Constraints

  • minimum = 0

field received_frames_per_sec: Optional[ConstrainedIntValue] = None

Fibre Channel frames received per second.

Constraints

  • minimum = 0

Loss of connectivity errors per second.

Constraints

  • minimum = 0

field received_loss_of_signal_per_sec: Optional[ConstrainedIntValue] = None

Loss of signal errors on Fibre Channel port per second.

Constraints

  • minimum = 0

field received_loss_of_sync_per_sec: Optional[ConstrainedIntValue] = None

Loss of sync errors on Fibre Channel port per second.

Constraints

  • minimum = 0

field total_errors_per_sec: Optional[ConstrainedIntValue] = None

The sum of all reception and transmission errors per second.

Constraints

  • minimum = 0

field transmitted_bytes_per_sec: Optional[ConstrainedIntValue] = None

Bytes transmitted per second.

Constraints

  • minimum = 0

field transmitted_frames_per_sec: Optional[ConstrainedIntValue] = None

Fibre Channel frames transmitted per second.

Constraints

  • minimum = 0

field transmitted_invalid_words_per_sec: Optional[ConstrainedIntValue] = None

Bit errors in transmission word per second.

Constraints

  • minimum = 0

NetworkInterfacePerformanceGetResponse

pydantic model pypureclient.flasharray.NetworkInterfacePerformanceGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[NetworkInterfacePerformance]] = None, total: Optional[ConstrainedListValue[NetworkInterfacePerformance]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[NetworkInterfacePerformance]] = None

A list of performance objects.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total: Optional[ConstrainedListValue[NetworkInterfacePerformance]] = None

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 field where meaningful.

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

NetworkInterfacePortDetailsRxLos

pydantic model pypureclient.flasharray.NetworkInterfacePortDetailsRxLos(*, channel: Optional[StrictInt] = None, flag: Optional[StrictBool] = None)
field channel: Optional[StrictInt] = None

The channel number if the transceiver is a multilane transceiver. If not specified, defaults to null.

field flag: Optional[StrictBool] = None

A value of true indicates Rx Loss-of-Signal.

Constraints

  • type = boolean

NetworkInterfacePortDetailsRxPower

pydantic model pypureclient.flasharray.NetworkInterfacePortDetailsRxPower(*, channel: Optional[StrictInt] = None, measurement: Optional[Union[StrictFloat, StrictInt]] = None, status: Optional[StrictStr] = None)
field channel: Optional[StrictInt] = None

The channel number if the transceiver is a multilane transceiver. If not specified, defaults to null.

field measurement: Optional[Union[StrictFloat, StrictInt]] = None

Rx input power in mW.

field status: Optional[StrictStr] = None

Indicates whether the measurement is outside the high alarm, low alarm, high warning, or low warning thresholds for Rx input power. Valid values are alarm low, alarm high, warn low, warn high, and ok.

NetworkInterfacePortDetailsStatic

pydantic model pypureclient.flasharray.NetworkInterfacePortDetailsStatic(*, cable_technology: Optional[ConstrainedListValue[StrictStr]] = None, connector_type: Optional[StrictStr] = None, encoding: Optional[StrictStr] = None, extended_identifier: Optional[StrictStr] = None, fc_link_lengths: Optional[ConstrainedListValue[StrictStr]] = None, fc_speeds: Optional[StrictStr] = None, fc_technology: Optional[ConstrainedListValue[StrictStr]] = None, fc_transmission_media: Optional[ConstrainedListValue[StrictStr]] = None, identifier: Optional[StrictStr] = None, link_length: Optional[StrictStr] = None, rate_identifier: Optional[StrictStr] = None, rx_power_thresholds: Optional[NetworkInterfacePortDetailsStaticRxPowerThresholds] = None, signaling_rate: Optional[StrictStr] = None, signaling_rate_max: Optional[StrictStr] = None, signaling_rate_min: Optional[StrictStr] = None, specifications: Optional[ConstrainedListValue[StrictStr]] = None, temperature_thresholds: Optional[NetworkInterfacePortDetailsStaticTemperatureThresholds] = None, tx_bias_thresholds: Optional[NetworkInterfacePortDetailsStaticTxBiasThresholds] = None, tx_power_thresholds: Optional[NetworkInterfacePortDetailsStaticTxPowerThresholds] = None, vendor_date_code: Optional[ConstrainedStrValue] = None, vendor_name: Optional[ConstrainedStrValue] = None, vendor_oui: Optional[ConstrainedStrValue] = None, vendor_part_number: Optional[ConstrainedStrValue] = None, vendor_revision: Optional[ConstrainedStrValue] = None, vendor_serial_number: Optional[ConstrainedStrValue] = None, voltage_thresholds: Optional[NetworkInterfacePortDetailsStaticVoltageThresholds] = None, wavelength: Optional[StrictStr] = None)

Static module identity and capabilities information for the specified network interface or Fibre Channel port.

field cable_technology: Optional[ConstrainedListValue[StrictStr]] = None

The SFP+ cable technology supported by the transceiver.

field connector_type: Optional[StrictStr] = None

The media connector type of the transceiver.

field encoding: Optional[StrictStr] = None

The serial encoding algorithm of the transceiver.

field extended_identifier: Optional[StrictStr] = None

The extended identifier of the transceiver type.

The Fibre Channel distance capabilities supported by the transceiver.

field fc_speeds: Optional[StrictStr] = None

The Fibre Channel speeds supported by the transceiver. Speeds are in units of 100 MBytes/sec, which correspond to GFC (Gb/s).

field fc_technology: Optional[ConstrainedListValue[StrictStr]] = None

The Fibre Channel technologies supported by the transceiver.

field fc_transmission_media: Optional[ConstrainedListValue[StrictStr]] = None

The Fibre Channel transmission media supported by the transceiver.

field identifier: Optional[StrictStr] = None

The transceiver type.

Link length and cable attenuation (for active or copper cables) for the specified transceiver. Values are comma-separated lists of fields and values, where each field is separated from its corresponding value by a colon. Valid fields include Copper Cable Attenuation (12.9 GHz), Copper Cable Attenuation (25.78 GHz), Copper Cable, SMF, OM2, OM1, OM4, and OM3. The unit for attenuation is dB, and the units for length are meters or kilometers. Unspecified fields are omitted.

field rate_identifier: Optional[StrictStr] = None

The type of rate select functionality of the transceiver.

field rx_power_thresholds: Optional[NetworkInterfacePortDetailsStaticRxPowerThresholds] = None
field signaling_rate: Optional[StrictStr] = None

The nominal signaling rate in MBd, rounded off to the nearest 100 MBd, or if greater than 25400 MBd, rounded off to the nearest 250 MBd. The value can be unspecified.

field signaling_rate_max: Optional[StrictStr] = None

The upper signaling rate limit at which the transceiver still meets its specifications, specified as a percentage above the nominal signaling rate. The value can be unspecified.

field signaling_rate_min: Optional[StrictStr] = None

The lower signaling rate limit at which the transceiver still meets its specifications, specified as a percentage below the nominal signaling rate. The value can be unspecified.

field specifications: Optional[ConstrainedListValue[StrictStr]] = None

The Ethernet, 10G Ethernet, ESCON, Infiniband, SONET, and other specifications supported by the transceiver.

field temperature_thresholds: Optional[NetworkInterfacePortDetailsStaticTemperatureThresholds] = None
field tx_bias_thresholds: Optional[NetworkInterfacePortDetailsStaticTxBiasThresholds] = None
field tx_power_thresholds: Optional[NetworkInterfacePortDetailsStaticTxPowerThresholds] = None
field vendor_date_code: Optional[ConstrainedStrValue] = None

The SFP vendor’s manufacturing date code. The first six characters are the date in YYMMDD format, and the last two characters are the vendor specific lot code. The last two characters are optional.

Constraints

  • maxLength = 8

field vendor_name: Optional[ConstrainedStrValue] = None

The SFP vendor name.

Constraints

  • maxLength = 16

field vendor_oui: Optional[ConstrainedStrValue] = None

The SFP vendor IEEE company ID.

Constraints

  • maxLength = 8

field vendor_part_number: Optional[ConstrainedStrValue] = None

The part number provided by the SFP vendor.

Constraints

  • maxLength = 16

field vendor_revision: Optional[ConstrainedStrValue] = None

The revision level for the part number provided by the SFP vendor.

Constraints

  • maxLength = 4

field vendor_serial_number: Optional[ConstrainedStrValue] = None

The serial number provided by the SFP vendor.

Constraints

  • maxLength = 16

field voltage_thresholds: Optional[NetworkInterfacePortDetailsStaticVoltageThresholds] = None
field wavelength: Optional[StrictStr] = None

Laser wavelength (for optical variants) at room temperature, in units of nm. For passive and active cable variants, the value is unspecified.

NetworkInterfacePortDetailsStaticRxPowerThresholds

pydantic model pypureclient.flasharray.NetworkInterfacePortDetailsStaticRxPowerThresholds(*, alarm_high: Optional[Union[StrictFloat, StrictInt]] = None, alarm_low: Optional[Union[StrictFloat, StrictInt]] = None, warn_high: Optional[Union[StrictFloat, StrictInt]] = None, warn_low: Optional[Union[StrictFloat, StrictInt]] = None)

The alarm low, warn low, warn high, alarm high thresholds for Rx input power in mW.

field alarm_high: Optional[Union[StrictFloat, StrictInt]] = None

The alarm high threshold for Rx input power in mW.

field alarm_low: Optional[Union[StrictFloat, StrictInt]] = None

The alarm low threshold for Rx input power in mW.

field warn_high: Optional[Union[StrictFloat, StrictInt]] = None

The warn high threshold for Rx input power in mW.

field warn_low: Optional[Union[StrictFloat, StrictInt]] = None

The warn low threshold for Rx input power in mW.

NetworkInterfacePortDetailsStaticTemperatureThresholds

pydantic model pypureclient.flasharray.NetworkInterfacePortDetailsStaticTemperatureThresholds(*, alarm_high: Optional[Union[StrictFloat, StrictInt]] = None, alarm_low: Optional[Union[StrictFloat, StrictInt]] = None, warn_high: Optional[Union[StrictFloat, StrictInt]] = None, warn_low: Optional[Union[StrictFloat, StrictInt]] = None)

The alarm low, warn low, warn high, alarm high thresholds for temperature in degrees Celsius.

field alarm_high: Optional[Union[StrictFloat, StrictInt]] = None

The alarm high threshold for temperature in degrees Celsius.

field alarm_low: Optional[Union[StrictFloat, StrictInt]] = None

The alarm low threshold for temperature in degrees Celsius.

field warn_high: Optional[Union[StrictFloat, StrictInt]] = None

The warn high threshold for temperature in degrees Celsius.

field warn_low: Optional[Union[StrictFloat, StrictInt]] = None

The warn low threshold for temperature in degrees Celsius.

NetworkInterfacePortDetailsStaticTxBiasThresholds

pydantic model pypureclient.flasharray.NetworkInterfacePortDetailsStaticTxBiasThresholds(*, alarm_high: Optional[Union[StrictFloat, StrictInt]] = None, alarm_low: Optional[Union[StrictFloat, StrictInt]] = None, warn_high: Optional[Union[StrictFloat, StrictInt]] = None, warn_low: Optional[Union[StrictFloat, StrictInt]] = None)

The alarm low, warn low, warn high, alarm high thresholds for Tx bias current in mA.

field alarm_high: Optional[Union[StrictFloat, StrictInt]] = None

The alarm high threshold for Tx bias current in mA.

field alarm_low: Optional[Union[StrictFloat, StrictInt]] = None

The alarm low threshold for Tx bias current in mA.

field warn_high: Optional[Union[StrictFloat, StrictInt]] = None

The warn high threshold for Tx bias current in mA.

field warn_low: Optional[Union[StrictFloat, StrictInt]] = None

The warn low threshold for Tx bias current in mA.

NetworkInterfacePortDetailsStaticTxPowerThresholds

pydantic model pypureclient.flasharray.NetworkInterfacePortDetailsStaticTxPowerThresholds(*, alarm_high: Optional[Union[StrictFloat, StrictInt]] = None, alarm_low: Optional[Union[StrictFloat, StrictInt]] = None, warn_high: Optional[Union[StrictFloat, StrictInt]] = None, warn_low: Optional[Union[StrictFloat, StrictInt]] = None)

The alarm low, warn low, warn high, alarm high thresholds for Tx output power in mW.

field alarm_high: Optional[Union[StrictFloat, StrictInt]] = None

The alarm high threshold for Tx output power in mW.

field alarm_low: Optional[Union[StrictFloat, StrictInt]] = None

The alarm low threshold for Tx output power in mW.

field warn_high: Optional[Union[StrictFloat, StrictInt]] = None

The warn high threshold for Tx output power in mW.

field warn_low: Optional[Union[StrictFloat, StrictInt]] = None

The warn low threshold for Tx output power in mW.

NetworkInterfacePortDetailsStaticVoltageThresholds

pydantic model pypureclient.flasharray.NetworkInterfacePortDetailsStaticVoltageThresholds(*, alarm_high: Optional[Union[StrictFloat, StrictInt]] = None, alarm_low: Optional[Union[StrictFloat, StrictInt]] = None, warn_high: Optional[Union[StrictFloat, StrictInt]] = None, warn_low: Optional[Union[StrictFloat, StrictInt]] = None)

The alarm low, warn low, warn high, alarm high thresholds for supply voltage (in volts).

field alarm_high: Optional[Union[StrictFloat, StrictInt]] = None

The alarm high threshold for supply voltage in volts.

field alarm_low: Optional[Union[StrictFloat, StrictInt]] = None

The alarm low threshold for supply voltage in volts.

field warn_high: Optional[Union[StrictFloat, StrictInt]] = None

The warn high threshold for supply voltage in volts.

field warn_low: Optional[Union[StrictFloat, StrictInt]] = None

The warn low threshold for supply voltage in volts.

NetworkInterfacePortDetailsTemperature

pydantic model pypureclient.flasharray.NetworkInterfacePortDetailsTemperature(*, channel: Optional[StrictInt] = None, measurement: Optional[Union[StrictFloat, StrictInt]] = None, status: Optional[StrictStr] = None)
field channel: Optional[StrictInt] = None

The channel number if the diagnostic has an associated channel number. If not specified, defaults to null.

field measurement: Optional[Union[StrictFloat, StrictInt]] = None

Temperature in degrees Celsius.

field status: Optional[StrictStr] = None

Indicates whether the measurement is outside the high alarm, low alarm, high warning, or low warning thresholds for temperature. Valid values are alarm low, alarm high, warn low, warn high, and ok.

NetworkInterfacePortDetailsTxBias

pydantic model pypureclient.flasharray.NetworkInterfacePortDetailsTxBias(*, channel: Optional[StrictInt] = None, measurement: Optional[Union[StrictFloat, StrictInt]] = None, status: Optional[StrictStr] = None)
field channel: Optional[StrictInt] = None

The channel number if the transceiver is a multilane transceiver. If not specified, defaults to null.

field measurement: Optional[Union[StrictFloat, StrictInt]] = None

Tx bias current in mA.

field status: Optional[StrictStr] = None

Indicates whether the measurement is outside the high alarm, low alarm, high warning, or low warning thresholds for Tx bias current. Valid values are alarm low, alarm high, warn low, warn high, and ok.

NetworkInterfacePortDetailsTxFault

pydantic model pypureclient.flasharray.NetworkInterfacePortDetailsTxFault(*, channel: Optional[StrictInt] = None, flag: Optional[StrictBool] = None)
field channel: Optional[StrictInt] = None

The channel number if the transceiver is a multilane transceiver. If not specified, defaults to null.

field flag: Optional[StrictBool] = None

A value of true indicates transmitter/laser fault.

Constraints

  • type = boolean

NetworkInterfacePortDetailsTxPower

pydantic model pypureclient.flasharray.NetworkInterfacePortDetailsTxPower(*, channel: Optional[StrictInt] = None, measurement: Optional[Union[StrictFloat, StrictInt]] = None, status: Optional[StrictStr] = None)
field channel: Optional[StrictInt] = None

The channel number if the transceiver is a multilane transceiver. If not specified, defaults to null.

field measurement: Optional[Union[StrictFloat, StrictInt]] = None

Tx output power in mW.

field status: Optional[StrictStr] = None

Indicates whether the measurement is outside the high alarm, low alarm, high warning, or low warning thresholds for Tx output power. Valid values are alarm low, alarm high, warn low, warn high, and ok.

NetworkInterfacePortDetailsVoltage

pydantic model pypureclient.flasharray.NetworkInterfacePortDetailsVoltage(*, channel: Optional[StrictInt] = None, measurement: Optional[Union[StrictFloat, StrictInt]] = None, status: Optional[StrictStr] = None)
field channel: Optional[StrictInt] = None

The channel number if the diagnostic has an associated channel number. If not specified, defaults to null.

field measurement: Optional[Union[StrictFloat, StrictInt]] = None

Supply voltage in volts.

field status: Optional[StrictStr] = None

Indicates whether the measurement is outside the high alarm, low alarm, high warning, or low warning thresholds for supply voltage. Valid values are alarm low, alarm high, warn low, warn high, and ok.

NetworkInterfacePost

pydantic model pypureclient.flasharray.NetworkInterfacePost(*, name: Optional[StrictStr] = None, eth: Optional[NetworkinterfacepostEth] = None, services: Optional[ConstrainedListValue[StrictStr]] = None)
field eth: Optional[NetworkinterfacepostEth] = None
field name: Optional[StrictStr] = None

A locally unique, system-generated name. The name cannot be modified.

field services: Optional[ConstrainedListValue[StrictStr]] = None

The services provided by the specified network interface or Fibre Channel port.

NetworkInterfaceResponse

pydantic model pypureclient.flasharray.NetworkInterfaceResponse(*, items: Optional[ConstrainedListValue[NetworkInterface]] = None)
field items: Optional[ConstrainedListValue[NetworkInterface]] = None

NetworkInterfacesPortDetails

pydantic model pypureclient.flasharray.NetworkInterfacesPortDetails(*, name: Optional[StrictStr] = None, interface_type: Optional[StrictStr] = None, rx_los: Optional[ConstrainedListValue[NetworkInterfacePortDetailsRxLos]] = None, rx_power: Optional[ConstrainedListValue[NetworkInterfacePortDetailsRxPower]] = None, static: Optional[NetworkInterfacePortDetailsStatic] = None, temperature: Optional[ConstrainedListValue[NetworkInterfacePortDetailsTemperature]] = None, tx_bias: Optional[ConstrainedListValue[NetworkInterfacePortDetailsTxBias]] = None, tx_fault: Optional[ConstrainedListValue[NetworkInterfacePortDetailsTxFault]] = None, tx_power: Optional[ConstrainedListValue[NetworkInterfacePortDetailsTxPower]] = None, voltage: Optional[ConstrainedListValue[NetworkInterfacePortDetailsVoltage]] = None)

Network interface SFP details.

field interface_type: Optional[StrictStr] = None

The interface type. Valid values are eth and fc.

field name: Optional[StrictStr] = None

A locally unique, system-generated name. The name cannot be modified.

field rx_los: Optional[ConstrainedListValue[NetworkInterfacePortDetailsRxLos]] = None

Displays status flags for Rx LOS. A value of true indicates Rx Loss-of-Signal. For four-lane modules, the array contains a flag for each channel. If the transceiver does not support digital diagnostic monitoring, the array is empty.

field rx_power: Optional[ConstrainedListValue[NetworkInterfacePortDetailsRxPower]] = None

Displays real-time measurement of Rx input power and whether it is within range. For four-lane modules, the array contains a measurement and status for each channel. If the transceiver does not support digital diagnostic monitoring, the array is empty.

field static: Optional[NetworkInterfacePortDetailsStatic] = None
field temperature: Optional[ConstrainedListValue[NetworkInterfacePortDetailsTemperature]] = None

Displays real-time measurement of transceiver temperature and range. If the transceiver does not support digital diagnostic monitoring, the array is empty.

field tx_bias: Optional[ConstrainedListValue[NetworkInterfacePortDetailsTxBias]] = None

Displays real-time measurement of Tx bias current and whether it is within range. For four-lane modules, the array contains a measurement and status for each channel. If the transceiver does not support digital diagnostic monitoring, the array is empty.

field tx_fault: Optional[ConstrainedListValue[NetworkInterfacePortDetailsTxFault]] = None

Displays status flags for Tx Fault. A value of true indicates transmitter/laser fault. For four-lane modules, the array contains a flag for each channel. If the transceiver does not support digital diagnostic monitoring, the array is empty.

field tx_power: Optional[ConstrainedListValue[NetworkInterfacePortDetailsTxPower]] = None

Displays real-time measurement of Tx output power and whether it is within range. For four-lane modules, the array contains a measurement and status for each channel. If the transceiver does not support digital diagnostic monitoring, the array is empty.

field voltage: Optional[ConstrainedListValue[NetworkInterfacePortDetailsVoltage]] = None

Displays real-time measurement of supply voltage and whether it is within range. If the transceiver does not support digital diagnostic monitoring, the array is empty.

NetworkInterfacesPortDetailsGetResponse

pydantic model pypureclient.flasharray.NetworkInterfacesPortDetailsGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[NetworkInterfacesPortDetails]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[NetworkInterfacesPortDetails]] = None

A list of port details objects.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

NetworkInterfacesPortDetailsResponse

pydantic model pypureclient.flasharray.NetworkInterfacesPortDetailsResponse(*, items: Optional[ConstrainedListValue[NetworkInterfacesPortDetails]] = None)
field items: Optional[ConstrainedListValue[NetworkInterfacesPortDetails]] = None

A list of port details objects.

NetworkinterfacepatchEth

pydantic model pypureclient.flasharray.NetworkinterfacepatchEth(*, add_subinterfaces: Optional[ConstrainedListValue[ReferenceNoId]] = None, address: Optional[StrictStr] = None, gateway: Optional[StrictStr] = None, mtu: Optional[StrictInt] = None, netmask: Optional[StrictStr] = None, remove_subinterfaces: Optional[ConstrainedListValue[ReferenceNoId]] = None, subinterfaces: Optional[ConstrainedListValue[ReferenceNoId]] = None, subnet: Optional[ReferenceNoId] = None)

Ethernet network interface properties.

field add_subinterfaces: Optional[ConstrainedListValue[ReferenceNoId]] = None

Child devices to be added to the specified bond interface.

field address: Optional[StrictStr] = None

The IPv4 or IPv6 address to be associated with the specified network interface.

field gateway: Optional[StrictStr] = None

The IPv4 or IPv6 address of the gateway through which the specified network interface is to communicate with the network.

field mtu: Optional[StrictInt] = None

Maximum message transfer unit (packet) size for the network interface in bytes. MTU setting cannot exceed the MTU of the corresponding physical interface.

field netmask: Optional[StrictStr] = None

Netmask of the specified network interface that, when combined with the address of the interface, determines the network address of the interface.

field remove_subinterfaces: Optional[ConstrainedListValue[ReferenceNoId]] = None

Child devices to be removed from the specified bond interface.

field subinterfaces: Optional[ConstrainedListValue[ReferenceNoId]] = None

Child devices to be added to the specified bond interface.

field subnet: Optional[ReferenceNoId] = None

Subnet that is associated with the specified network interface.

NetworkinterfacepostEth

pydantic model pypureclient.flasharray.NetworkinterfacepostEth(*, address: Optional[StrictStr] = None, subinterfaces: Optional[ConstrainedListValue[ReferenceNoId]] = None, subnet: Optional[ReferenceNoId] = None, subtype: Optional[StrictStr] = None)

Ethernet network interface properties.

field address: Optional[StrictStr] = None

The IPv4 or IPv6 address to be associated with the specified network interface.

field subinterfaces: Optional[ConstrainedListValue[ReferenceNoId]] = None

List of network interfaces configured to be a subinterface of the specified network interface.

field subnet: Optional[ReferenceNoId] = None

Subnet that is associated with the specified network interface.

field subtype: Optional[StrictStr] = None

The subtype of the specified network interface. Only interfaces of subtype vif and lacp_bond can be created. Configurable on POST only. Valid values are failover_bond, lacp_bond, physical, and vif. If the subtype is vif, the services parameter must not be set.

NewName

pydantic model pypureclient.flasharray.NewName(*, name: Optional[StrictStr] = None)
field name: Optional[StrictStr] = None

The new name for the resource.

NonCopyableTag

pydantic model pypureclient.flasharray.NonCopyableTag(*, key: Optional[StrictStr] = None, namespace: Optional[StrictStr] = None, resource: Optional[FixedReference] = None, value: Optional[StrictStr] = None)
field key: Optional[StrictStr] = None

Key of the tag. Supports up to 64 Unicode characters.

field namespace: Optional[StrictStr] = None

Optional namespace of the tag. Namespace identifies the category of the tag. Omitting the namespace defaults to the namespace default. The pure&#42; namespaces are reserved for plugins and integration partners. It is recommended that customers avoid using reserved namespaces.

field resource: Optional[FixedReference] = None
field value: Optional[StrictStr] = None

Value of the tag. Supports up to 256 Unicode characters.

NonCopyableTagBatch

pydantic model pypureclient.flasharray.NonCopyableTagBatch(*, key: Optional[StrictStr] = None, namespace: Optional[StrictStr] = None, resource: Optional[Reference] = None, value: Optional[StrictStr] = None)
field key: Optional[StrictStr] = None

Key of the tag. Supports up to 64 Unicode characters.

field namespace: Optional[StrictStr] = None

Optional namespace of the tag. Namespace identifies the category of the tag. Omitting the namespace defaults to the namespace default. The pure&#42; namespaces are reserved for plugins and integration partners. Avoid using reserved namespaces.

field resource: Optional[Reference] = None

A reference to the parent object.

field value: Optional[StrictStr] = None

Value of the tag. Supports up to 256 Unicode characters.

Oauth210TokenPost400Response

pydantic model pypureclient.flasharray.Oauth210TokenPost400Response(*, error: Optional[StrictStr] = None, error_description: Optional[StrictStr] = None)
field error: Optional[StrictStr] = None
field error_description: Optional[StrictStr] = None

Oauth210TokenPost401Response

pydantic model pypureclient.flasharray.Oauth210TokenPost401Response(*, error: Optional[StrictStr] = None, error_description: Optional[StrictStr] = None)
field error: Optional[StrictStr] = None
field error_description: Optional[StrictStr] = None

OauthTokenResponse

pydantic model pypureclient.flasharray.OauthTokenResponse(*, access_token: Optional[StrictStr] = None, expires_in: Optional[StrictInt] = None, issued_token_type: Optional[StrictStr] = None, token_type: Optional[StrictStr] = None)
field access_token: Optional[StrictStr] = None

The serialized OAuth 2.0 Bearer token used to perform authenticated requests. The access token must be added to the Authorization header of all API calls.

field expires_in: Optional[StrictInt] = None

The duration after which the access token will expire. Measured in seconds. This differs from other duration fields that are expressed in milliseconds.

field issued_token_type: Optional[StrictStr] = None

The type of token that is issued. The Pure Storage REST API supports OAuth 2.0 access tokens.

field token_type: Optional[StrictStr] = None

Indicates how the API client can use the access token issued. The Pure Storage REST API supports the Bearer token.

Offload

pydantic model pypureclient.flasharray.Offload(*, azure: Optional[OffloadAzure] = None, google_cloud: Optional[OffloadGoogleCloud] = None, nfs: Optional[OffloadNfs] = None, s3: Optional[OffloadS3] = None, name: Optional[StrictStr] = None, context: Optional[FixedReference] = None, protocol: Optional[StrictStr] = None, space: Optional[Space] = None, status: Optional[StrictStr] = None, target_id: Optional[StrictStr] = None)
field azure: Optional[OffloadAzure] = None

Microsoft Azure Blob storage settings.

field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field google_cloud: Optional[OffloadGoogleCloud] = None (alias 'google-cloud')

Google Cloud Storage settings.

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

field nfs: Optional[OffloadNfs] = None

NFS settings. Deprecated from version 6.6.0 onwards - Contact support for additional information.

field protocol: Optional[StrictStr] = None

Type of offload. Valid values include azure, google-cloud, nfs, and s3.

field s3: Optional[OffloadS3] = None

S3 settings.

field space: Optional[Space] = None
field status: Optional[StrictStr] = None

Offload status. Valid values are connecting, connected, disconnecting, not connected, and scanning.

field target_id: Optional[StrictStr] = None

Unique ID for the offload target. When multiple connections to one offload target are created, they each have distinct IDs but share the same target_id.

OffloadAzure

pydantic model pypureclient.flasharray.OffloadAzure(*, account_name: Optional[StrictStr] = None, container_name: Optional[StrictStr] = None, profile: Optional[StrictStr] = None, secret_access_key: Optional[StrictStr] = None)
field account_name: Optional[StrictStr] = None

The name of the existing Azure Blob storage account.

field container_name: Optional[StrictStr] = None

The name of the container in the Azure Blob storage account to where the data will be offloaded. The name must be a valid DNS name. If not specified, defaults to offload.

field profile: Optional[StrictStr] = None

The offload target profile that will be selected for this target. This option allows more granular configuration for the target on top of the protocol parameter. Values include azure.

field secret_access_key: Optional[StrictStr] = None

The secret access key that goes with the account name (account_name) of the Azure Blob storage account. The secret access key is only accepted when creating the connection between the array and the Azure Blob storage account. The account_name and container_name, and secret_access_key parameters must be set together.

OffloadGetResponse

pydantic model pypureclient.flasharray.OffloadGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Offload]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None, total: Optional[ConstrainedListValue[Offload]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[Offload]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total: Optional[ConstrainedListValue[Offload]] = None

The aggregate value of all items after filtering. Where meaningful, the average value is displayed instead. If applicable, the values are displayed for each field.

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

OffloadGoogleCloud

pydantic model pypureclient.flasharray.OffloadGoogleCloud(*, access_key_id: Optional[StrictStr] = None, bucket: Optional[StrictStr] = None, profile: Optional[StrictStr] = None, secret_access_key: Optional[StrictStr] = None)
field access_key_id: Optional[StrictStr] = None

The access key ID of the Google Cloud account used to create a connection between the array and a Google Cloud offload target. The access key ID is 24 characters in length and is only accepted when creating the connection between the array and the Google Cloud offload target. The access_key_id, secret_access_key, and bucket parameters must be set together.

field bucket: Optional[StrictStr] = None

The name of the Google Cloud Storage bucket to which the data will be offloaded. Grant basic read and write access permissions to the bucket and verify that the bucket is empty of all objects. The access_key_id, secret_access_key, and bucket parameters must be set together.

field profile: Optional[StrictStr] = None

The offload target profile that will be selected for this target. This option allows more granular configuration for the target on top of the protocol parameter. Values include gcp.

field secret_access_key: Optional[StrictStr] = None

The secret access key that goes with the access key ID of the Google Cloud account. The secret access key is 40 characters in length is only accepted when creating the connection between the array and the Google Cloud offload target. The access_key_id, secret_access_key, and bucket parameters must be set together.

OffloadNfs

pydantic model pypureclient.flasharray.OffloadNfs(*, address: Optional[StrictStr] = None, mount_options: Optional[StrictStr] = None, mount_point: Optional[StrictStr] = None, profile: Optional[StrictStr] = None)
field address: Optional[StrictStr] = None

The hostname or IP address of the NFS server to where the data will be offloaded. An array can be connected to one offload target at a time, while multiple arrays can be connected to the same offload target. If the protection group is in a stretched pod, for high availability, connect both arrays in the stretched pod to the offload target.

field mount_options: Optional[StrictStr] = None

The custom mount options on the NFS server. Enter multiple mount options in comma-separated format. Valid values include port, rsize, wsize, nfsvers, and tcp or udp. These mount options are common to all NFS file systems.

field mount_point: Optional[StrictStr] = None

The mount point of the NFS export on the NFS server. For example, /mnt. The access_key_id, secret_access_key, and bucket parameters must be set together.

field profile: Optional[StrictStr] = None

The offload target profile that will be selected for this target. This option allows more granular configuration for the target on top of the protocol parameter. Values include nfs, and nfs-flashblade.

OffloadPost

pydantic model pypureclient.flasharray.OffloadPost(*, azure: Optional[OffloadAzure] = None, google_cloud: Optional[OffloadGoogleCloud] = None, nfs: Optional[OffloadNfs] = None, s3: Optional[OffloadS3] = None)
field azure: Optional[OffloadAzure] = None

Microsoft Azure Blob storage settings.

field google_cloud: Optional[OffloadGoogleCloud] = None (alias 'google-cloud')

Google Cloud Storage settings.

field nfs: Optional[OffloadNfs] = None

NFS settings. Deprecated from version 6.6.0 onwards - Contact support for additional information.

field s3: Optional[OffloadS3] = None

S3 settings.

OffloadResponse

pydantic model pypureclient.flasharray.OffloadResponse(*, items: Optional[ConstrainedListValue[Offload]] = None)
field items: Optional[ConstrainedListValue[Offload]] = None

OffloadS3

pydantic model pypureclient.flasharray.OffloadS3(*, access_key_id: Optional[StrictStr] = None, auth_region: Optional[StrictStr] = None, bucket: Optional[StrictStr] = None, placement_strategy: Optional[StrictStr] = None, profile: Optional[StrictStr] = None, secret_access_key: Optional[StrictStr] = None, uri: Optional[StrictStr] = None)
field access_key_id: Optional[StrictStr] = None

The access key ID of the AWS account used to create a connection between the array and an Amazon S3 offload target. The access key ID is 20 characters in length and is only accepted when creating the connection between the array and the S3 offload target. The access_key_id, secret_access_key, and bucket parameters must be set together.

field auth_region: Optional[StrictStr] = None

The region that will be used for initial authentication request. This parameter is optional and should be used only when region autodetection fails.

field bucket: Optional[StrictStr] = None

The name of the Amazon S3 bucket to where the data will be offloaded. Grant basic read and write ACL permissions to the bucket, and enable default (server-side) encryption for the bucket. Also verify that the bucket is empty of all objects and does not have any lifecycle policies. The access_key_id, secret_access_key, and bucket parameters must be set together.

field placement_strategy: Optional[StrictStr] = None

The storage placement strategy used for the dynamic placement of data in an Amazon S3 offload target. Valid values are aws-intelligent-tiering, aws-standard-class, and retention-based. If set to aws-intelligent-tiering, data is stored in the Amazon S3 INTELLIGENT_TIERING storage class regardless of the retention period. If set to aws-standard-access, the data is stored in the Amazon S3 STANDARD storage class regardless of the retention period. If set to retention-based, the data for protection groups with longer retention periods is placed in the Amazon S3 STANDARD_IA (infrequently accessed, more cost-effective) storage class. All other data is placed in the STANDARD storage class. When the array is initially connected to an S3 offload target, placement_strategy is automatically set to retention-based. The placement_strategy or uri parameter is required, but they cannot be set together.

field profile: Optional[StrictStr] = None

The offload target profile that will be selected for this target. This option allows more granular configuration for the target on top of the protocol parameter. Values include s3-aws, s3-flashblade, s3-scality-ring, s3-wasabi-pay-as-you-go, s3-wasabi-rcs, and s3-other.

field secret_access_key: Optional[StrictStr] = None

The secret access key that goes with the access key ID (access_key_id) of the AWS account. The secret access key is 40 characters in length is only accepted when creating the connection between the array and the S3 offload target. The access_key_id, secret_access_key, and bucket parameters must be set together.

field uri: Optional[StrictStr] = None

The URI used to create a connection between the array and a non-AWS S3 offload target. Storage placement strategies are not supported for non-AWS S3 offload targets. Both the HTTP and HTTPS protocols are allowed.

OverrideCheck

pydantic model pypureclient.flasharray.OverrideCheck(*, args: Optional[StrictStr] = None, name: Optional[StrictStr] = None, persistent: Optional[StrictBool] = None)
field args: Optional[StrictStr] = None

The name of the specific check within the override check to ignore so that the system can continue with the software upgrade. The name parameter of the override check must be specified with the args parameter. For example, if the HostIOCheck check fails on hosts host01 and host02, the system displays a list of these host names in the failed check. To override the HostIOCheck checks for host01 and host02, set name=HostIOCheck, and set args=host01,host02. Enter multiple args in comma-separated format. Note that not all checks have args values.

field name: Optional[StrictStr] = None

The name of the upgrade check to be overridden so the software upgrade can continue if the check failed or is anticipated to fail during the upgrade process. Overriding the check forces the system to ignore the check failure and continue with the upgrade. If the check includes more specific checks that failed or are anticipated to fail, set them using the args parameter. For example, the HostIOCheck check may include a list of hosts that have failed or are anticipated to fail the upgrade check.

field persistent: Optional[StrictBool] = None

If set to true, the system always ignores the failure of the specified upgrade check and continues with the upgrade process. If set to false, the system ignores the failure of the specified upgrade check until the upgrade check finishes and the upgrade process is continued. For example, the continue command is successfully issued in an interactive mode, or the first upgrade check step successfully finishes in a one-click mode.

Constraints

  • type = boolean

PageInfo

pydantic model pypureclient.flasharray.PageInfo(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

PageInfoWithoutTotalItemCountResponse

pydantic model pypureclient.flasharray.PageInfoWithoutTotalItemCountResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query parameter to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination, then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field more_items_remaining: Optional[StrictBool] = None

Displays a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

Performance

pydantic model pypureclient.flasharray.Performance(*, bytes_per_mirrored_write: Optional[ConstrainedIntValue] = None, bytes_per_op: Optional[ConstrainedIntValue] = None, bytes_per_read: Optional[ConstrainedIntValue] = None, bytes_per_write: Optional[ConstrainedIntValue] = None, mirrored_write_bytes_per_sec: Optional[ConstrainedIntValue] = None, mirrored_writes_per_sec: Optional[ConstrainedIntValue] = None, qos_rate_limit_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None, qos_rate_limit_usec_per_read_op: Optional[ConstrainedIntValue] = None, qos_rate_limit_usec_per_write_op: Optional[ConstrainedIntValue] = None, queue_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None, queue_usec_per_read_op: Optional[ConstrainedIntValue] = None, queue_usec_per_write_op: Optional[ConstrainedIntValue] = None, read_bytes_per_sec: Optional[ConstrainedIntValue] = None, reads_per_sec: Optional[ConstrainedIntValue] = None, san_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None, san_usec_per_read_op: Optional[ConstrainedIntValue] = None, san_usec_per_write_op: Optional[ConstrainedIntValue] = None, service_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None, service_usec_per_read_op: Optional[ConstrainedIntValue] = None, service_usec_per_read_op_cache_reduction: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, service_usec_per_write_op: Optional[ConstrainedIntValue] = None, time: Optional[StrictInt] = None, usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None, usec_per_read_op: Optional[ConstrainedIntValue] = None, usec_per_write_op: Optional[ConstrainedIntValue] = None, write_bytes_per_sec: Optional[ConstrainedIntValue] = None, writes_per_sec: Optional[ConstrainedIntValue] = None)
field bytes_per_mirrored_write: Optional[ConstrainedIntValue] = None

The average I/O size per mirrored write, measured in bytes.

Constraints

  • minimum = 0

field bytes_per_op: Optional[ConstrainedIntValue] = None

The average I/O size for both read and write (all) operations.

Constraints

  • minimum = 0

field bytes_per_read: Optional[ConstrainedIntValue] = None

The average I/O size per read, measured in bytes.

Constraints

  • minimum = 0

field bytes_per_write: Optional[ConstrainedIntValue] = None

The average I/O size per write, measured in bytes.

Constraints

  • minimum = 0

field mirrored_write_bytes_per_sec: Optional[ConstrainedIntValue] = None

The number of mirrored bytes written per second.

Constraints

  • minimum = 0

field mirrored_writes_per_sec: Optional[ConstrainedIntValue] = None

The number of mirrored writes per second.

Constraints

  • minimum = 0

field qos_rate_limit_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None

The average time it takes the array to process a mirrored I/O write request, measured in microseconds.

Constraints

  • minimum = 0

field qos_rate_limit_usec_per_read_op: Optional[ConstrainedIntValue] = None

The average time spent waiting due to QoS rate limiting for a read request, measured in microseconds.

Constraints

  • minimum = 0

field qos_rate_limit_usec_per_write_op: Optional[ConstrainedIntValue] = None

The average time that a write I/O request spends waiting as a result of the volume reaching its QoS bandwidth limit, measured in microseconds.

Constraints

  • minimum = 0

field queue_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None

The average time that a mirrored write I/O request spends in the array waiting to be served, measured in microseconds.

Constraints

  • minimum = 0

field queue_usec_per_read_op: Optional[ConstrainedIntValue] = None

The average time that a read I/O request spends in the array waiting to be served, measured in microseconds.

Constraints

  • minimum = 0

field queue_usec_per_write_op: Optional[ConstrainedIntValue] = None

The average time that a write I/O request spends in the array waiting to be served, measured in microseconds.

Constraints

  • minimum = 0

field read_bytes_per_sec: Optional[ConstrainedIntValue] = None

The number of bytes read per second.

Constraints

  • minimum = 0

field reads_per_sec: Optional[ConstrainedIntValue] = None

The number of read requests processed per second.

Constraints

  • minimum = 0

field san_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None

The average time required to transfer data from the initiator to the array for a mirrored write request, measured in microseconds.

Constraints

  • minimum = 0

field san_usec_per_read_op: Optional[ConstrainedIntValue] = None

The average time required to transfer data from the array to the initiator for a read request, measured in microseconds.

Constraints

  • minimum = 0

field san_usec_per_write_op: Optional[ConstrainedIntValue] = None

The average time required to transfer data from the initiator to the array for a write request, measured in microseconds.

Constraints

  • minimum = 0

field service_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None

The average time required for the array to service a mirrored write request, measured in microseconds.

Constraints

  • minimum = 0

field service_usec_per_read_op: Optional[ConstrainedIntValue] = None

The average time required for the array to service a read request, measured in microseconds.

Constraints

  • minimum = 0

field service_usec_per_read_op_cache_reduction: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

The percentage reduction in service_usec_per_read_op due to data cache hits. For example, a value of 0.25 indicates that the value of service_usec_per_read_op is 25&#37; lower than it would have been without any data cache hits.

field service_usec_per_write_op: Optional[ConstrainedIntValue] = None

The average time required for the array to service a write request, measured in microseconds.

Constraints

  • minimum = 0

field time: Optional[StrictInt] = None

The time when the sample performance data was taken, measured in milliseconds since the UNIX epoch.

field usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None

The average time it takes the array to process a mirrored I/O write request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.

Constraints

  • minimum = 0

field usec_per_read_op: Optional[ConstrainedIntValue] = None

The average time it takes the array to process an I/O read request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.

Constraints

  • minimum = 0

field usec_per_write_op: Optional[ConstrainedIntValue] = None

The average time it takes the array to process an I/O write request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.

Constraints

  • minimum = 0

field write_bytes_per_sec: Optional[ConstrainedIntValue] = None

The number of bytes written per second.

Constraints

  • minimum = 0

field writes_per_sec: Optional[ConstrainedIntValue] = None

The number of write requests processed per second.

Constraints

  • minimum = 0

Pod

pydantic model pypureclient.flasharray.Pod(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, context: Optional[FixedReference] = None, array_count: Optional[StrictInt] = None, arrays: Optional[ConstrainedListValue[PodArrayStatus]] = None, destroyed: Optional[StrictBool] = None, eradication_config: Optional[ContainerEradicationConfig] = None, failover_preferences: Optional[ConstrainedListValue[Reference]] = None, footprint: Optional[ConstrainedIntValue] = None, link_source_count: Optional[StrictInt] = None, link_target_count: Optional[StrictInt] = None, mediator: Optional[StrictStr] = None, mediator_version: Optional[StrictStr] = None, members: Optional[ConstrainedListValue[ReferenceWithType]] = None, promotion_status: Optional[StrictStr] = None, quota_limit: Optional[ConstrainedIntValue] = None, requested_promotion_state: Optional[StrictStr] = None, source: Optional[FixedReference] = None, space: Optional[PodSpace] = None, time_remaining: Optional[StrictInt] = None)
field array_count: Optional[StrictInt] = None

The number of arrays a pod connects to.

field arrays: Optional[ConstrainedListValue[PodArrayStatus]] = None

A list of arrays over which the pod is stretched. If there are two or more arrays in the stretched pod, all data in the pod is synchronously replicated between all of the arrays within the pod.

Constraints

  • minItems = 1

field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field destroyed: Optional[StrictBool] = None

Returns a value of true if the pod has been destroyed and is pending eradication. The time_remaining value displays the amount of time left until the destroyed pod is permanently eradicated. Before the time_remaining period has elapsed, the destroyed pod can be recovered by setting destroyed=false. Once the time_remaining period has elapsed, the pod is permanently eradicated and can no longer be recovered.

Constraints

  • type = boolean

field eradication_config: Optional[ContainerEradicationConfig] = None
field failover_preferences: Optional[ConstrainedListValue[Reference]] = None

Determines which array within a stretched pod should be given priority to stay online should the arrays ever lose contact with each other. The current array and any peer arrays that are connected to the current array for synchronous replication can be added to a pod for failover preference. By default, failover_preferences=null, meaning no arrays have been configured for failover preference.

field footprint: Optional[ConstrainedIntValue] = None

This field has been deprecated. Use the space.footprint field in the future, as it contains the same information. The maximum amount of space the pod would take up on any array, ignoring any data shared outside the pod. Measured in bytes. The footprint metric is mostly used for capacity planning.

Constraints

  • minimum = 0

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

The number of source pods that link to the pod.

The number of target pods that link to the pod.

field mediator: Optional[StrictStr] = None

The URL of the mediator for the pod. By default, the Pure1 Cloud Mediator (purestorage) serves as the mediator.

field mediator_version: Optional[StrictStr] = None

The mediator version.

field members: Optional[ConstrainedListValue[ReferenceWithType]] = None

A list of arrays or realms over which the pod is stretched. If there are two or more members in the stretched pod, all data in the pod is synchronously replicated between all of the members within the pod.

Constraints

  • minItems = 1

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

field promotion_status: Optional[StrictStr] = None

Current promotion status of a pod. Values include promoted, demoted, and promoting. The promoted status indicates that the pod has been promoted. The pod takes writes from hosts instead of incorporating replicated data. This is the default mode for a pod when it is created. The demoted status indicates that the pod has been demoted. The pod does not accept write requests and is ready to be used as a link target. The promoting status indicates that the pod is in an intermediate status between demoted and promoted while the promotion process is taking place.

field quota_limit: Optional[ConstrainedIntValue] = None

The logical quota limit of the pod, measured in bytes.

Constraints

  • maximum = 4503599627370496

field requested_promotion_state: Optional[StrictStr] = None

Values include promoted and demoted. Patch requested_promotion_state to demoted to demote the pod so that it can be used as a link target for continuous replication between pods. Demoted pods do not accept write requests, and a destroyed version of the pod with undo-demote appended to the pod name is created on the array with the state of the pod when it was in the promoted state. Patch requested_promotion_state to promoted to start the process of promoting the pod. The promotion_status indicates when the pod has been successfully promoted. Promoted pods stop incorporating replicated data from the source pod and start accepting write requests. The replication process does not stop as the source pod continues replicating data to the pod. The space consumed by the unique replicated data is tracked by the space.journal field of the pod.

field source: Optional[FixedReference] = None

The source pod from where data is cloned to create the new pod.

field space: Optional[PodSpace] = None

Displays provisioned size and physical storage consumption information for the sum of all volumes connected to the specified host.

field time_remaining: Optional[StrictInt] = None

The amount of time left until the destroyed pod is permanently eradicated, measured in milliseconds. Before the time_remaining period has elapsed, the destroyed pod can be recovered by setting destroyed=false.

PodArrayStatus

pydantic model pypureclient.flasharray.PodArrayStatus(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, frozen_at: Optional[StrictInt] = None, mediator_status: Optional[StrictStr] = None, member: Optional[ReferenceWithType] = None, pre_elected: Optional[StrictBool] = None, progress: Optional[Union[StrictFloat, StrictInt]] = None, status: Optional[StrictStr] = None)
field frozen_at: Optional[StrictInt] = None

The timestamp of when the data on the pod was frozen when the array went offline. Measured in milliseconds since the UNIX epoch. Also known as the recovery point. If the pod is in sync, a value of null will be returned.

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified.

field mediator_status: Optional[StrictStr] = None

The status of the mediator, which determines whether it is available to mediate a high availability event. Valid values are flummoxed, online, unknown, and unreachable. Only mediators in the online status can mediate high availability events. If set to flummoxed, the array can reach a mediator, but it is talking to the wrong one. Verify that the DNS in the environment is properly configured. This status might also appear if the pod has been offline on one array for an extended period of time and the peer array is unreachable. If set to online, the array is successfully communicating with the mediator, and the mediator is available to mediate a high availability event. If set to unreachable, the array cannot reach the mediator, either due to network issues or because the mediator is down. When a mediator is unreachable, synchronous replication continues to function provided all arrays are healthy and communicating, but a high availability event without mediator access can result in an outage.

field member: Optional[ReferenceWithType] = None

A reference to the member associated with the pod’s array status.

field name: Optional[StrictStr] = None

The resource name, such as volume name, pod name, snapshot name, and so on.

field pre_elected: Optional[StrictBool] = None

If set to true, the array has been pre-elected to remain online in the rare event that the mediator is inaccessible on both arrays within the stretched pod, and then later, the arrays within the stretched pod become disconnected from each other. If set to false, either the array has been pre-elected to remain offline while its peer array remains online, or pre-election is not in effect. One and only one array within each pod is pre-elected at a given point in time, so while a pre-elected array is keeping the pod online, the pod on its non-elected peer array remains offline during the communication failure. Users cannot pre-elect arrays.

Constraints

  • type = boolean

field progress: Optional[Union[StrictFloat, StrictInt]] = None

The percentage progress of the pod resyncing process for this array. The percentage is displayed as a decimal value, starting at 0.00 and ending at 1.00.

field status: Optional[StrictStr] = None

The status of the array within the stretched pod. Valid values are offline, online, resyncing, suspended, and unknown. If set to offline, the array is experiencing problems and may not have the latest pod data. The array cannot handle I/O to the pod and cannot take over during a high availability event. If set to online, the array is online and has the latest pod data. The array can handle I/O to the pod and take over during a high availability event. If set to suspended, the array is experiencing a short connection glitch of the pod. This is a temporary status and would transition to either online or offline soon. suspended is a new status that is exposed, starting from version 6.6.0. If set to resyncing, the array is actively getting the latest pod data so that it becomes fully synchronized with its peer array. During the resyncing process, the array cannot handle I/O to the pod. Once the arrays are fully synchronized, the array changes to online status. If set to unknown, the status of the peer array is unknown because this array is offline and cannot determine the state of the pod on the peer array. Only the peer array can ever be in unknown status; this unknown status is unique to the local array and will differ when viewed from its peer array.

PodEradicationConfig

pydantic model pypureclient.flasharray.PodEradicationConfig(*, manual_eradication: Optional[StrictStr] = None)

The status of the eradication functionality

field manual_eradication: Optional[StrictStr] = None

The manual eradication status of pod. If all-enabled, the pod and its contents can be eradicated. If partially-disabled, the pod cannot be eradicated because the pod contains some non-empty protection groups that are retention-locked. If all-disabled, the pod and its contents cannot be eradicated. Values include all-disabled, all-enabled, and partially-disabled.

PodGetResponse

pydantic model pypureclient.flasharray.PodGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Pod]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None, total: Optional[ConstrainedListValue[Pod]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[Pod]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total: Optional[ConstrainedListValue[Pod]] = None

The aggregate value of all items after filtering. When applicable, the average value is displayed instead. The values are displayed for each field, if meaningful.

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

PodMember

pydantic model pypureclient.flasharray.PodMember(*, context: Optional[FixedReference] = None, member: Optional[ReferenceWithType] = None, pod: Optional[ReferenceWithType] = None)
field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field member: Optional[ReferenceWithType] = None
field pod: Optional[ReferenceWithType] = None

PodMemberGetResponse

pydantic model pypureclient.flasharray.PodMemberGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[PodMember]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[PodMember]] = None

Displays a list of all items after filtering. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

PodMemberResponse

pydantic model pypureclient.flasharray.PodMemberResponse(*, items: Optional[ConstrainedListValue[PodMember]] = None)
field items: Optional[ConstrainedListValue[PodMember]] = None

Displays a list of all items after filtering. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

PodPatch

pydantic model pypureclient.flasharray.PodPatch(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, failover_preferences: Optional[ConstrainedListValue[Reference]] = None, ignore_usage: Optional[StrictBool] = None, mediator: Optional[StrictStr] = None, quota_limit: Optional[ConstrainedIntValue] = None, requested_promotion_state: Optional[StrictStr] = None)
field destroyed: Optional[StrictBool] = None

If set to true, the pod has been destroyed and is pending eradication. The time_remaining value displays the amount of time left until the destroyed pod is permanently eradicated. A pod can only be destroyed if it is empty, so before destroying a pod, ensure all volumes and protection groups inside the pod have been either moved out of the pod or destroyed. A stretched pod cannot be destroyed unless you unstretch it first. Before the time_remaining period has elapsed, the destroyed pod can be recovered by setting destroyed=false. Once the time_remaining period has elapsed, the pod is permanently eradicated and can no longer be recovered.

Constraints

  • type = boolean

field failover_preferences: Optional[ConstrainedListValue[Reference]] = None

Determines which array within a stretched pod should be given priority to stay online should the arrays ever lose contact with each other. The current array and any peer arrays that are connected to the current array for synchronous replication can be added to a pod for failover preference. By default, failover_preferences=null, meaning no arrays have been configured for failover preference. Enter multiple arrays in comma-separated format.

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field ignore_usage: Optional[StrictBool] = None

Set to true to set a quota_limit that is lower than the existing usage. This ensures that no new volumes can be created until the existing usage drops below the quota_limit. If not specified, defaults to false.

Constraints

  • type = boolean

field mediator: Optional[StrictStr] = None

Sets the URL of the mediator for this pod, replacing the URL of the current mediator. By default, the Pure1 Cloud Mediator (purestorage) serves as the mediator.

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

field quota_limit: Optional[ConstrainedIntValue] = None

The logical quota limit of the pod, measured in bytes. Must be a multiple of 512.

Constraints

  • minimum = 1048576

  • maximum = 4503599627370496

field requested_promotion_state: Optional[StrictStr] = None

Patch requested_promotion_state to demoted to demote the pod so that it can be used as a link target for continuous replication between pods. Demoted pods do not accept write requests, and a destroyed version of the pod with undo-demote appended to the pod name is created on the array with the state of the pod when it was in the promoted state. Patch requested_promotion_state to promoted to start the process of promoting the pod. The promotion_status indicates when the pod has been successfully promoted. Promoted pods stop incorporating replicated data from the source pod and start accepting write requests. The replication process does not stop when the source pod continues replicating data to the pod. The space consumed by the unique replicated data is tracked by the space.journal field of the pod.

PodPerformance

pydantic model pypureclient.flasharray.PodPerformance(*, bytes_per_mirrored_write: Optional[ConstrainedIntValue] = None, bytes_per_op: Optional[ConstrainedIntValue] = None, bytes_per_read: Optional[ConstrainedIntValue] = None, bytes_per_write: Optional[ConstrainedIntValue] = None, mirrored_write_bytes_per_sec: Optional[ConstrainedIntValue] = None, mirrored_writes_per_sec: Optional[ConstrainedIntValue] = None, qos_rate_limit_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None, qos_rate_limit_usec_per_read_op: Optional[ConstrainedIntValue] = None, qos_rate_limit_usec_per_write_op: Optional[ConstrainedIntValue] = None, queue_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None, queue_usec_per_read_op: Optional[ConstrainedIntValue] = None, queue_usec_per_write_op: Optional[ConstrainedIntValue] = None, read_bytes_per_sec: Optional[ConstrainedIntValue] = None, reads_per_sec: Optional[ConstrainedIntValue] = None, san_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None, san_usec_per_read_op: Optional[ConstrainedIntValue] = None, san_usec_per_write_op: Optional[ConstrainedIntValue] = None, service_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None, service_usec_per_read_op: Optional[ConstrainedIntValue] = None, service_usec_per_read_op_cache_reduction: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, service_usec_per_write_op: Optional[ConstrainedIntValue] = None, time: Optional[StrictInt] = None, usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None, usec_per_read_op: Optional[ConstrainedIntValue] = None, usec_per_write_op: Optional[ConstrainedIntValue] = None, write_bytes_per_sec: Optional[ConstrainedIntValue] = None, writes_per_sec: Optional[ConstrainedIntValue] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, context: Optional[FixedReference] = None, others_per_sec: Optional[ConstrainedIntValue] = None, usec_per_other_op: Optional[ConstrainedIntValue] = None)
field bytes_per_mirrored_write: Optional[ConstrainedIntValue] = None

The average I/O size per mirrored write, measured in bytes.

Constraints

  • minimum = 0

field bytes_per_op: Optional[ConstrainedIntValue] = None

The average I/O size for both read and write (all) operations.

Constraints

  • minimum = 0

field bytes_per_read: Optional[ConstrainedIntValue] = None

The average I/O size per read, measured in bytes.

Constraints

  • minimum = 0

field bytes_per_write: Optional[ConstrainedIntValue] = None

The average I/O size per write, measured in bytes.

Constraints

  • minimum = 0

field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field mirrored_write_bytes_per_sec: Optional[ConstrainedIntValue] = None

The number of mirrored bytes written per second.

Constraints

  • minimum = 0

field mirrored_writes_per_sec: Optional[ConstrainedIntValue] = None

The number of mirrored writes per second.

Constraints

  • minimum = 0

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

field others_per_sec: Optional[ConstrainedIntValue] = None

The number of other requests processed per second.

Constraints

  • minimum = 0

field qos_rate_limit_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None

The average time it takes the array to process a mirrored I/O write request, measured in microseconds.

Constraints

  • minimum = 0

field qos_rate_limit_usec_per_read_op: Optional[ConstrainedIntValue] = None

The average time spent waiting due to QoS rate limiting for a read request, measured in microseconds.

Constraints

  • minimum = 0

field qos_rate_limit_usec_per_write_op: Optional[ConstrainedIntValue] = None

The average time that a write I/O request spends waiting as a result of the volume reaching its QoS bandwidth limit, measured in microseconds.

Constraints

  • minimum = 0

field queue_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None

The average time that a mirrored write I/O request spends in the array waiting to be served, measured in microseconds.

Constraints

  • minimum = 0

field queue_usec_per_read_op: Optional[ConstrainedIntValue] = None

The average time that a read I/O request spends in the array waiting to be served, measured in microseconds.

Constraints

  • minimum = 0

field queue_usec_per_write_op: Optional[ConstrainedIntValue] = None

The average time that a write I/O request spends in the array waiting to be served, measured in microseconds.

Constraints

  • minimum = 0

field read_bytes_per_sec: Optional[ConstrainedIntValue] = None

The number of bytes read per second.

Constraints

  • minimum = 0

field reads_per_sec: Optional[ConstrainedIntValue] = None

The number of read requests processed per second.

Constraints

  • minimum = 0

field san_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None

The average time required to transfer data from the initiator to the array for a mirrored write request, measured in microseconds.

Constraints

  • minimum = 0

field san_usec_per_read_op: Optional[ConstrainedIntValue] = None

The average time required to transfer data from the array to the initiator for a read request, measured in microseconds.

Constraints

  • minimum = 0

field san_usec_per_write_op: Optional[ConstrainedIntValue] = None

The average time required to transfer data from the initiator to the array for a write request, measured in microseconds.

Constraints

  • minimum = 0

field service_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None

The average time required for the array to service a mirrored write request, measured in microseconds.

Constraints

  • minimum = 0

field service_usec_per_read_op: Optional[ConstrainedIntValue] = None

The average time required for the array to service a read request, measured in microseconds.

Constraints

  • minimum = 0

field service_usec_per_read_op_cache_reduction: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

The percentage reduction in service_usec_per_read_op due to data cache hits. For example, a value of 0.25 indicates that the value of service_usec_per_read_op is 25&#37; lower than it would have been without any data cache hits.

field service_usec_per_write_op: Optional[ConstrainedIntValue] = None

The average time required for the array to service a write request, measured in microseconds.

Constraints

  • minimum = 0

field time: Optional[StrictInt] = None

The time when the sample performance data was taken, measured in milliseconds since the UNIX epoch.

field usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None

The average time it takes the array to process a mirrored I/O write request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.

Constraints

  • minimum = 0

field usec_per_other_op: Optional[ConstrainedIntValue] = None

The average time it takes the pod to process an I/O other request, measured in microseconds.

Constraints

  • minimum = 0

field usec_per_read_op: Optional[ConstrainedIntValue] = None

The average time it takes the array to process an I/O read request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.

Constraints

  • minimum = 0

field usec_per_write_op: Optional[ConstrainedIntValue] = None

The average time it takes the array to process an I/O write request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.

Constraints

  • minimum = 0

field write_bytes_per_sec: Optional[ConstrainedIntValue] = None

The number of bytes written per second.

Constraints

  • minimum = 0

field writes_per_sec: Optional[ConstrainedIntValue] = None

The number of write requests processed per second.

Constraints

  • minimum = 0

PodPerformanceByArray

pydantic model pypureclient.flasharray.PodPerformanceByArray(*, bytes_per_mirrored_write: Optional[ConstrainedIntValue] = None, bytes_per_op: Optional[ConstrainedIntValue] = None, bytes_per_read: Optional[ConstrainedIntValue] = None, bytes_per_write: Optional[ConstrainedIntValue] = None, mirrored_write_bytes_per_sec: Optional[ConstrainedIntValue] = None, mirrored_writes_per_sec: Optional[ConstrainedIntValue] = None, qos_rate_limit_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None, qos_rate_limit_usec_per_read_op: Optional[ConstrainedIntValue] = None, qos_rate_limit_usec_per_write_op: Optional[ConstrainedIntValue] = None, queue_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None, queue_usec_per_read_op: Optional[ConstrainedIntValue] = None, queue_usec_per_write_op: Optional[ConstrainedIntValue] = None, read_bytes_per_sec: Optional[ConstrainedIntValue] = None, reads_per_sec: Optional[ConstrainedIntValue] = None, san_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None, san_usec_per_read_op: Optional[ConstrainedIntValue] = None, san_usec_per_write_op: Optional[ConstrainedIntValue] = None, service_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None, service_usec_per_read_op: Optional[ConstrainedIntValue] = None, service_usec_per_read_op_cache_reduction: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, service_usec_per_write_op: Optional[ConstrainedIntValue] = None, time: Optional[StrictInt] = None, usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None, usec_per_read_op: Optional[ConstrainedIntValue] = None, usec_per_write_op: Optional[ConstrainedIntValue] = None, write_bytes_per_sec: Optional[ConstrainedIntValue] = None, writes_per_sec: Optional[ConstrainedIntValue] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, context: Optional[FixedReference] = None, others_per_sec: Optional[ConstrainedIntValue] = None, usec_per_other_op: Optional[ConstrainedIntValue] = None, array: Optional[Resource] = None)
field array: Optional[Resource] = None

The array on which the performance metrics were recorded.

field bytes_per_mirrored_write: Optional[ConstrainedIntValue] = None

The average I/O size per mirrored write, measured in bytes.

Constraints

  • minimum = 0

field bytes_per_op: Optional[ConstrainedIntValue] = None

The average I/O size for both read and write (all) operations.

Constraints

  • minimum = 0

field bytes_per_read: Optional[ConstrainedIntValue] = None

The average I/O size per read, measured in bytes.

Constraints

  • minimum = 0

field bytes_per_write: Optional[ConstrainedIntValue] = None

The average I/O size per write, measured in bytes.

Constraints

  • minimum = 0

field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field mirrored_write_bytes_per_sec: Optional[ConstrainedIntValue] = None

The number of mirrored bytes written per second.

Constraints

  • minimum = 0

field mirrored_writes_per_sec: Optional[ConstrainedIntValue] = None

The number of mirrored writes per second.

Constraints

  • minimum = 0

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

field others_per_sec: Optional[ConstrainedIntValue] = None

The number of other requests processed per second.

Constraints

  • minimum = 0

field qos_rate_limit_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None

The average time it takes the array to process a mirrored I/O write request, measured in microseconds.

Constraints

  • minimum = 0

field qos_rate_limit_usec_per_read_op: Optional[ConstrainedIntValue] = None

The average time spent waiting due to QoS rate limiting for a read request, measured in microseconds.

Constraints

  • minimum = 0

field qos_rate_limit_usec_per_write_op: Optional[ConstrainedIntValue] = None

The average time that a write I/O request spends waiting as a result of the volume reaching its QoS bandwidth limit, measured in microseconds.

Constraints

  • minimum = 0

field queue_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None

The average time that a mirrored write I/O request spends in the array waiting to be served, measured in microseconds.

Constraints

  • minimum = 0

field queue_usec_per_read_op: Optional[ConstrainedIntValue] = None

The average time that a read I/O request spends in the array waiting to be served, measured in microseconds.

Constraints

  • minimum = 0

field queue_usec_per_write_op: Optional[ConstrainedIntValue] = None

The average time that a write I/O request spends in the array waiting to be served, measured in microseconds.

Constraints

  • minimum = 0

field read_bytes_per_sec: Optional[ConstrainedIntValue] = None

The number of bytes read per second.

Constraints

  • minimum = 0

field reads_per_sec: Optional[ConstrainedIntValue] = None

The number of read requests processed per second.

Constraints

  • minimum = 0

field san_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None

The average time required to transfer data from the initiator to the array for a mirrored write request, measured in microseconds.

Constraints

  • minimum = 0

field san_usec_per_read_op: Optional[ConstrainedIntValue] = None

The average time required to transfer data from the array to the initiator for a read request, measured in microseconds.

Constraints

  • minimum = 0

field san_usec_per_write_op: Optional[ConstrainedIntValue] = None

The average time required to transfer data from the initiator to the array for a write request, measured in microseconds.

Constraints

  • minimum = 0

field service_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None

The average time required for the array to service a mirrored write request, measured in microseconds.

Constraints

  • minimum = 0

field service_usec_per_read_op: Optional[ConstrainedIntValue] = None

The average time required for the array to service a read request, measured in microseconds.

Constraints

  • minimum = 0

field service_usec_per_read_op_cache_reduction: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

The percentage reduction in service_usec_per_read_op due to data cache hits. For example, a value of 0.25 indicates that the value of service_usec_per_read_op is 25&#37; lower than it would have been without any data cache hits.

field service_usec_per_write_op: Optional[ConstrainedIntValue] = None

The average time required for the array to service a write request, measured in microseconds.

Constraints

  • minimum = 0

field time: Optional[StrictInt] = None

The time when the sample performance data was taken, measured in milliseconds since the UNIX epoch.

field usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None

The average time it takes the array to process a mirrored I/O write request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.

Constraints

  • minimum = 0

field usec_per_other_op: Optional[ConstrainedIntValue] = None

The average time it takes the pod to process an I/O other request, measured in microseconds.

Constraints

  • minimum = 0

field usec_per_read_op: Optional[ConstrainedIntValue] = None

The average time it takes the array to process an I/O read request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.

Constraints

  • minimum = 0

field usec_per_write_op: Optional[ConstrainedIntValue] = None

The average time it takes the array to process an I/O write request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.

Constraints

  • minimum = 0

field write_bytes_per_sec: Optional[ConstrainedIntValue] = None

The number of bytes written per second.

Constraints

  • minimum = 0

field writes_per_sec: Optional[ConstrainedIntValue] = None

The number of write requests processed per second.

Constraints

  • minimum = 0

PodPerformanceByArrayGetResponse

pydantic model pypureclient.flasharray.PodPerformanceByArrayGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None, items: Optional[ConstrainedListValue[PodPerformanceByArray]] = None, total: Optional[ConstrainedListValue[PodPerformanceByArray]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[PodPerformanceByArray]] = None

Performance data, broken down by array. If total_only=true, the items list will be empty.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total: Optional[ConstrainedListValue[PodPerformanceByArray]] = None

The aggregate value of all items after filtering. When applicable, the average value is displayed instead. If applicable, the values are displayed for each field.

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

PodPerformanceReplication

pydantic model pypureclient.flasharray.PodPerformanceReplication(*, context: Optional[FixedReference] = None, continuous_bytes_per_sec: Optional[ReplicationPerformanceWithTotal] = None, periodic_bytes_per_sec: Optional[ReplicationPerformanceWithTotal] = None, pod: Optional[FixedReference] = None, resync_bytes_per_sec: Optional[ReplicationPerformanceWithTotal] = None, sync_bytes_per_sec: Optional[ReplicationPerformanceWithTotal] = None, time: Optional[StrictInt] = None, total_bytes_per_sec: Optional[ConstrainedIntValue] = None)
field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field continuous_bytes_per_sec: Optional[ReplicationPerformanceWithTotal] = None

Total bytes transmitted or received per second for continuous replication. The continuous replication feature is used for disaster recovery on FlashArray and provides a recovery point objective (RPO) of significantly less than 30s.

field periodic_bytes_per_sec: Optional[ReplicationPerformanceWithTotal] = None

Total bytes transmitted or received per second for periodic replication.

field pod: Optional[FixedReference] = None

Reference to the pod that the performance data is associated with.

field resync_bytes_per_sec: Optional[ReplicationPerformanceWithTotal] = None

Total bytes transmitted or received per second during resync replication. Resync replication is the mechanism to bring two arrays into sync. This may occur during an initial pod stretch, or, in case of outage, when two arrays reestablish connection. After the connection is restored, the array that was online starts replicating pod data to its peer array until the pod is once again in sync.

field sync_bytes_per_sec: Optional[ReplicationPerformanceWithTotal] = None

Total bytes transmitted or received per second for synchronous replication.

field time: Optional[StrictInt] = None

Sample time in milliseconds since the UNIX epoch.

field total_bytes_per_sec: Optional[ConstrainedIntValue] = None

Total bytes transmitted and received per second for all types of replication.

Constraints

  • minimum = 0

PodPerformanceReplicationByArray

pydantic model pypureclient.flasharray.PodPerformanceReplicationByArray(*, context: Optional[FixedReference] = None, continuous_bytes_per_sec: Optional[ReplicationPerformanceWithTotal] = None, periodic_bytes_per_sec: Optional[ReplicationPerformanceWithTotal] = None, pod: Optional[FixedReference] = None, resync_bytes_per_sec: Optional[ReplicationPerformanceWithTotal] = None, sync_bytes_per_sec: Optional[ReplicationPerformanceWithTotal] = None, time: Optional[StrictInt] = None, total_bytes_per_sec: Optional[ConstrainedIntValue] = None, array: Optional[Resource] = None)
field array: Optional[Resource] = None

Array that shares this pod.

field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field continuous_bytes_per_sec: Optional[ReplicationPerformanceWithTotal] = None

Total bytes transmitted or received per second for continuous replication. The continuous replication feature is used for disaster recovery on FlashArray and provides a recovery point objective (RPO) of significantly less than 30s.

field periodic_bytes_per_sec: Optional[ReplicationPerformanceWithTotal] = None

Total bytes transmitted or received per second for periodic replication.

field pod: Optional[FixedReference] = None

Reference to the pod that the performance data is associated with.

field resync_bytes_per_sec: Optional[ReplicationPerformanceWithTotal] = None

Total bytes transmitted or received per second during resync replication. Resync replication is the mechanism to bring two arrays into sync. This may occur during an initial pod stretch, or, in case of outage, when two arrays reestablish connection. After the connection is restored, the array that was online starts replicating pod data to its peer array until the pod is once again in sync.

field sync_bytes_per_sec: Optional[ReplicationPerformanceWithTotal] = None

Total bytes transmitted or received per second for synchronous replication.

field time: Optional[StrictInt] = None

Sample time in milliseconds since the UNIX epoch.

field total_bytes_per_sec: Optional[ConstrainedIntValue] = None

Total bytes transmitted and received per second for all types of replication.

Constraints

  • minimum = 0

PodPerformanceReplicationByArrayGetResponse

pydantic model pypureclient.flasharray.PodPerformanceReplicationByArrayGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[PodPerformanceReplicationByArray]] = None, total: Optional[ConstrainedListValue[PodPerformanceReplicationByArray]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[PodPerformanceReplicationByArray]] = None

A list of pod performance replication objects, arranged by array.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total: Optional[ConstrainedListValue[PodPerformanceReplicationByArray]] = None

The aggregate value of all items after filtering. When applicable, the average value is displayed instead. The values are displayed for each field if meaningful.

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

PodPerformanceReplicationByArrayResponse

pydantic model pypureclient.flasharray.PodPerformanceReplicationByArrayResponse(*, items: Optional[ConstrainedListValue[PodPerformanceReplicationByArray]] = None, total: Optional[ConstrainedListValue[PodPerformanceReplicationByArray]] = None)
field items: Optional[ConstrainedListValue[PodPerformanceReplicationByArray]] = None

A list of pod performance replication objects, arranged by array.

field total: Optional[ConstrainedListValue[PodPerformanceReplicationByArray]] = None

The aggregate value of all items after filtering. When applicable, the average value is displayed instead. The values are displayed for each field if meaningful.

PodPerformanceReplicationGetResponse

pydantic model pypureclient.flasharray.PodPerformanceReplicationGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[PodPerformanceReplication]] = None, total: Optional[ConstrainedListValue[PodPerformanceReplication]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[PodPerformanceReplication]] = None

A list of pod performance replication objects.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total: Optional[ConstrainedListValue[PodPerformanceReplication]] = None

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. When applicable, the average value is displayed instead. The values are displayed for each field if meaningful.

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

PodPerformanceReplicationResponse

pydantic model pypureclient.flasharray.PodPerformanceReplicationResponse(*, items: Optional[ConstrainedListValue[PodPerformanceReplication]] = None, total: Optional[ConstrainedListValue[PodPerformanceReplication]] = None)
field items: Optional[ConstrainedListValue[PodPerformanceReplication]] = None

A list of pod performance replication objects.

field total: Optional[ConstrainedListValue[PodPerformanceReplication]] = None

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. When applicable, the average value is displayed instead. The values are displayed for each field if meaningful.

PodPost

pydantic model pypureclient.flasharray.PodPost(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, failover_preferences: Optional[ConstrainedListValue[Reference]] = None, quota_limit: Optional[ConstrainedIntValue] = None, source: Optional[Reference] = None, tags: Optional[ConstrainedListValue[Tag]] = None)
field failover_preferences: Optional[ConstrainedListValue[Reference]] = None

Determines which array within a stretched pod should be given priority to stay online should the arrays ever lose contact with each other. The current array and any peer arrays that are connected to the current array for synchronous replication can be added to a pod for failover preference. By default, failover_preferences=null, meaning no arrays have been configured for failover preference. Enter multiple arrays in comma-separated format. To clear the list of failover preferences, set to an empty list [].

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field name: Optional[StrictStr] = None

A locally unique, system-generated name. The name cannot be modified.

field quota_limit: Optional[ConstrainedIntValue] = None

The logical quota limit of the pod, measured in bytes. Must be a multiple of 512.

Constraints

  • minimum = 1048576

  • maximum = 4503599627370496

field source: Optional[Reference] = None

The source pod from where data is cloned to create the new pod.

field tags: Optional[ConstrainedListValue[Tag]] = None

The list of tags to be upserted with the object.

PodReplicaLinkGetResponse

pydantic model pypureclient.flasharray.PodReplicaLinkGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[PodReplicaLink]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[PodReplicaLink]] = None

A list of pod replica link objects.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

PodReplicaLinkLag

pydantic model pypureclient.flasharray.PodReplicaLinkLag(*, id: Optional[StrictStr] = None, context: Optional[FixedReference] = None, direction: Optional[StrictStr] = None, lag: Optional[ReplicaLinkLag] = None, local_pod: Optional[FixedReference] = None, recovery_point: Optional[StrictInt] = None, remote_pod: Optional[FixedReference] = None, remotes: Optional[ConstrainedListValue[FixedReference]] = None, status: Optional[StrictStr] = None, time: Optional[StrictInt] = None)
field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field direction: Optional[StrictStr] = None

The direction of replication. Valid values include inbound and outbound.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field lag: Optional[ReplicaLinkLag] = None

Duration in milliseconds that indicates how far behind the replication target is from the source.

field local_pod: Optional[FixedReference] = None

Reference to a local pod.

field recovery_point: Optional[StrictInt] = None

Time when the last piece of data was replicated, in milliseconds since the UNIX epoch, and the recovery point if the pod is promoted. If the pod is baselining then the value is null.

field remote_pod: Optional[FixedReference] = None

Reference to a remote pod.

field remotes: Optional[ConstrainedListValue[FixedReference]] = None

Reference to a remote array.

field status: Optional[StrictStr] = None

Status of the replica-link. Valid values include replicating, baselining, paused, quiescing, quiesced, idle, and unhealthy.

field time: Optional[StrictInt] = None

Sample time in milliseconds since the UNIX epoch.

PodReplicaLinkLagGetResponse

pydantic model pypureclient.flasharray.PodReplicaLinkLagGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[PodReplicaLinkLag]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[PodReplicaLinkLag]] = None

A list of pod replica link lag objects.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

PodReplicaLinkLagResponse

pydantic model pypureclient.flasharray.PodReplicaLinkLagResponse(*, items: Optional[ConstrainedListValue[PodReplicaLinkLag]] = None)
field items: Optional[ConstrainedListValue[PodReplicaLinkLag]] = None

A list of pod replica link lag objects.

PodReplicaLinkMappingPolicyGetResponse

pydantic model pypureclient.flasharray.PodReplicaLinkMappingPolicyGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[MappingPolicy]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[MappingPolicy]] = None

A list of policy mappings.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

PodReplicaLinkMappingPolicyResponse

pydantic model pypureclient.flasharray.PodReplicaLinkMappingPolicyResponse(*, items: Optional[ConstrainedListValue[MappingPolicy]] = None)
field items: Optional[ConstrainedListValue[MappingPolicy]] = None

A list of policy mappings.

PodReplicaLinkPatch

pydantic model pypureclient.flasharray.PodReplicaLinkPatch(*, paused: Optional[StrictBool] = None)
field paused: Optional[StrictBool] = None

Returns a value of true if the replica link is to be created in a paused state. Returns a value of false if the replica link is to be created not in a paused state. If not specified, defaults to false.

Constraints

  • type = boolean

PodReplicaLinkPerformanceReplication

pydantic model pypureclient.flasharray.PodReplicaLinkPerformanceReplication(*, id: Optional[StrictStr] = None, bytes_per_sec_from_remote: Optional[ConstrainedIntValue] = None, bytes_per_sec_to_remote: Optional[ConstrainedIntValue] = None, bytes_per_sec_total: Optional[ConstrainedIntValue] = None, direction: Optional[StrictStr] = None, local_pod: Optional[FixedReference] = None, remote_pod: Optional[FixedReference] = None, remotes: Optional[ConstrainedListValue[FixedReference]] = None, time: Optional[StrictInt] = None, context: Optional[FixedReference] = None)
field bytes_per_sec_from_remote: Optional[ConstrainedIntValue] = None

The number of bytes received per second from a remote array.

Constraints

  • minimum = 0

field bytes_per_sec_to_remote: Optional[ConstrainedIntValue] = None

The number of bytes transmitted per second to a remote array.

Constraints

  • minimum = 0

field bytes_per_sec_total: Optional[ConstrainedIntValue] = None

Total bytes transmitted and received per second.

Constraints

  • minimum = 0

field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field direction: Optional[StrictStr] = None

The direction of replication. Valid values are inbound and outbound.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field local_pod: Optional[FixedReference] = None

Reference to a local pod.

field remote_pod: Optional[FixedReference] = None

Reference to a remote pod.

field remotes: Optional[ConstrainedListValue[FixedReference]] = None

Reference to a remote array.

field time: Optional[StrictInt] = None

Sample time in milliseconds since the UNIX epoch.

PodReplicaLinkPerformanceReplicationGetResponse

pydantic model pypureclient.flasharray.PodReplicaLinkPerformanceReplicationGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[PodReplicaLinkPerformanceReplication]] = None, total: Optional[ConstrainedListValue[PodReplicaLinkPerformanceReplication]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[PodReplicaLinkPerformanceReplication]] = None

A list of pod replica link performance objects.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total: Optional[ConstrainedListValue[PodReplicaLinkPerformanceReplication]] = None

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 field where meaningful.

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

PodReplicaLinkPerformanceReplicationResponse

pydantic model pypureclient.flasharray.PodReplicaLinkPerformanceReplicationResponse(*, items: Optional[ConstrainedListValue[PodReplicaLinkPerformanceReplication]] = None, total: Optional[ConstrainedListValue[PodReplicaLinkPerformanceReplication]] = None)
field items: Optional[ConstrainedListValue[PodReplicaLinkPerformanceReplication]] = None

A list of pod replica link performance objects.

field total: Optional[ConstrainedListValue[PodReplicaLinkPerformanceReplication]] = None

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 field where meaningful.

PodReplicaLinkReference

pydantic model pypureclient.flasharray.PodReplicaLinkReference(*, id: Optional[StrictStr] = None, local_pod: Optional[FixedReference] = None, remote_pod: Optional[FixedReference] = None, remotes: Optional[ConstrainedListValue[FixedReference]] = None)
field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field local_pod: Optional[FixedReference] = None

Reference to a local pod.

field remote_pod: Optional[FixedReference] = None

Reference to a remote pod.

field remotes: Optional[ConstrainedListValue[FixedReference]] = None

Reference to remote arrays.

PodReplicaLinkResponse

pydantic model pypureclient.flasharray.PodReplicaLinkResponse(*, items: Optional[ConstrainedListValue[PodReplicaLink]] = None)
field items: Optional[ConstrainedListValue[PodReplicaLink]] = None

A list of pod replica link objects.

PodResponse

pydantic model pypureclient.flasharray.PodResponse(*, items: Optional[ConstrainedListValue[Pod]] = None)
field items: Optional[ConstrainedListValue[Pod]] = None

PodSpace

pydantic model pypureclient.flasharray.PodSpace(*, data_reduction: Optional[Union[StrictFloat, StrictInt]] = None, footprint: Optional[ConstrainedIntValue] = None, shared: Optional[ConstrainedIntValue] = None, snapshots: Optional[ConstrainedIntValue] = None, system: Optional[ConstrainedIntValue] = None, thin_provisioning: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, total_physical: Optional[ConstrainedIntValue] = None, total_provisioned: Optional[ConstrainedIntValue] = None, total_reduction: Optional[Union[StrictFloat, StrictInt]] = None, total_used: Optional[ConstrainedIntValue] = None, unique: Optional[ConstrainedIntValue] = None, used_provisioned: Optional[ConstrainedIntValue] = None, virtual: Optional[ConstrainedIntValue] = None, replication: Optional[ConstrainedIntValue] = None, replication_effective: Optional[ConstrainedIntValue] = None, shared_effective: Optional[ConstrainedIntValue] = None)
field data_reduction: Optional[Union[StrictFloat, StrictInt]] = None

The ratio of mapped sectors within a volume versus the amount of physical space the data occupies after data compression and deduplication. The data reduction ratio does not include thin provisioning savings. For example, a data reduction ratio of 5&#58;1 means that for every 5 MB the host writes to the array, 1 MB is stored on the array’s flash modules.

field footprint: Optional[ConstrainedIntValue] = None

The maximum amount of physical space the container consumes on an array, ignoring any data shared outside the container, measured in bytes. On Evergreen//One arrays, this is the maximum amount of effective used space. The footprint metric is mostly used for capacity planning. This field will be null in non-container contexts.

Constraints

  • minimum = 0

field replication: Optional[ConstrainedIntValue] = None

The space consumed by unique data that has not been replicated to the target pod, on source pods. The space consumed by unique data that has been replicated to the target, but not yet incorporated into the target pod, on target pods. On Evergreen//One arrays, the effective space consumed by unique data that has not been replicated to the target pod, on source pods. The effective space consumed by unique data that has been replicated to the target, but not yet incorporated into the target pod, on target pods.

Constraints

  • minimum = 0

field replication_effective: Optional[ConstrainedIntValue] = None

This field has been deprecated. The effective space consumed by unique data that has not been replicated to the target pod, on source pods. The effective space consumed by unique data that has been replicated to the target but not yet incorporated into the target pod, on target pods. Please use the replication field in the future, as it contains the same information for Evergreen//One arrays.

Constraints

  • minimum = 0

field shared: Optional[ConstrainedIntValue] = None

The physical space occupied by deduplicated data, meaning that the space is shared with other volumes and snapshots as a result of data deduplication. Measured in bytes. On Evergreen//One arrays, this is the effective space contributed by data that is not unique to a specific volume, managed directory, or snapshot, measured in bytes.

Constraints

  • minimum = 0

field shared_effective: Optional[ConstrainedIntValue] = None

This field has been deprecated. The effective space contributed by data that is not unique to a specific volume, managed directory, or snapshot, measured in bytes. Please use the shared field in the future, as it contains the same information for Evergreen//One arrays.

Constraints

  • minimum = 0

field snapshots: Optional[ConstrainedIntValue] = None

The physical space occupied by data unique to one or more snapshots. Measured in bytes. On Evergreen//One arrays, this is the effective space contributed by data unique to one or more snapshots, measured in bytes.

Constraints

  • minimum = 0

field system: Optional[ConstrainedIntValue] = None

The physical space occupied by internal array metadata. Measured in bytes.

Constraints

  • minimum = 0

field thin_provisioning: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

The percentage of volume sectors that do not contain host-written data because the hosts have not written data to them or the sectors have been explicitly trimmed.

field total_physical: Optional[ConstrainedIntValue] = None

This field has been deprecated. Use the total_used field, as it contains the same information.

Constraints

  • minimum = 0

field total_provisioned: Optional[ConstrainedIntValue] = None

The provisioned size of a volume for a single volume, host or host group, protocol endpoint, managed directory, and containers can be infinite or measured in bytes. Infinite is represented by null. The provisioned size for a host or host group, includes all volumes that are connected to the resource. The provisioned size for a protocol endpoint is null’. The provisioned size for a managed directory is the quota limit if it or its parent has a managed directory configured, otherwise it defaults to `null. The provisioned size for a container is the sum of the total_provisioned of the object it contains, capped by the container’s quota limit (or the container’s used_provisioned if current usage is above the quota limit), if any. Provisioned size represents the storage capacity reported to hosts.

Constraints

  • minimum = 0

field total_reduction: Optional[Union[StrictFloat, StrictInt]] = None

The ratio of provisioned sectors within a volume versus the amount of physical space the data occupies after reduction via data compression and deduplication and with thin provisioning savings. Total reduction is data reduction with thin provisioning savings. For example, a total reduction ratio of 10&#58;1 means that for every 10 MB of provisioned space, 1 MB is stored on the array’s flash modules.

field total_used: Optional[ConstrainedIntValue] = None

The total space contributed by customer data, measured in bytes.

Constraints

  • minimum = 0

field unique: Optional[ConstrainedIntValue] = None

The unique physical space occupied by customer data. Unique physical space does not include shared space, snapshots, and internal array metadata. Measured in bytes. On Evergreen//One arrays, this is the effective space contributed by unique customer data, measured in bytes. Unique data does not include shared space, snapshots, and internal array metadata.

Constraints

  • minimum = 0

field used_provisioned: Optional[ConstrainedIntValue] = None

The amount of logical space a container has consumed, compared against the quota limit if the container has one configured. Used provisioned does not include destroyed objects inside the container. Used provisioned can include destroyed objects for a destroyed container and represents how much logical space it would take to recover the container.

Constraints

  • minimum = 0

field virtual: Optional[ConstrainedIntValue] = None

The amount of logically written data that a volume or a snapshot references. Measured in bytes.

Constraints

  • minimum = 0

Policy

pydantic model pypureclient.flasharray.Policy(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, context: Optional[FixedReference] = None, destroyed: Optional[StrictBool] = None, enabled: Optional[StrictBool] = None, pod: Optional[Reference] = None, policy_type: Optional[StrictStr] = None, time_remaining: Optional[StrictInt] = None)
field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field destroyed: Optional[StrictBool] = None

Returns a value of true if the policy has been destroyed and is pending eradication. The time_remaining value displays the amount of time left until the destroyed policy is permanently eradicated. Once the time_remaining period has elapsed, the policy is permanently eradicated and can no longer be recovered.

Constraints

  • type = boolean

field enabled: Optional[StrictBool] = None

Returns a value of true if the policy is enabled.

Constraints

  • type = boolean

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

field pod: Optional[Reference] = None

A reference to the pod.

field policy_type: Optional[StrictStr] = None

The type of policy. Valid values include autodir, nfs, smb, snapshot, and quota.

field time_remaining: Optional[StrictInt] = None

The amount of time left, measured in milliseconds, until the destroyed policy is permanently eradicated.

PolicyAssignmentPost

pydantic model pypureclient.flasharray.PolicyAssignmentPost(*, policies: Optional[ConstrainedListValue[PolicyAssignmentPostPolicy]] = None)
field policies: Optional[ConstrainedListValue[PolicyAssignmentPostPolicy]] = None

A list of policies to apply to the resource. One of id or name is required in each policy.

PolicyAssignmentPostPolicy

pydantic model pypureclient.flasharray.PolicyAssignmentPostPolicy(*, policy: Optional[Reference] = None)
field policy: Optional[Reference] = None

Reference to the policy to apply to the resource.

PolicyAuditFile

pydantic model pypureclient.flasharray.PolicyAuditFile(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, context: Optional[FixedReference] = None, destroyed: Optional[StrictBool] = None, enabled: Optional[StrictBool] = None, pod: Optional[Reference] = None, policy_type: Optional[StrictStr] = None, time_remaining: Optional[StrictInt] = None, log_targets: Optional[ConstrainedListValue[ReferenceNoIdWithType]] = None)
field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field destroyed: Optional[StrictBool] = None

Returns a value of true if the policy has been destroyed and is pending eradication. The time_remaining value displays the amount of time left until the destroyed policy is permanently eradicated. Once the time_remaining period has elapsed, the policy is permanently eradicated and can no longer be recovered.

Constraints

  • type = boolean

field enabled: Optional[StrictBool] = None

Returns a value of true if the policy is enabled.

Constraints

  • type = boolean

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field log_targets: Optional[ConstrainedListValue[ReferenceNoIdWithType]] = None

A list of targets to which audit logs will be sent.

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

field pod: Optional[Reference] = None

A reference to the pod.

field policy_type: Optional[StrictStr] = None

The type of policy. Valid values include autodir, nfs, smb, snapshot, and quota.

field time_remaining: Optional[StrictInt] = None

The amount of time left, measured in milliseconds, until the destroyed policy is permanently eradicated.

PolicyAuditFileGetResponse

pydantic model pypureclient.flasharray.PolicyAuditFileGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[PolicyAuditFile]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[PolicyAuditFile]] = None

Displays a list of all items after filtering. If applicable, the values are displayed for each name.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

PolicyAuditFilePatch

pydantic model pypureclient.flasharray.PolicyAuditFilePatch(*, name: Optional[StrictStr] = None, enabled: Optional[StrictBool] = None, log_targets: Optional[ConstrainedListValue[ReferenceNoIdWithType]] = None)
field enabled: Optional[StrictBool] = None

If set to true, enables the policy. If set to false, disables the policy.

Constraints

  • type = boolean

field log_targets: Optional[ConstrainedListValue[ReferenceNoIdWithType]] = None

A list of targets to which audit logs will be sent. This list, if sent, overrides existing target list.

field name: Optional[StrictStr] = None

The new name for the resource.

PolicyAuditFilePost

pydantic model pypureclient.flasharray.PolicyAuditFilePost(*, enabled: Optional[StrictBool] = None, log_targets: Optional[ConstrainedListValue[ReferenceNoIdWithType]] = None)
field enabled: Optional[StrictBool] = None

If set to true, enables the policy. If set to false, disables the policy.

Constraints

  • type = boolean

field log_targets: Optional[ConstrainedListValue[ReferenceNoIdWithType]] = None

A list of targets to which audit logs will be sent.

PolicyAuditFileResponse

pydantic model pypureclient.flasharray.PolicyAuditFileResponse(*, items: Optional[ConstrainedListValue[PolicyAuditFile]] = None)
field items: Optional[ConstrainedListValue[PolicyAuditFile]] = None

Displays a list of all items after filtering. If applicable, the values are displayed for each name.

PolicyGetResponse

pydantic model pypureclient.flasharray.PolicyGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Policy]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[Policy]] = None

Displays a list of all items after filtering. If applicable, the values are displayed for each name.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

PolicyManagementAccess

pydantic model pypureclient.flasharray.PolicyManagementAccess(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, context: Optional[FixedReference] = None, aggregation_strategy: Optional[StrictStr] = None, enabled: Optional[StrictBool] = None, policy_type: Optional[StrictStr] = None, rules: Optional[ConstrainedListValue[PolicyrulemanagementaccessRules]] = None)
field aggregation_strategy: Optional[StrictStr] = None

When this is set to least-common-permissions, any users to whom this policy applies can receive no access rights exceeding those defined in this policy’s rules. When this is set to all-permissions, any users to whom this policy applies are capable of receiving additional access rights from other policies that apply to them.

field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field enabled: Optional[StrictBool] = None

Returns a value of true if the policy is enabled.

Constraints

  • type = boolean

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

field policy_type: Optional[StrictStr] = None

The type of policy. Valid values include management-access, autodir, nfs, smb, snapshot, and quota.

field rules: Optional[ConstrainedListValue[PolicyrulemanagementaccessRules]] = None

List the rules that defines the scoped roles.

PolicyManagementAccessEffective

pydantic model pypureclient.flasharray.PolicyManagementAccessEffective(*, details: Optional[StrictStr] = None, rules: Optional[ConstrainedListValue[PolicyrulemanagementaccessRules]] = None)
field details: Optional[StrictStr] = None

Additional details about policy resolution.

field rules: Optional[ConstrainedListValue[PolicyrulemanagementaccessRules]] = None

List the rules that defines the scoped roles.

PolicyManagementAccessGetResponse

pydantic model pypureclient.flasharray.PolicyManagementAccessGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[PolicyManagementAccess]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[PolicyManagementAccess]] = None

Displays a list of all items after filtering. If applicable, the values are displayed for each name.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

PolicyManagementAccessPatch

pydantic model pypureclient.flasharray.PolicyManagementAccessPatch(*, name: Optional[StrictStr] = None, aggregation_strategy: Optional[StrictStr] = None, enabled: Optional[StrictBool] = None, rules: Optional[ConstrainedListValue[PolicyrulemanagementaccessRules]] = None)
field aggregation_strategy: Optional[StrictStr] = None

When this is set to least-common-permissions, any users to whom this policy applies can receive no access rights exceeding those defined in this policy’s capability and resource. When this is set to all-permissions, any users to whom this policy applies are capable of receiving additional access rights from other policies that apply to them.

field enabled: Optional[StrictBool] = None

Sets whether the policy is enabled and grants the permissions specified.

Constraints

  • type = boolean

field name: Optional[StrictStr] = None

The new name for the resource.

field rules: Optional[ConstrainedListValue[PolicyrulemanagementaccessRules]] = None

List the rules that defines the scoped roles.

PolicyManagementAccessPost

pydantic model pypureclient.flasharray.PolicyManagementAccessPost(*, enabled: Optional[StrictBool] = None, aggregation_strategy: Optional[StrictStr] = None, rules: Optional[ConstrainedListValue[PolicyrulemanagementaccessRules]] = None)
field aggregation_strategy: Optional[StrictStr] = None

When set to least-common-permissions, any users to whom this policy applies can receive no access rights exceeding those defined in this policy’s capability and resource. When this is set to all-permissions, any users to whom this policy applies are capable of receiving additional access rights from other policies that apply to them. If not specified, defaults to all-permissions.

field enabled: Optional[StrictBool] = None

If set to true, enables the policy. If set to false, disables the policy.

Constraints

  • type = boolean

field rules: Optional[ConstrainedListValue[PolicyrulemanagementaccessRules]] = None

List the rules that defines the scoped roles.

PolicyManagementAccessResponse

pydantic model pypureclient.flasharray.PolicyManagementAccessResponse(*, items: Optional[ConstrainedListValue[PolicyManagementAccess]] = None)
field items: Optional[ConstrainedListValue[PolicyManagementAccess]] = None

Displays a list of all items after filtering. If applicable, the values are displayed for each name.

PolicyMember

pydantic model pypureclient.flasharray.PolicyMember(*, context: Optional[FixedReference] = None, destroyed: Optional[StrictBool] = None, enabled: Optional[StrictBool] = None, member: Optional[FixedReferenceWithType] = None, policy: Optional[FixedReferenceWithType] = None, time_remaining: Optional[StrictInt] = None)
field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field destroyed: Optional[StrictBool] = None

Returns a value of true if the member is destroyed.

Constraints

  • type = boolean

field enabled: Optional[StrictBool] = None

Returns a value of true if the policy is enabled.

Constraints

  • type = boolean

field member: Optional[FixedReferenceWithType] = None

Reference to the resource that the policy is applied to.

field policy: Optional[FixedReferenceWithType] = None

Reference to the policy.

field time_remaining: Optional[StrictInt] = None

The amount of time left, in milliseconds, until the destroyed policy member is permanently eradicated.

PolicyMemberClean

pydantic model pypureclient.flasharray.PolicyMemberClean(*, context: Optional[FixedReference] = None, member: Optional[FixedReferenceWithType] = None, policy: Optional[FixedReferenceWithType] = None)
field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field member: Optional[FixedReferenceWithType] = None

Reference to the resource that the policy is applied to.

field policy: Optional[FixedReferenceWithType] = None

Reference to the policy.

PolicyMemberCleanGetResponse

pydantic model pypureclient.flasharray.PolicyMemberCleanGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[PolicyMemberClean]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[PolicyMemberClean]] = None

Displays a list of all items after filtering. The values are displayed for each name, if meaningful.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

PolicyMemberCleanResponse

pydantic model pypureclient.flasharray.PolicyMemberCleanResponse(*, items: Optional[ConstrainedListValue[PolicyMemberClean]] = None)
field items: Optional[ConstrainedListValue[PolicyMemberClean]] = None

Displays a list of all items after filtering. The values are displayed for each name, if meaningful.

PolicyMemberExport

pydantic model pypureclient.flasharray.PolicyMemberExport(*, context: Optional[FixedReference] = None, destroyed: Optional[StrictBool] = None, enabled: Optional[StrictBool] = None, member: Optional[FixedReferenceWithType] = None, policy: Optional[FixedReferenceWithType] = None, time_remaining: Optional[StrictInt] = None, export_name: Optional[StrictStr] = None, status: Optional[StrictStr] = None)
field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field destroyed: Optional[StrictBool] = None

Returns a value of true if the member is destroyed.

Constraints

  • type = boolean

field enabled: Optional[StrictBool] = None

Returns a value of true if and only if the export policy that manages this export is enabled AND this export is enabled.

Constraints

  • type = boolean

field export_name: Optional[StrictStr] = None

The export name for accessing this export.

field member: Optional[FixedReferenceWithType] = None

Reference to the resource that the policy is applied to.

field policy: Optional[FixedReferenceWithType] = None

Reference to the policy.

field status: Optional[StrictStr] = None

Explains why enabled is false, or whether there is a name conflict with another export. Valid values include policy_disabled, export_disabled, and name_conflict.

field time_remaining: Optional[StrictInt] = None

The amount of time left, in milliseconds, until the destroyed policy member is permanently eradicated.

PolicyMemberExportGetResponse

pydantic model pypureclient.flasharray.PolicyMemberExportGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[PolicyMemberExport]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[PolicyMemberExport]] = None

Displays a list of all items after filtering. The values are displayed for each name, if meaningful.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

PolicyMemberExportPost

pydantic model pypureclient.flasharray.PolicyMemberExportPost(*, members: Optional[ConstrainedListValue[PolicymemberexportpostMembers]] = None)
field members: Optional[ConstrainedListValue[PolicymemberexportpostMembers]] = None

A list of directories to which the export policy may be applied.

PolicyMemberExportResponse

pydantic model pypureclient.flasharray.PolicyMemberExportResponse(*, items: Optional[ConstrainedListValue[PolicyMemberExport]] = None)
field items: Optional[ConstrainedListValue[PolicyMemberExport]] = None

Displays a list of all items after filtering. The values are displayed for each name, if meaningful.

PolicyMemberGetResponse

pydantic model pypureclient.flasharray.PolicyMemberGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[PolicyMember]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[PolicyMember]] = None

Displays a list of all items after filtering. The values are displayed for each name, if meaningful.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

PolicyMemberPost

pydantic model pypureclient.flasharray.PolicyMemberPost(*, members: Optional[ConstrainedListValue[PolicymemberpostMembers]] = None)
field members: Optional[ConstrainedListValue[PolicymemberpostMembers]] = None

A list of resources to which the policy may be applied.

PolicyMemberResponse

pydantic model pypureclient.flasharray.PolicyMemberResponse(*, items: Optional[ConstrainedListValue[PolicyMember]] = None)
field items: Optional[ConstrainedListValue[PolicyMember]] = None

Displays a list of all items after filtering. The values are displayed for each name, if meaningful.

PolicyNfs

pydantic model pypureclient.flasharray.PolicyNfs(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, context: Optional[FixedReference] = None, destroyed: Optional[StrictBool] = None, enabled: Optional[StrictBool] = None, pod: Optional[Reference] = None, policy_type: Optional[StrictStr] = None, time_remaining: Optional[StrictInt] = None, nfs_version: Optional[ConstrainedListValue[StrictStr]] = None, policy_mapping: Optional[PolicyNfsPolicyMapping] = None, security: Optional[ConstrainedListValue[StrictStr]] = None, user_mapping_enabled: Optional[StrictBool] = None)
field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field destroyed: Optional[StrictBool] = None

Returns a value of true if the policy has been destroyed and is pending eradication. The time_remaining value displays the amount of time left until the destroyed policy is permanently eradicated. Once the time_remaining period has elapsed, the policy is permanently eradicated and can no longer be recovered.

Constraints

  • type = boolean

field enabled: Optional[StrictBool] = None

Returns a value of true if the policy is enabled.

Constraints

  • type = boolean

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

field nfs_version: Optional[ConstrainedListValue[StrictStr]] = None

NFS protocol version allowed for the export. If NFS version is allowed for all rules of the policy it is cascaded exactly as: nfsv3, nfsv4. If the NFS version is supported partially by the rules of the policy it will be cascaded as: nfsv3-partial, nfsv4-partial. If the NFS version is not supported by any rules or there are no rules of the policy then it will not be in the result array. If there are no rules in the policy the array will be empty. If there are two rules, one supporting nfsv3 and the other supporting nfsv3 and nfsv4 then the array would contain nfsv3 and nfsv4-partial.

field pod: Optional[Reference] = None

A reference to the pod.

field policy_mapping: Optional[PolicyNfsPolicyMapping] = None

Specifies the mapping of this policy across a pod replica link. If this policy is not inside a pod of a pod replica link, mapping is null.

field policy_type: Optional[StrictStr] = None

The type of policy. Valid values include autodir, nfs, smb, snapshot, and quota.

field security: Optional[ConstrainedListValue[StrictStr]] = None

The security flavors to use for accessing files on this mount point. Values include auth_sys, auth_sys-partial, krb5, krb5-partial, krb5i, and krb5p. If the server does not support the requested flavor, the mount operation fails. If auth_sys, the client is trusted to specify the identity of the user. If krb5, cryptographic proof of the identity of the user is provided in each RPC request. Note that additional configuration besides adding this mount option is required in order to enable Kerberos security. If krb5i, integrity checking is added to krb5, to ensure the data has not been tampered with. If krb5p, integrity checking and encryption are added to krb5. This is the most secure setting, but it also involves the most performance overhead. If security option is allowed for all rules of the policy, it is cascaded exactly. Examples: auth_sys, krb5. If the security option is supported partially by the rules of the policy, it will be cascaded with the -partial suffix. Examples include: auth_sys-partial, krb5-partial. If the security option is not supported by any rules or there are no rules of the policy, then it will not be in the result array. If there are no rules in the policy the array of values will be empty. If there are two rules, one supporting auth_sys and the other supporting auth_sys and krb5 the array of values would contain auth_sys and krb5-partial.

field time_remaining: Optional[StrictInt] = None

The amount of time left, measured in milliseconds, until the destroyed policy is permanently eradicated.

field user_mapping_enabled: Optional[StrictBool] = None

Returns true if user mapping is enabled on the policy. If true, FlashArray queries the joined AD/OpenLDAP server to find the user corresponding to the incoming UID. If false, users are defined by UID/GID pair.

Constraints

  • type = boolean

PolicyNfsGetResponse

pydantic model pypureclient.flasharray.PolicyNfsGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[PolicyNfs]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[PolicyNfs]] = None

Displays a list of all items after filtering. If applicable, the values are displayed for each name.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

PolicyNfsPatch

pydantic model pypureclient.flasharray.PolicyNfsPatch(*, name: Optional[StrictStr] = None, enabled: Optional[StrictBool] = None, nfs_version: Optional[ConstrainedListValue[StrictStr]] = None, security: Optional[ConstrainedListValue[StrictStr]] = None, user_mapping_enabled: Optional[StrictBool] = None)
field enabled: Optional[StrictBool] = None

If set to true, enables the policy. If set to false, disables the policy.

Constraints

  • type = boolean

field name: Optional[StrictStr] = None

The new name for the resource.

field nfs_version: Optional[ConstrainedListValue[StrictStr]] = None

NFS protocol version allowed for the export to set for the policy. This operation updates all rules of the specified policy. Valid values are nfsv3 and nfsv4.

field security: Optional[ConstrainedListValue[StrictStr]] = None

The security flavors to use for accessing files on this mount point. Values include auth_sys, krb5, krb5i, and krb5p. If the server does not support the requested flavor, the mount operation fails. This operation updates all rules of the specified policy. If auth_sys, the client is trusted to specify the identity of the user. If krb5, cryptographic proof of the identity of the user is provided in each RPC request. This provides strong verification of the identity of users accessing data on the server. Note that additional configuration besides adding this mount option is required to enable Kerberos security. If krb5i, integrity checking is added to krb5. This ensures the data has not been tampered with. If krb5p, integrity checking and encryption is added to krb5. This is the most secure setting, but it also involves the most performance overhead.

field user_mapping_enabled: Optional[StrictBool] = None

If set to true, FlashArray queries the joined AD/OpenLDAP server to find the user corresponding to the incoming UID. If set to false, users are defined by UID/GID pair.

Constraints

  • type = boolean

PolicyNfsPolicyMapping

pydantic model pypureclient.flasharray.PolicyNfsPolicyMapping(*, mapping: Optional[StrictStr] = None, remote_policy: Optional[StrictStr] = None)
field mapping: Optional[StrictStr] = None

The mapping of this policy. Valid values are connected and disconnected.

field remote_policy: Optional[StrictStr] = None

The policy on the remote pod of the pod replica link for this policy mapping.

PolicyNfsPost

pydantic model pypureclient.flasharray.PolicyNfsPost(*, enabled: Optional[StrictBool] = None, policy_mapping: Optional[PolicynfspostPolicyMapping] = None, user_mapping_enabled: Optional[StrictBool] = None)
field enabled: Optional[StrictBool] = None

If set to true, enables the policy. If set to false, disables the policy.

Constraints

  • type = boolean

field policy_mapping: Optional[PolicynfspostPolicyMapping] = None
field user_mapping_enabled: Optional[StrictBool] = None

If set to true, FlashArray queries the joined AD/OpenLDAP server to find the user corresponding to the incoming UID. If set to false, users are defined by UID/GID pair. If not specified, defaults to true.

Constraints

  • type = boolean

PolicyNfsResponse

pydantic model pypureclient.flasharray.PolicyNfsResponse(*, items: Optional[ConstrainedListValue[PolicyNfs]] = None)
field items: Optional[ConstrainedListValue[PolicyNfs]] = None

Displays a list of all items after filtering. If applicable, the values are displayed for each name.

PolicyPassword

pydantic model pypureclient.flasharray.PolicyPassword(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, context: Optional[FixedReference] = None, enabled: Optional[StrictBool] = None, enforce_dictionary_check: Optional[StrictBool] = None, enforce_username_check: Optional[StrictBool] = None, lockout_duration: Optional[ConstrainedIntValue] = None, max_login_attempts: Optional[ConstrainedIntValue] = None, max_password_age: Optional[ConstrainedIntValue] = None, min_character_groups: Optional[ConstrainedIntValue] = None, min_characters_per_group: Optional[ConstrainedIntValue] = None, min_password_age: Optional[ConstrainedIntValue] = None, min_password_length: Optional[ConstrainedIntValue] = None, password_history: Optional[ConstrainedIntValue] = None, policy_type: Optional[StrictStr] = None)
field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field enabled: Optional[StrictBool] = None

Returns a value of true if the policy is enabled.

Constraints

  • type = boolean

field enforce_dictionary_check: Optional[StrictBool] = None

If true, test password against dictionary of known leaked passwords. Only applies to passwords longer than 6 characters.

Constraints

  • type = boolean

field enforce_username_check: Optional[StrictBool] = None

If true, the username cannot be a substring of the password. It only applies to usernames of 3 characters and longer.

Constraints

  • type = boolean

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field lockout_duration: Optional[ConstrainedIntValue] = None

The lockout duration, in milliseconds, if a user is locked out after reaching the maximum number of login attempts. Ranges from 1 second to 90 days.

Constraints

  • minimum = 1000

  • maximum = 7776000000

field max_login_attempts: Optional[ConstrainedIntValue] = None

Maximum number of failed login attempts allowed before the user is locked out.

Constraints

  • minimum = 1

  • maximum = 100

field max_password_age: Optional[ConstrainedIntValue] = None

The maximum age of password before password change is required. Ranges from 1 day to 99999 days, with 0 meaning password expiration is disabled.

Constraints

  • minimum = 0

  • maximum = 8639913600000

field min_character_groups: Optional[ConstrainedIntValue] = None

The minimum number of character groups ([a-z], [A-Z], [0-9], other) required to be present in a password.

Constraints

  • minimum = 0

  • maximum = 4

field min_characters_per_group: Optional[ConstrainedIntValue] = None

The minimum number of characters per group to count the group as present. Maximum is limited by the minimum password length divided by the number of character groups (e.g. min_password_length = 9, min_character_groups = 4, then maximum is 2).

Constraints

  • minimum = 1

field min_password_age: Optional[ConstrainedIntValue] = None

The minimum age, in milliseconds, of password before password change is allowed. Ranges from 0 ms to 7 days

Constraints

  • minimum = 0

  • maximum = 604800000

field min_password_length: Optional[ConstrainedIntValue] = None

Minimum password length. If not specified, defaults to 1.

Constraints

  • minimum = 1

  • maximum = 100

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

field password_history: Optional[ConstrainedIntValue] = None

The number of passwords tracked to prevent reuse of passwords.

Constraints

  • minimum = 0

  • maximum = 64

field policy_type: Optional[StrictStr] = None

The type of policy. Valid values include autodir, nfs, password, smb, snapshot, and quota.

PolicyPasswordGetResponse

pydantic model pypureclient.flasharray.PolicyPasswordGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[PolicyPassword]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[PolicyPassword]] = None

Returns a list of all items after filtering. If applicable, the values are displayed for each name.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

PolicyPasswordResponse

pydantic model pypureclient.flasharray.PolicyPasswordResponse(*, items: Optional[ConstrainedListValue[PolicyPassword]] = None)
field items: Optional[ConstrainedListValue[PolicyPassword]] = None

Returns a list of all items after filtering. If applicable, the values are displayed for each name.

PolicyPatch

pydantic model pypureclient.flasharray.PolicyPatch(*, name: Optional[StrictStr] = None, enabled: Optional[StrictBool] = None)
field enabled: Optional[StrictBool] = None

If set to true, enables the policy. If set to false, disables the policy.

Constraints

  • type = boolean

field name: Optional[StrictStr] = None

The new name for the resource.

PolicyPost

pydantic model pypureclient.flasharray.PolicyPost(*, enabled: Optional[StrictBool] = None)
field enabled: Optional[StrictBool] = None

If set to true, enables the policy. If set to false, disables the policy.

Constraints

  • type = boolean

PolicyResponse

pydantic model pypureclient.flasharray.PolicyResponse(*, items: Optional[ConstrainedListValue[Policy]] = None)
field items: Optional[ConstrainedListValue[Policy]] = None

Displays a list of all items after filtering. If applicable, the values are displayed for each name.

PolicyRuleAlertWatcher

pydantic model pypureclient.flasharray.PolicyRuleAlertWatcher(*, context: Optional[FixedReference] = None, email: Optional[StrictStr] = None, excluded_codes: Optional[ConstrainedListValue[StrictInt]] = None, included_codes: Optional[ConstrainedListValue[StrictInt]] = None, minimum_notification_severity: Optional[StrictStr] = None, name: Optional[StrictStr] = None, policy: Optional[FixedReferenceWithType] = None)
field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field email: Optional[StrictStr] = None

The email address that will receive the alert notification emails.

field excluded_codes: Optional[ConstrainedListValue[StrictInt]] = None

An alert with one of these codes will not have emails sent to the recipient. Cannot be specified with include_codes. If specified while include_codes is already set, include_codes will be cleared. Use “” to clear. If both exclude_codes and include_codes are cleared, defaults to an empty list for exclude_codes and emails for all alert codes will be sent.

field included_codes: Optional[ConstrainedListValue[StrictInt]] = None

An alert must have one of these codes in order for emails to be sent to the recipient. Cannot be specified with exclude_codes. If specified while exclude_codes is already set, exclude_codes will be cleared. Use “” to clear. If both exclude_codes and include_codes are cleared, defaults to an empty list for exclude_codes and emails for all alert codes will be sent.

field minimum_notification_severity: Optional[StrictStr] = None

The minimum severity that an alert must have in order for emails to be sent to the recipient. Possible values include info, warning, and critical.

field name: Optional[StrictStr] = None

Name of this rule. The name is automatically generated by the system.

field policy: Optional[FixedReferenceWithType] = None

The policy to which this rule belongs.

PolicyRuleAlertWatcherGetResponse

pydantic model pypureclient.flasharray.PolicyRuleAlertWatcherGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[PolicyRuleAlertWatcher]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[PolicyRuleAlertWatcher]] = None

Displays a list of all items after filtering. The values are displayed for each name, if meaningful.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

PolicyRuleAlertWatcherPatch

pydantic model pypureclient.flasharray.PolicyRuleAlertWatcherPatch(*, rules: Optional[ConstrainedListValue[PolicyrulealertwatcherpatchRules]] = None)
field rules: Optional[ConstrainedListValue[PolicyrulealertwatcherpatchRules]] = None

Updates an alert-watcher rule in a policy. Only one update object will be accepted.

Constraints

  • maxItems = 1

PolicyRuleAlertWatcherPost

pydantic model pypureclient.flasharray.PolicyRuleAlertWatcherPost(*, rules: Optional[ConstrainedListValue[PolicyrulealertwatcherpostRules]] = None)
field rules: Optional[ConstrainedListValue[PolicyrulealertwatcherpostRules]] = None

A list of alert-watcher policy rules to create.

PolicyRuleAlertWatcherResponse

pydantic model pypureclient.flasharray.PolicyRuleAlertWatcherResponse(*, items: Optional[ConstrainedListValue[PolicyRuleAlertWatcher]] = None)
field items: Optional[ConstrainedListValue[PolicyRuleAlertWatcher]] = None

Displays a list of all items after filtering. The values are displayed for each name, if meaningful.

PolicyRuleNfsClient

pydantic model pypureclient.flasharray.PolicyRuleNfsClient(*, context: Optional[FixedReference] = None, access: Optional[StrictStr] = None, anongid: Optional[StrictStr] = None, anonuid: Optional[StrictStr] = None, client: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, name: Optional[StrictStr] = None, nfs_version: Optional[ConstrainedListValue[StrictStr]] = None, permission: Optional[StrictStr] = None, policy: Optional[FixedReferenceWithType] = None, security: Optional[ConstrainedListValue[StrictStr]] = None, time_remaining: Optional[StrictInt] = None)
field access: Optional[StrictStr] = None

Specifies access control for the export. Valid values are root-squash, all-squash, and no-root-squash. root-squash prevents client users and groups with root privilege from mapping their root privilege to a file system. All users with UID 0 will have their UID mapped to anonuid. All users with GID 0 will have their GID mapped to anongid. all-squash maps all UIDs (including root) to anonuid and all GIDs (including root) to anongid. no-root-squash allows users and groups to access the file system with their UIDs and GIDs. The default is root-squash if not specified.

field anongid: Optional[StrictStr] = None

Any user whose GID is affected by an access of root_squash or all_squash will have their GID mapped to anongid. The default anongid is null, which means 65534. Use “” to clear. This value is ignored when user mapping is enabled - see User Guide for more details.

field anonuid: Optional[StrictStr] = None

Any user whose UID is affected by an access of root_squash or all_squash will have their UID mapped to anonuid. The default anonuid is null, which means 65534. Use “” to clear.

field client: Optional[StrictStr] = None

Specifies the clients that will be permitted to access the export. Accepted notation includes IP, IP mask, or hostname. The default is * if not specified.

field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field destroyed: Optional[StrictBool] = None

Returns a value of true if the pod containing the NFS policy rule has been destroyed and is pending eradication. The time_remaining value displays the amount of time left until the destroyed policy is permanently eradicated. Once the time_remaining period has elapsed, the NFS policy rule is permanently eradicated and can no longer be recovered.

Constraints

  • type = boolean

field name: Optional[StrictStr] = None

Name of this rule. The name is automatically generated by the system.

field nfs_version: Optional[ConstrainedListValue[StrictStr]] = None

The NFS protocol version allowed for the export. Valid values are nfsv3 and nfsv4.

field permission: Optional[StrictStr] = None

Specifies which read-write client access permissions are allowed for the export. Valid values are rw and ro. The default is rw if not specified.

field policy: Optional[FixedReferenceWithType] = None

The policy to which this rule belongs.

field security: Optional[ConstrainedListValue[StrictStr]] = None

The security flavors to use for accessing files on this mount point. Values include auth_sys, krb5, krb5i, and krb5p. If the server does not support the requested flavor, the mount operation fails. This operation updates all rules of the specified policy. If auth_sys, the client is trusted to specify the identity of the user. If krb5, cryptographic proof of the identity of the user is provided in each RPC request. This provides strong verification of the identity of users accessing data on the server. Note that additional configuration besides adding this mount option is required to enable Kerberos security. If krb5i, integrity checking is added to krb5. This ensures the data has not been tampered with. If krb5p, integrity checking and encryption is added to krb5. This is the most secure setting, but it also involves the most performance overhead.

field time_remaining: Optional[StrictInt] = None

The amount of time left, in milliseconds, until the destroyed NFS policy rule is permanently eradicated.

PolicyRuleNfsClientGetResponse

pydantic model pypureclient.flasharray.PolicyRuleNfsClientGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[PolicyRuleNfsClient]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[PolicyRuleNfsClient]] = None

Displays a list of all items after filtering. The values are displayed for each name, if meaningful.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

PolicyRuleNfsClientPost

pydantic model pypureclient.flasharray.PolicyRuleNfsClientPost(*, rules: Optional[ConstrainedListValue[PolicyrulenfsclientpostRules]] = None)
field rules: Optional[ConstrainedListValue[PolicyrulenfsclientpostRules]] = None

A list of NFS policy rules to create.

PolicyRuleNfsClientResponse

pydantic model pypureclient.flasharray.PolicyRuleNfsClientResponse(*, items: Optional[ConstrainedListValue[PolicyRuleNfsClient]] = None)
field items: Optional[ConstrainedListValue[PolicyRuleNfsClient]] = None

Displays a list of all items after filtering. The values are displayed for each name, if meaningful.

PolicyRuleQuota

pydantic model pypureclient.flasharray.PolicyRuleQuota(*, context: Optional[FixedReference] = None, destroyed: Optional[StrictBool] = None, enforced: Optional[StrictBool] = None, name: Optional[StrictStr] = None, notifications: Optional[StrictStr] = None, policy: Optional[FixedReferenceWithType] = None, quota_limit: Optional[StrictInt] = None, time_remaining: Optional[StrictInt] = None)
field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field destroyed: Optional[StrictBool] = None

Returns a value of true if the pod containing the quota policy rule has been destroyed and is pending eradication. The time_remaining value displays the amount of time left until the destroyed policy is permanently eradicated. Once the time_remaining period has elapsed, the quota policy rule is permanently eradicated and can no longer be recovered.

Constraints

  • type = boolean

field enforced: Optional[StrictBool] = None

Defines whether the quota rule is enforced or unenforced. If the quota rule is enforced and logical space usage exceeds the quota limit, any modification operations that result in a need for more space are blocked. If the quota rule is unenforced and logical space usage exceeds the quota limit, notification emails are sent to targets that are specified using the notification parameter. No client operations are blocked when an unenforced limit is exceeded. If set to true, the limit is enforced. If set to false, notification targets are informed when the usage exceeds 80 percent of the limit.

Constraints

  • type = boolean

field name: Optional[StrictStr] = None

Name of this rule. The name is automatically generated by the system.

field notifications: Optional[StrictStr] = None

Targets to notify when usage approaches the quota limit. The list of notification targets is a comma-separated string. Valid values are user, and group. If not specified, notification targets are not assigned for the rule.

field policy: Optional[FixedReferenceWithType] = None

The policy to which this rule belongs.

field quota_limit: Optional[StrictInt] = None

Logical space limit of the quota assigned by the rule, measured in bytes. This value cannot be set to 0.

field time_remaining: Optional[StrictInt] = None

The amount of time left, in milliseconds, until the destroyed quota policy rule is permanently eradicated.

PolicyRuleQuotaGetResponse

pydantic model pypureclient.flasharray.PolicyRuleQuotaGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[PolicyRuleQuota]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[PolicyRuleQuota]] = None

Displays a list of all items after filtering. The values are displayed for each name, if meaningful.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

PolicyRuleQuotaPatch

pydantic model pypureclient.flasharray.PolicyRuleQuotaPatch(*, rules: Optional[ConstrainedListValue[PolicyrulequotapatchRules]] = None)
field rules: Optional[ConstrainedListValue[PolicyrulequotapatchRules]] = None

Updates rules in a policy and accepts a single-rule update object. The list can contain only one item that will update all the specified rules.

Constraints

  • maxItems = 1

PolicyRuleQuotaPost

pydantic model pypureclient.flasharray.PolicyRuleQuotaPost(*, rules: Optional[ConstrainedListValue[PolicyrulequotapostRules]] = None)
field rules: Optional[ConstrainedListValue[PolicyrulequotapostRules]] = None

A list of quota policy rules to create.

PolicyRuleQuotaResponse

pydantic model pypureclient.flasharray.PolicyRuleQuotaResponse(*, items: Optional[ConstrainedListValue[PolicyRuleQuota]] = None)
field items: Optional[ConstrainedListValue[PolicyRuleQuota]] = None

Displays a list of all items after filtering. The values are displayed for each name, if meaningful.

PolicyRuleSmbClient

pydantic model pypureclient.flasharray.PolicyRuleSmbClient(*, context: Optional[FixedReference] = None, anonymous_access_allowed: Optional[StrictBool] = None, client: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, name: Optional[StrictStr] = None, policy: Optional[FixedReferenceWithType] = None, smb_encryption_required: Optional[StrictBool] = None, time_remaining: Optional[StrictInt] = None)
field anonymous_access_allowed: Optional[StrictBool] = None

Specifies whether access to information is allowed for anonymous users. Returns a value of false if not specified.

Constraints

  • type = boolean

field client: Optional[StrictStr] = None

Specifies which clients are given access to the export. Accepted notation includes IP, IP mask, or hostname. The default is * if not specified.

field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field destroyed: Optional[StrictBool] = None

Returns a value of true if the pod containing the SMB policy rule has been destroyed and is pending eradication. The time_remaining value displays the amount of time left until the destroyed policy is permanently eradicated. Once the time_remaining period has elapsed, the SMB policy rule is permanently eradicated and can no longer be recovered.

Constraints

  • type = boolean

field name: Optional[StrictStr] = None

Name of this rule. The name is automatically generated by the system.

field policy: Optional[FixedReferenceWithType] = None

The policy to which this rule belongs.

field smb_encryption_required: Optional[StrictBool] = None

Specifies whether the remote client is required to use SMB encryption. If not specified, defaults to false.

Constraints

  • type = boolean

field time_remaining: Optional[StrictInt] = None

The amount of time left, in milliseconds, until the destroyed SMB policy rule is permanently eradicated.

PolicyRuleSmbClientGetResponse

pydantic model pypureclient.flasharray.PolicyRuleSmbClientGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[PolicyRuleSmbClient]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[PolicyRuleSmbClient]] = None

Displays a list of all items after filtering. The values are displayed for each name, if meaningful.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

PolicyRuleSmbClientPost

pydantic model pypureclient.flasharray.PolicyRuleSmbClientPost(*, rules: Optional[ConstrainedListValue[PolicyrulesmbclientpostRules]] = None)
field rules: Optional[ConstrainedListValue[PolicyrulesmbclientpostRules]] = None

A list of SMB policy rules to create.

PolicyRuleSmbClientResponse

pydantic model pypureclient.flasharray.PolicyRuleSmbClientResponse(*, items: Optional[ConstrainedListValue[PolicyRuleSmbClient]] = None)
field items: Optional[ConstrainedListValue[PolicyRuleSmbClient]] = None

Displays a list of all items after filtering. The values are displayed for each name, if meaningful.

PolicyRuleSnapshot

pydantic model pypureclient.flasharray.PolicyRuleSnapshot(*, context: Optional[FixedReference] = None, at: Optional[StrictInt] = None, client_name: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, every: Optional[StrictInt] = None, keep_for: Optional[StrictInt] = None, name: Optional[StrictStr] = None, policy: Optional[FixedReferenceWithType] = None, suffix: Optional[StrictStr] = None, time_remaining: Optional[StrictInt] = None)
field at: Optional[StrictInt] = None

Specifies the number of milliseconds since midnight at which to take a snapshot. The at value can only be set to an hour and must be between 0 and 82800000, inclusive. The at value can only be set on the rule with the smallest every value. The at value cannot be set if the every value is not measured in days. The at value can only be set for at most one rule in the same policy.

field client_name: Optional[StrictStr] = None

The snapshot client name. A full snapshot name is constructed in the form of DIR.CLIENT_NAME.SUFFIX where DIR is the managed directory name, CLIENT_NAME is the snapshot client name, and SUFFIX is the snapshot suffix. The client visible snapshot name is CLIENT_NAME.SUFFIX.

field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field destroyed: Optional[StrictBool] = None

Returns a value of true if the pod containing the snapshot policy rule has been destroyed and is pending eradication. The time_remaining value displays the amount of time left until the destroyed policy is permanently eradicated. Once the time_remaining period has elapsed, the snapshot policy rule is permanently eradicated and can no longer be recovered.

Constraints

  • type = boolean

field every: Optional[StrictInt] = None

Specifies the interval between snapshots, in milliseconds. The every value for all rules must be multiples of one another. The every value must be unique for each rule in the same policy. The every value must be between 5 minutes and 1 year.

field keep_for: Optional[StrictInt] = None

Specifies the period that snapshots are retained before they are eradicated, in milliseconds. The keep_for value cannot be less than the every value of the rule. The keep_for value must be unique for each rule in the same policy. The keep_for value must be between 5 minutes and 5 years. The keep_for value cannot be less than the keep_for value of any rule in the same policy with a smaller every value.

field name: Optional[StrictStr] = None

Name of this rule. The name is automatically generated by the system.

field policy: Optional[FixedReferenceWithType] = None

The policy to which this rule belongs.

field suffix: Optional[StrictStr] = None

The snapshot suffix name. A full snapshot name is constructed in the form of DIR.CLIENT_NAME.SUFFIX where DIR is the managed directory name, CLIENT_NAME is the snapshot client name, and SUFFIX is the snapshot suffix. The client-visible snapshot name is CLIENT_NAME.SUFFIX. The suffix value can only be set for one rule in the same policy. The suffix value can only be set on a rule with the same keep_for value and every value. The suffix value can only be set on the rule with the largest keep_for value. If not specified, defaults to a monotonically increasing number generated by the system.

field time_remaining: Optional[StrictInt] = None

The amount of time left, in milliseconds, until the destroyed snapshot policy rule is permanently eradicated.

PolicyRuleSnapshotGetResponse

pydantic model pypureclient.flasharray.PolicyRuleSnapshotGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[PolicyRuleSnapshot]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[PolicyRuleSnapshot]] = None

Displays a list of all items after filtering. The values are displayed for each name, if meaningful.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

PolicyRuleSnapshotPost

pydantic model pypureclient.flasharray.PolicyRuleSnapshotPost(*, rules: Optional[ConstrainedListValue[PolicyrulesnapshotpostRules]] = None)
field rules: Optional[ConstrainedListValue[PolicyrulesnapshotpostRules]] = None

A list of snapshot policy rules to create.

PolicyRuleSnapshotResponse

pydantic model pypureclient.flasharray.PolicyRuleSnapshotResponse(*, items: Optional[ConstrainedListValue[PolicyRuleSnapshot]] = None)
field items: Optional[ConstrainedListValue[PolicyRuleSnapshot]] = None

Displays a list of all items after filtering. The values are displayed for each name, if meaningful.

PolicySmb

pydantic model pypureclient.flasharray.PolicySmb(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, context: Optional[FixedReference] = None, destroyed: Optional[StrictBool] = None, enabled: Optional[StrictBool] = None, pod: Optional[Reference] = None, policy_type: Optional[StrictStr] = None, time_remaining: Optional[StrictInt] = None, access_based_enumeration_enabled: Optional[StrictBool] = None, continuous_availability_enabled: Optional[StrictBool] = None, policy_mapping: Optional[PolicyNfsPolicyMapping] = None)
field access_based_enumeration_enabled: Optional[StrictBool] = None

Returns a value of true if access based enumeration is enabled on the policy. When access based enumeration is enabled on a policy, files and folders within exports that are attached to the policy will be hidden from users who do not have permission to view them.

Constraints

  • type = boolean

field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field continuous_availability_enabled: Optional[StrictBool] = None

Returns a value of true if continuous availability is enabled on the policy. When continuous availability is enabled on a policy, file shares are accessible during otherwise disruptive scenarios such as temporary network outages, controller upgrades or failovers.

Constraints

  • type = boolean

field destroyed: Optional[StrictBool] = None

Returns a value of true if the policy has been destroyed and is pending eradication. The time_remaining value displays the amount of time left until the destroyed policy is permanently eradicated. Once the time_remaining period has elapsed, the policy is permanently eradicated and can no longer be recovered.

Constraints

  • type = boolean

field enabled: Optional[StrictBool] = None

Returns a value of true if the policy is enabled.

Constraints

  • type = boolean

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

field pod: Optional[Reference] = None

A reference to the pod.

field policy_mapping: Optional[PolicyNfsPolicyMapping] = None

Specifies the mapping of this policy across a pod replica link. If this policy is not inside a pod of a pod replica link, mapping is null.

field policy_type: Optional[StrictStr] = None

The type of policy. Valid values include autodir, nfs, smb, snapshot, and quota.

field time_remaining: Optional[StrictInt] = None

The amount of time left, measured in milliseconds, until the destroyed policy is permanently eradicated.

PolicySmbGetResponse

pydantic model pypureclient.flasharray.PolicySmbGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[PolicySmb]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[PolicySmb]] = None

Displays a list of all items after filtering. If applicable, the values are displayed for each name.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

PolicySmbPatch

pydantic model pypureclient.flasharray.PolicySmbPatch(*, name: Optional[StrictStr] = None, enabled: Optional[StrictBool] = None, access_based_enumeration_enabled: Optional[StrictBool] = None, continuous_availability_enabled: Optional[StrictBool] = None)
field access_based_enumeration_enabled: Optional[StrictBool] = None

If set to true, enables access based enumeration on the policy. When access based enumeration is enabled on a policy, files and folders within exports that are attached to the policy will be hidden from users who do not have permission to view them.

Constraints

  • type = boolean

field continuous_availability_enabled: Optional[StrictBool] = None

If set to true, enables continuous availability on the policy. When continuous availability is enabled on a policy, file shares are accessible during otherwise disruptive scenarios such as temporary network outages, controller upgrades or failovers.

Constraints

  • type = boolean

field enabled: Optional[StrictBool] = None

If set to true, enables the policy. If set to false, disables the policy.

Constraints

  • type = boolean

field name: Optional[StrictStr] = None

The new name for the resource.

PolicySmbPost

pydantic model pypureclient.flasharray.PolicySmbPost(*, enabled: Optional[StrictBool] = None, access_based_enumeration_enabled: Optional[StrictBool] = None, continuous_availability_enabled: Optional[StrictBool] = None, policy_mapping: Optional[PolicynfspostPolicyMapping] = None)
field access_based_enumeration_enabled: Optional[StrictBool] = None

If set to true, enables access based enumeration on the policy. When access based enumeration is enabled on a policy, files and folders within exports that are attached to the policy will be hidden from users who do not have permission to view them. If not specified, defaults to false.

Constraints

  • type = boolean

field continuous_availability_enabled: Optional[StrictBool] = None

Returns a value of true if continuous availability is enabled on the policy. When continuous availability is enabled on a policy, file shares are accessible during otherwise disruptive scenarios such as temporary network outages, controller upgrades or failovers. If not specified, defaults to false.

Constraints

  • type = boolean

field enabled: Optional[StrictBool] = None

If set to true, enables the policy. If set to false, disables the policy.

Constraints

  • type = boolean

field policy_mapping: Optional[PolicynfspostPolicyMapping] = None

PolicySmbResponse

pydantic model pypureclient.flasharray.PolicySmbResponse(*, items: Optional[ConstrainedListValue[PolicySmb]] = None)
field items: Optional[ConstrainedListValue[PolicySmb]] = None

Displays a list of all items after filtering. If applicable, the values are displayed for each name.

PolicymemberexportpostMembers

pydantic model pypureclient.flasharray.PolicymemberexportpostMembers(*, export_enabled: Optional[StrictBool] = None, export_name: Optional[StrictStr] = None, member: Optional[ReferenceWithType] = None)
field export_enabled: Optional[StrictBool] = None

If set to true, the export is enabled. If not specified, defaults to true.

Constraints

  • type = boolean

field export_name: Optional[StrictStr] = None

The name of the export to create when applying the export policy to the directory. Export names must be unique within the same protocol.

field member: Optional[ReferenceWithType] = None

Reference to the directory to which the export policy may be applied. The id or name parameter is required, but they cannot be set together. If the name parameter is set, resource_type must also be set.

PolicymemberpostMembers

pydantic model pypureclient.flasharray.PolicymemberpostMembers(*, member: Optional[ReferenceWithType] = None)
field member: Optional[ReferenceWithType] = None

Reference to the resource to which the policy may be applied. The id or name parameter is required, but they cannot be set together. If the name parameter is set, resource_type must also be set.

PolicynfspostPolicyMapping

pydantic model pypureclient.flasharray.PolicynfspostPolicyMapping(*, mapping: Optional[StrictStr] = None)

If set specifies the initial mapping of the policy upon its creation across a pod replica link. Policy being created must be in a source pod of a replica-link.

field mapping: Optional[StrictStr] = None

The mapping of this policy. Valid values are connected and disconnected.

PolicyrulealertwatcherpatchRules

pydantic model pypureclient.flasharray.PolicyrulealertwatcherpatchRules(*, email: Optional[StrictStr] = None, excluded_codes: Optional[ConstrainedListValue[StrictInt]] = None, included_codes: Optional[ConstrainedListValue[StrictInt]] = None, minimum_notification_severity: Optional[StrictStr] = None)
field email: Optional[StrictStr] = None

The email address that will receive the alert notification emails.

field excluded_codes: Optional[ConstrainedListValue[StrictInt]] = None

An alert with one of these codes will not have emails sent to the recipient. Cannot be specified with include_codes. If specified while include_codes is already set, include_codes will be cleared. Use “” to clear. If both exclude_codes and include_codes are cleared, defaults to an empty list for exclude_codes.

field included_codes: Optional[ConstrainedListValue[StrictInt]] = None

An alert must have one of these codes in order for emails to be sent to the recipient. Cannot be specified with exclude_codes. If specified while exclude_codes is already set, exclude_codes will be cleared. Use “” to clear. If both exclude_codes and include_codes are cleared, defaults to an empty list for exclude_codes.

field minimum_notification_severity: Optional[StrictStr] = None

The minimum severity that an alert must have in order for emails to be sent to the recipient. Possible values include info, warning, and critical.

PolicyrulealertwatcherpostRules

pydantic model pypureclient.flasharray.PolicyrulealertwatcherpostRules(*, email: Optional[StrictStr] = None, excluded_codes: Optional[ConstrainedListValue[StrictInt]] = None, included_codes: Optional[ConstrainedListValue[StrictInt]] = None, minimum_notification_severity: Optional[StrictStr] = None)
field email: Optional[StrictStr] = None

The email address that will receive the alert notification emails.

field excluded_codes: Optional[ConstrainedListValue[StrictInt]] = None

An alert with one of these codes will not have emails sent to the recipient. Cannot be specified with include_codes. If specified while include_codes is already set, include_codes will be cleared. Use “” to clear. If both exclude_codes and include_codes are cleared, defaults to an empty list for exclude_codes.

field included_codes: Optional[ConstrainedListValue[StrictInt]] = None

An alert must have one of these codes in order for emails to be sent to the recipient. Cannot be specified with exclude_codes. If specified while exclude_codes is already set, exclude_codes will be cleared. Use “” to clear. If both exclude_codes and include_codes are cleared, defaults to an empty list for exclude_codes.

field minimum_notification_severity: Optional[StrictStr] = None

The minimum severity that an alert must have in order for emails to be sent to the recipient. Possible values include info, warning, and critical. If not specified, defaults to info.

PolicyrulemanagementaccessRules

pydantic model pypureclient.flasharray.PolicyrulemanagementaccessRules(*, role: Optional[ReferenceNoId] = None, scope: Optional[ReferenceWithType] = None)
field role: Optional[ReferenceNoId] = None

Role defines a set of permissions applicable in a scope. viewer grants users the ability to read a resource. support grants the ability to perform general support-related actions, as well as read resources. storage grants access to all storage operations on a resource. admin grants access to all operations.

field scope: Optional[ReferenceWithType] = None

Reference to the resource (e.g. arrays, realms) which specifies the scope that the role applies. The id or name parameter is required, but they cannot be set together. Also, resource_type must be set.

PolicyrulenfsclientpostRules

pydantic model pypureclient.flasharray.PolicyrulenfsclientpostRules(*, access: Optional[StrictStr] = None, anongid: Optional[StrictStr] = None, anonuid: Optional[StrictStr] = None, client: Optional[StrictStr] = None, nfs_version: Optional[ConstrainedListValue[StrictStr]] = None, permission: Optional[StrictStr] = None, security: Optional[ConstrainedListValue[StrictStr]] = None)
field access: Optional[StrictStr] = None

Specifies access control for the export. Valid values include root-squash, all-squash, and no-root-squash. The value root-squash prevents client users and groups with root privilege from mapping their root privilege to a file system. All users with UID 0 will have their UID mapped to anonuid. All users with GID 0 will have their GID mapped to anongid. The value all-squash maps all UIDs (including root) to anonuid and all GIDs (including root) to anongid. The value no-root-squash allows users and groups to access the file system with their UIDs and GIDs. If not specified, the default value is root-squash.

field anongid: Optional[StrictStr] = None

Any user whose GID is affected by an access of root_squash or all_squash will have their GID mapped to anongid. The default anongid is null, which means 65534. Use “” to clear. This value is ignored when user mapping is enabled.

field anonuid: Optional[StrictStr] = None

Any user whose UID is affected by an access of root_squash or all_squash will have their UID mapped to anonuid. The default anonuid is null, which means 65534. Use “” to clear.

field client: Optional[StrictStr] = None

Specifies which clients are given access. Valid values include IP, IP mask, or hostname. The default is * if not specified.

field nfs_version: Optional[ConstrainedListValue[StrictStr]] = None

NFS protocol version allowed for the export. Valid values are nfsv3 and nfsv4. If not specified, defaults to nfsv3.

field permission: Optional[StrictStr] = None

Specifies which read-write client access permissions are allowed for the export. Values include rw and ro. The default value is rw if not specified.

field security: Optional[ConstrainedListValue[StrictStr]] = None

The security flavors to use for accessing files on this mount point. Values include auth_sys, krb5, krb5i, and krb5p. If the server does not support the requested flavor, the mount operation fails. This operation updates all rules of the specified policy. If auth_sys, the client is trusted to specify the identity of the user. If krb5, cryptographic proof of the identity of the user is provided in each RPC request. This provides strong verification of the identity of users accessing data on the server. Note that additional configuration besides adding this mount option is required to enable Kerberos security. If krb5i, integrity checking is added to krb5. This ensures the data has not been tampered with. If krb5p, integrity checking and encryption is added to krb5. This is the most secure setting, but it also involves the most performance overhead.

PolicyrulequotapatchRules

pydantic model pypureclient.flasharray.PolicyrulequotapatchRules(*, enforced: Optional[StrictBool] = None, notifications: Optional[StrictStr] = None, quota_limit: Optional[StrictInt] = None)
field enforced: Optional[StrictBool] = None

If set to true, this rule describes an enforced quota. An out-of-space warning is issued if logical space usage exceeds the limit value described in this rule. If set to false, this rule describes an unenforced quota. Alerts and/or notifications are issued when logical space usage exceeds the limit value described in this rule.

Constraints

  • type = boolean

field notifications: Optional[StrictStr] = None

Targets to notify when usage approaches the quota limit. The list of notification targets is a comma-separated string. Valid values are one or more of user and group. To notify no targets, use none.

field quota_limit: Optional[StrictInt] = None

Logical space limit of the quota (in bytes) assigned by the rule. This value cannot be set to 0.

PolicyrulequotapostRules

pydantic model pypureclient.flasharray.PolicyrulequotapostRules(*, enforced: Optional[StrictBool] = None, notifications: Optional[StrictStr] = None, quota_limit: Optional[StrictInt] = None)
field enforced: Optional[StrictBool] = None

If set to true, this rule describes an enforced quota. An out-of-space warning is issued if logical space usage exceeds the limit value described in this rule. If set to false, this rule describes an unenforced quota. Alerts and/or notifications are issued when logical space usage exceeds the limit value described in this rule. If not specified, defaults to false.

Constraints

  • type = boolean

field notifications: Optional[StrictStr] = None

Targets to notify when usage approaches the quota limit. The list of notification targets is a comma-separated string. Valid values are one or more of user and group. To notify no targets, use none. If not specified, defaults to none.

field quota_limit: Optional[StrictInt] = None

Logical space limit of the quota (in bytes) assigned by the rule. This value cannot be set to 0.

PolicyrulesmbclientpostRules

pydantic model pypureclient.flasharray.PolicyrulesmbclientpostRules(*, anonymous_access_allowed: Optional[StrictBool] = None, client: Optional[StrictStr] = None, smb_encryption_required: Optional[StrictBool] = None)
field anonymous_access_allowed: Optional[StrictBool] = None

Specifies whether access to information is allowed for anonymous users. If not specified, defaults to false.

Constraints

  • type = boolean

field client: Optional[StrictStr] = None

Specifies which clients are given access. Accepted notation, IP, IP mask, or hostname. The default is * if not specified.

field smb_encryption_required: Optional[StrictBool] = None

Specifies whether the remote client is required to use SMB encryption. If not specified, defaults to false.

Constraints

  • type = boolean

PolicyrulesnapshotpostRules

pydantic model pypureclient.flasharray.PolicyrulesnapshotpostRules(*, at: Optional[StrictInt] = None, client_name: Optional[StrictStr] = None, every: Optional[StrictInt] = None, keep_for: Optional[StrictInt] = None, suffix: Optional[StrictStr] = None)
field at: Optional[StrictInt] = None

Specifies the number of milliseconds since midnight at which to take a snapshot. The at value can only be set to an hour and must be between 0 and 82800000, inclusive. The at value can only be set on the rule with the smallest every value. The at value cannot be set if the every value is not measured in days. The at value can only be set for at most one rule in the same policy.

field client_name: Optional[StrictStr] = None

The snapshot client name. A full snapshot name is constructed in the form of DIR.CLIENT_NAME.SUFFIX where DIR is the managed directory name, CLIENT_NAME is the snapshot client name, and SUFFIX is the snapshot suffix. The client-visible snapshot name is CLIENT_NAME.SUFFIX.

field every: Optional[StrictInt] = None

Specifies the interval between snapshots, in milliseconds. The every value for all rules must be multiples of one another. The every value must be unique for each rule in the same policy. The every value must be between 5 minutes and 1 year.

field keep_for: Optional[StrictInt] = None

Specifies the period that snapshots are retained before they are eradicated, in milliseconds. The keep_for value cannot be less than the every value of the rule. The keep_for value must be unique for each rule in the same policy. The keep_for value must be between 5 minutes and 5 years. The keep_for value cannot be less than the keep_for value of any rule in the same policy with a smaller every value.

field suffix: Optional[StrictStr] = None

The snapshot suffix name. A full snapshot name is constructed in the form of DIR.CLIENT_NAME.SUFFIX where DIR is the managed directory name, CLIENT_NAME is the snapshot client name, and SUFFIX is the snapshot suffix. The client-visible snapshot name is CLIENT_NAME.SUFFIX. The suffix value can only be set for one rule in the same policy. The suffix value can only be set on a rule with the same keep_for value and every value. The suffix value can only be set on the rule with the largest keep_for value. If not specified, defaults to a monotonically increasing number generated by the system.

Port

pydantic model pypureclient.flasharray.Port(*, name: Optional[StrictStr] = None, iqn: Optional[StrictStr] = None, nqn: Optional[StrictStr] = None, portal: Optional[StrictStr] = None, wwn: Optional[StrictStr] = None, failover: Optional[StrictStr] = None, context: Optional[FixedReference] = None)
field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field failover: Optional[StrictStr] = None

If the array port has failed over, returns the name of the port to which this port has failed over.

field iqn: Optional[StrictStr] = None

The iSCSI Qualified Name (or null if target is not iSCSI).

field name: Optional[StrictStr] = None

A locally unique, system-generated name. The name cannot be modified.

field nqn: Optional[StrictStr] = None

NVMe Qualified Name (or null if target is not NVMeoF).

field portal: Optional[StrictStr] = None

IP and port number (or null if target is not iSCSI).

field wwn: Optional[StrictStr] = None

Fibre Channel World Wide Name (or null if target is not Fibre Channel).

PortCommon

pydantic model pypureclient.flasharray.PortCommon(*, iqn: Optional[StrictStr] = None, nqn: Optional[StrictStr] = None, portal: Optional[StrictStr] = None, wwn: Optional[StrictStr] = None)
field iqn: Optional[StrictStr] = None

The iSCSI Qualified Name (or null if target is not iSCSI).

field nqn: Optional[StrictStr] = None

NVMe Qualified Name (or null if target is not NVMeoF).

field portal: Optional[StrictStr] = None

IP and port number (or null if target is not iSCSI).

field wwn: Optional[StrictStr] = None

Fibre Channel World Wide Name (or null if target is not Fibre Channel).

PortGetResponse

pydantic model pypureclient.flasharray.PortGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None, items: Optional[ConstrainedListValue[Port]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[Port]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

PortInitiator

pydantic model pypureclient.flasharray.PortInitiator(*, context: Optional[FixedReference] = None, initiator: Optional[PortCommon] = None, target: Optional[PortInitiatorTarget] = None)
field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field initiator: Optional[PortCommon] = None
field target: Optional[PortInitiatorTarget] = None

PortInitiatorTarget

pydantic model pypureclient.flasharray.PortInitiatorTarget(*, name: Optional[StrictStr] = None, iqn: Optional[StrictStr] = None, nqn: Optional[StrictStr] = None, portal: Optional[StrictStr] = None, wwn: Optional[StrictStr] = None, failover: Optional[StrictStr] = None)
field failover: Optional[StrictStr] = None

If the array port has failed over, returns the name of the port to which this port has failed over.

field iqn: Optional[StrictStr] = None

The iSCSI Qualified Name (or null if target is not iSCSI).

field name: Optional[StrictStr] = None

A locally unique, system-generated name. The name cannot be modified.

field nqn: Optional[StrictStr] = None

NVMe Qualified Name (or null if target is not NVMeoF).

field portal: Optional[StrictStr] = None

IP and port number (or null if target is not iSCSI).

field wwn: Optional[StrictStr] = None

Fibre Channel World Wide Name (or null if target is not Fibre Channel).

PortInitiatorsGetResponse

pydantic model pypureclient.flasharray.PortInitiatorsGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None, items: Optional[ConstrainedListValue[PortInitiator]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[PortInitiator]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

PresetWorkload

pydantic model pypureclient.flasharray.PresetWorkload(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, context: Optional[FixedReference] = None, description: Optional[StrictStr] = None, parameters: Optional[ConstrainedListValue[PresetWorkloadParameter]] = None, periodic_replication_configurations: Optional[ConstrainedListValue[PresetWorkloadPeriodicReplicationConfiguration]] = None, placement_configurations: ConstrainedListValue[PresetWorkloadPlacementConfiguration], qos_configurations: Optional[ConstrainedListValue[PresetWorkloadQosConfiguration]] = None, revision: Optional[StrictInt] = None, snapshot_configurations: Optional[ConstrainedListValue[PresetWorkloadSnapshotConfiguration]] = None, volume_configurations: ConstrainedListValue[PresetWorkloadVolumeConfiguration], workload_tags: Optional[ConstrainedListValue[PresetWorkloadWorkloadTag]] = None, workload_type: StrictStr)
field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field description: Optional[StrictStr] = None

A brief description of the workload the preset will configure. Supports up to 1KB of unicode characters.

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

field parameters: Optional[ConstrainedListValue[PresetWorkloadParameter]] = None

The parameters to prompt the user when they deploy workloads from the preset.

field periodic_replication_configurations: Optional[ConstrainedListValue[PresetWorkloadPeriodicReplicationConfiguration]] = None

The periodic replication configurations that can be applied to storage resources (such as volumes) within the preset.

Constraints

  • maxItems = 2

field placement_configurations: ConstrainedListValue[PresetWorkloadPlacementConfiguration] [Required]

The placement configurations that can be applied to storage resources (such as volumes) within the preset. All storage resources associated with the same placement will be colocated on the same array.

Constraints

  • minItems = 1

  • maxItems = 1

field qos_configurations: Optional[ConstrainedListValue[PresetWorkloadQosConfiguration]] = None

The QoS configurations that can be applied to storage resources (such as volumes) within the preset.

Constraints

  • maxItems = 5

field revision: Optional[StrictInt] = None

A counter that is automatically incremented by the server when the preset is updated.

field snapshot_configurations: Optional[ConstrainedListValue[PresetWorkloadSnapshotConfiguration]] = None

The snapshot configurations that can be applied to storage resources (such as volumes) within the preset.

Constraints

  • maxItems = 2

field volume_configurations: ConstrainedListValue[PresetWorkloadVolumeConfiguration] [Required]

The volumes that will be provisioned by the preset.

Constraints

  • minItems = 1

  • maxItems = 5

field workload_tags: Optional[ConstrainedListValue[PresetWorkloadWorkloadTag]] = None

The tags that will be associated with workloads provisioned by the preset.

field workload_type: StrictStr [Required]

The type of workload the preset will configure. Valid values include VDI, File, MySQL etc.

PresetWorkloadBase

pydantic model pypureclient.flasharray.PresetWorkloadBase(*, description: Optional[StrictStr] = None, parameters: Optional[ConstrainedListValue[PresetWorkloadParameter]] = None, periodic_replication_configurations: Optional[ConstrainedListValue[PresetWorkloadPeriodicReplicationConfiguration]] = None, placement_configurations: ConstrainedListValue[PresetWorkloadPlacementConfiguration], qos_configurations: Optional[ConstrainedListValue[PresetWorkloadQosConfiguration]] = None, revision: Optional[StrictInt] = None, snapshot_configurations: Optional[ConstrainedListValue[PresetWorkloadSnapshotConfiguration]] = None, volume_configurations: ConstrainedListValue[PresetWorkloadVolumeConfiguration], workload_tags: Optional[ConstrainedListValue[PresetWorkloadWorkloadTag]] = None, workload_type: StrictStr)

Workload presets are reusable templates that provision workloads.

field description: Optional[StrictStr] = None

A brief description of the workload the preset will configure. Supports up to 1KB of unicode characters.

field parameters: Optional[ConstrainedListValue[PresetWorkloadParameter]] = None

The parameters to prompt the user when they deploy workloads from the preset.

field periodic_replication_configurations: Optional[ConstrainedListValue[PresetWorkloadPeriodicReplicationConfiguration]] = None

The periodic replication configurations that can be applied to storage resources (such as volumes) within the preset.

Constraints

  • maxItems = 2

field placement_configurations: ConstrainedListValue[PresetWorkloadPlacementConfiguration] [Required]

The placement configurations that can be applied to storage resources (such as volumes) within the preset. All storage resources associated with the same placement will be colocated on the same array.

Constraints

  • minItems = 1

  • maxItems = 1

field qos_configurations: Optional[ConstrainedListValue[PresetWorkloadQosConfiguration]] = None

The QoS configurations that can be applied to storage resources (such as volumes) within the preset.

Constraints

  • maxItems = 5

field revision: Optional[StrictInt] = None

A counter that is automatically incremented by the server when the preset is updated.

field snapshot_configurations: Optional[ConstrainedListValue[PresetWorkloadSnapshotConfiguration]] = None

The snapshot configurations that can be applied to storage resources (such as volumes) within the preset.

Constraints

  • maxItems = 2

field volume_configurations: ConstrainedListValue[PresetWorkloadVolumeConfiguration] [Required]

The volumes that will be provisioned by the preset.

Constraints

  • minItems = 1

  • maxItems = 5

field workload_tags: Optional[ConstrainedListValue[PresetWorkloadWorkloadTag]] = None

The tags that will be associated with workloads provisioned by the preset.

field workload_type: StrictStr [Required]

The type of workload the preset will configure. Valid values include VDI, File, MySQL etc.

PresetWorkloadConstraints

pydantic model pypureclient.flasharray.PresetWorkloadConstraints(*, boolean: Optional[PresetWorkloadConstraintsBoolean] = None, integer: Optional[PresetWorkloadConstraintsInteger] = None, resource_reference: Optional[PresetWorkloadConstraintsResourceReference] = None, string: Optional[PresetWorkloadConstraintsString] = None)

Constraints to apply to the parameter.

field boolean: Optional[PresetWorkloadConstraintsBoolean] = None
field integer: Optional[PresetWorkloadConstraintsInteger] = None
field resource_reference: Optional[PresetWorkloadConstraintsResourceReference] = None
field string: Optional[PresetWorkloadConstraintsString] = None

PresetWorkloadConstraintsBoolean

pydantic model pypureclient.flasharray.PresetWorkloadConstraintsBoolean(*, default: Optional[StrictBool] = None)

Constraints to apply to boolean parameters.

field default: Optional[StrictBool] = None

The default value to use if no value is provided.

Constraints

  • type = boolean

PresetWorkloadConstraintsInteger

pydantic model pypureclient.flasharray.PresetWorkloadConstraintsInteger(*, allowed_values: Optional[ConstrainedListValue[StrictInt]] = None, default: Optional[StrictInt] = None, maximum: Optional[StrictInt] = None, minimum: Optional[StrictInt] = None)

Constraints to apply to integer parameters.

field allowed_values: Optional[ConstrainedListValue[StrictInt]] = None

The valid values that can be supplied to the parameter. A parameter that collects the number of volumes to provision might, for example, limit the allowed values to a few fixed options. Supports up to five values.

field default: Optional[StrictInt] = None

The default value to use if no value is provided. Must be present in allowed_values, if set. Must comply with minimum, if set. Must comply with maximum, if set.

field maximum: Optional[StrictInt] = None

The maximum acceptable value, inclusive.

field minimum: Optional[StrictInt] = None

The minimum acceptable value, inclusive.

PresetWorkloadConstraintsResourceReference

pydantic model pypureclient.flasharray.PresetWorkloadConstraintsResourceReference(*, allowed_values: ConstrainedListValue[PresetWorkloadConstraintsResourceReferenceAllowedValues], default: Optional[ReferenceWithType] = None)

Constraints to apply to resource reference parameters

field allowed_values: ConstrainedListValue[PresetWorkloadConstraintsResourceReferenceAllowedValues] [Required]

The valid values that can be supplied to the parameter. Exactly one value must be specified.

field default: Optional[ReferenceWithType] = None

The default value to use if no value is provided. Must match the resource_type set in allowed_values. One of id or name must be set, but they cannot be set together.

PresetWorkloadConstraintsResourceReferenceAllowedValues

pydantic model pypureclient.flasharray.PresetWorkloadConstraintsResourceReferenceAllowedValues(*, resource_type: StrictStr)
field resource_type: StrictStr [Required]

The type of resource the parameter references. Valid values include storage-classes and remote-arrays.

PresetWorkloadConstraintsString

pydantic model pypureclient.flasharray.PresetWorkloadConstraintsString(*, allowed_values: Optional[ConstrainedListValue[StrictStr]] = None, default: Optional[StrictStr] = None)

Constraints to apply to string parameters.

field allowed_values: Optional[ConstrainedListValue[StrictStr]] = None

The valid values that can be supplied to the parameter. A parameter that collects the name of the environment to which a workload will deploy might, for example, limit the allowed values to production, testing and development. Supports up to five values, with up to 64 unicode characters per value.

field default: Optional[StrictStr] = None

The default value to use if no value is provided. Must be present in allowed_values, if allowed_values is set. Supports up to 64 unicode characters.

PresetWorkloadGetResponse

pydantic model pypureclient.flasharray.PresetWorkloadGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, items: Optional[ConstrainedListValue[PresetWorkload]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query parameter to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination, then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[PresetWorkload]] = None

Displays a list of all items after filtering. If applicable, the values are displayed for each name.

field more_items_remaining: Optional[StrictBool] = None

Displays a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

PresetWorkloadMetadata

pydantic model pypureclient.flasharray.PresetWorkloadMetadata(*, description: Optional[StrictStr] = None, display_name: Optional[StrictStr] = None, subtype: Optional[StrictStr] = None)
field description: Optional[StrictStr] = None

A brief description of the parameter and how it is used within the preset. Supports up to 1KB of unicode characters.

field display_name: Optional[StrictStr] = None

The human-friendly name of the parameter, which will be shown in the GUI instead of the standard name if configured. Supports up to 64 unicode characters.

field subtype: Optional[StrictStr] = None

The subtype of the parameter, which the GUI will use to contextualize the prompt for the parameter value. For example, when set to size, the GUI will display an input field with a dropdown menu that contains common size units such as MB, GB, TB, etc. Valid values include size, iops, bandwidth, time and duration. Subtype can only be used with integer parameters.

PresetWorkloadParameter

pydantic model pypureclient.flasharray.PresetWorkloadParameter(*, constraints: Optional[PresetWorkloadConstraints] = None, metadata: Optional[PresetWorkloadMetadata] = None, name: StrictStr, type: StrictStr)
field constraints: Optional[PresetWorkloadConstraints] = None
field metadata: Optional[PresetWorkloadMetadata] = None
field name: StrictStr [Required]

The name of the parameter, by which other fields in the preset can reference it. Name must be unique across all parameters in the preset.

field type: StrictStr [Required]

The type of the parameter. Valid values include string, integer, boolean and resource_reference. String parameters can be used to collect metadata about workloads deployed from the preset, such as the environment to which they are deployed (e.g., production, development, etc.) or the billing account to which they belong for charge back and show back purposes. Integer and boolean parameters can be used to configure specific fields in the preset, such as the number or size of volumes to provision. Resource reference parameters can be used to collect references to other objects, such as storage classes or remote arrays.

PresetWorkloadPatch

pydantic model pypureclient.flasharray.PresetWorkloadPatch(*, name: Optional[StrictStr] = None)
field name: Optional[StrictStr] = None

The new name for the resource.

PresetWorkloadPeriodicReplicationConfiguration

pydantic model pypureclient.flasharray.PresetWorkloadPeriodicReplicationConfiguration(*, name: StrictStr, remote_targets: ConstrainedListValue[ReferenceWithType], rules: ConstrainedListValue[PresetWorkloadSnapshotRule])
field name: StrictStr [Required]

The name of the periodic replication configuration, by which other configuration objects in the preset can reference it. Name must be unique across all configuration objects in the preset.

field remote_targets: ConstrainedListValue[ReferenceWithType] [Required]

The remote targets to which snapshots may be replicated.

Constraints

  • minItems = 1

  • maxItems = 1

field rules: ConstrainedListValue[PresetWorkloadSnapshotRule] [Required]

Rules describe the frequency and retention of snapshots taken by the configuration.

Constraints

  • minItems = 1

  • maxItems = 2

PresetWorkloadPlacementConfiguration

pydantic model pypureclient.flasharray.PresetWorkloadPlacementConfiguration(*, name: StrictStr, qos_configurations: Optional[ConstrainedListValue[StrictStr]] = None, storage_class: ReferenceWithType)
field name: StrictStr [Required]

The name of the placement configuration, by which other configuration objects in the preset can reference it. Name must be unique across all configuration objects in the preset.

field qos_configurations: Optional[ConstrainedListValue[StrictStr]] = None

The names of the QoS configurations to apply to the storage resources (such as volumes) in the placement. The limits defined in the QoS configurations will be shared across all storage resources in the placement.

Constraints

  • maxItems = 1

field storage_class: ReferenceWithType [Required]

The storage class to which the placement and its associated storage resources may be deployed. Supports parameterization.

PresetWorkloadPost

pydantic model pypureclient.flasharray.PresetWorkloadPost(*, description: Optional[StrictStr] = None, parameters: Optional[ConstrainedListValue[PresetWorkloadParameter]] = None, periodic_replication_configurations: Optional[ConstrainedListValue[PresetWorkloadPeriodicReplicationConfiguration]] = None, placement_configurations: ConstrainedListValue[PresetWorkloadPlacementConfiguration], qos_configurations: Optional[ConstrainedListValue[PresetWorkloadQosConfiguration]] = None, revision: Optional[StrictInt] = None, snapshot_configurations: Optional[ConstrainedListValue[PresetWorkloadSnapshotConfiguration]] = None, volume_configurations: ConstrainedListValue[PresetWorkloadVolumeConfiguration], workload_tags: Optional[ConstrainedListValue[PresetWorkloadWorkloadTag]] = None, workload_type: StrictStr)
field description: Optional[StrictStr] = None

A brief description of the workload the preset will configure. Supports up to 1KB of unicode characters.

field parameters: Optional[ConstrainedListValue[PresetWorkloadParameter]] = None

The parameters to prompt the user when they deploy workloads from the preset.

field periodic_replication_configurations: Optional[ConstrainedListValue[PresetWorkloadPeriodicReplicationConfiguration]] = None

The periodic replication configurations that can be applied to storage resources (such as volumes) within the preset.

Constraints

  • maxItems = 2

field placement_configurations: ConstrainedListValue[PresetWorkloadPlacementConfiguration] [Required]

The placement configurations that can be applied to storage resources (such as volumes) within the preset. All storage resources associated with the same placement will be colocated on the same array.

Constraints

  • minItems = 1

  • maxItems = 1

field qos_configurations: Optional[ConstrainedListValue[PresetWorkloadQosConfiguration]] = None

The QoS configurations that can be applied to storage resources (such as volumes) within the preset.

Constraints

  • maxItems = 5

field revision: Optional[StrictInt] = None

A counter that is automatically incremented by the server when the preset is updated.

field snapshot_configurations: Optional[ConstrainedListValue[PresetWorkloadSnapshotConfiguration]] = None

The snapshot configurations that can be applied to storage resources (such as volumes) within the preset.

Constraints

  • maxItems = 2

field volume_configurations: ConstrainedListValue[PresetWorkloadVolumeConfiguration] [Required]

The volumes that will be provisioned by the preset.

Constraints

  • minItems = 1

  • maxItems = 5

field workload_tags: Optional[ConstrainedListValue[PresetWorkloadWorkloadTag]] = None

The tags that will be associated with workloads provisioned by the preset.

field workload_type: StrictStr [Required]

The type of workload the preset will configure. Valid values include VDI, File, MySQL etc.

PresetWorkloadQosConfiguration

pydantic model pypureclient.flasharray.PresetWorkloadQosConfiguration(*, bandwidth_limit: Optional[StrictStr] = None, iops_limit: Optional[StrictStr] = None, name: StrictStr)
field bandwidth_limit: Optional[StrictStr] = None

The QoS IOPs limit shared across all volumes in the placement. Between 100 and 100000000, inclusive. Supports parameterization.

field iops_limit: Optional[StrictStr] = None

The maximum QoS bandwidth limit shared across all volumes in the placement. Whenever throughput exceeds the bandwidth limit, throttling occurs. Measured in bytes per second. Between 1MB/s and 512 GB/s, inclusive. Supports parameterization.

field name: StrictStr [Required]

The name of the QoS configuration, by which other configuration objects in the preset can reference it. Name must be unique across all configuration objects in the preset.

PresetWorkloadResponse

pydantic model pypureclient.flasharray.PresetWorkloadResponse(*, items: Optional[ConstrainedListValue[PresetWorkload]] = None)
field items: Optional[ConstrainedListValue[PresetWorkload]] = None

Displays a list of all items after filtering. If applicable, the values are displayed for each name.

PresetWorkloadSnapshotConfiguration

pydantic model pypureclient.flasharray.PresetWorkloadSnapshotConfiguration(*, name: StrictStr, rules: ConstrainedListValue[PresetWorkloadSnapshotRule])
field name: StrictStr [Required]

The name of the snapshot configuration, by which other configuration objects in the preset can reference it. Name must be unique across all configuration objects in the preset.

field rules: ConstrainedListValue[PresetWorkloadSnapshotRule] [Required]

Rules describe the frequency and retention of snapshots taken by the configuration.

Constraints

  • minItems = 1

  • maxItems = 2

PresetWorkloadSnapshotRule

pydantic model pypureclient.flasharray.PresetWorkloadSnapshotRule(*, at: Optional[StrictStr] = None, every: StrictStr, keep_for: StrictStr)
field at: Optional[StrictStr] = None

Specifies the number of milliseconds since midnight at which to take a snapshot. The at value cannot be set if the every value is not measured in days. The at value can only be set on the first rule.

field every: StrictStr [Required]

Specifies the interval between snapshots, in milliseconds. The every value for all rules must be multiples of one another. The every value must be between five minutes and 400 days for the first rule. The every value must be between five minutes and one day for the second rule.

field keep_for: StrictStr [Required]

Specifies the period that snapshots are retained before they are eradicated, in milliseconds. The keep_for value must be between 10 minutes and 24855 days for the first rule, and a multiple of a second. The keep_for value must be between 10 minutes and 2147483647 days for the second rule, and must be greater than or equal to the keep_for value of the first rule.

PresetWorkloadVolumeConfiguration

pydantic model pypureclient.flasharray.PresetWorkloadVolumeConfiguration(*, count: StrictStr, name: StrictStr, periodic_replication_configurations: Optional[ConstrainedListValue[StrictStr]] = None, placement_configurations: ConstrainedListValue[StrictStr], provisioned_size: StrictStr, snapshot_configurations: Optional[ConstrainedListValue[StrictStr]] = None)
field count: StrictStr [Required]

The number of volumes to provision. Supports parameterization.

field name: StrictStr [Required]

The name of the volume configuration, by which other configuration objects in the preset can reference it. Name must be unique across all configuration objects in the preset.

field periodic_replication_configurations: Optional[ConstrainedListValue[StrictStr]] = None

The names of the periodic replication configurations to apply to the volumes.

field placement_configurations: ConstrainedListValue[StrictStr] [Required]

The names of the placement configurations with which to associate the volumes.

Constraints

  • minItems = 1

  • maxItems = 1

field provisioned_size: StrictStr [Required]

The virtual size of each volume. Measured in bytes and must be a multiple of 512. The maximum size is 4503599627370496 (4PB). Supports parameterization.

field snapshot_configurations: Optional[ConstrainedListValue[StrictStr]] = None

The names of the snapshot configurations to apply to the volumes.

PresetWorkloadWorkloadTag

pydantic model pypureclient.flasharray.PresetWorkloadWorkloadTag(*, copyable: Optional[StrictStr] = None, key: StrictStr, namespace: Optional[StrictStr] = None, value: StrictStr)
field copyable: Optional[StrictStr] = None

Specifies whether to include the tag when copying the parent resource. If set to true, the tag is included in resource copying. If set to false, the tag is not included. If not specified, defaults to true.

field key: StrictStr [Required]

Key of the tag. Supports up to 64 Unicode characters.

field namespace: Optional[StrictStr] = None

Optional namespace of the tag. Namespace identifies the category of the tag. Omitting the namespace defaults to the namespace default. The pure&#42; namespaces are reserved for plugins and integration partners. It is recommended that customers avoid using reserved namespaces.

field value: StrictStr [Required]

Value of the tag. Supports up to 256 Unicode characters. Supports parameterization.

PriorityAdjustment

pydantic model pypureclient.flasharray.PriorityAdjustment(*, priority_adjustment_operator: Optional[StrictStr] = None, priority_adjustment_value: Optional[StrictInt] = None)
field priority_adjustment_operator: Optional[StrictStr] = None

Valid values are +, -, and =. The values + and - may be applied to volumes and volume groups to reflect the relative importance of their workloads. Volumes and volume groups can be assigned a priority adjustment of -10, 0, or +10. In addition, volumes can be assigned values of =-10, =0, or =+10. Volumes with settings of -10, 0, +10 can be modified by the priority adjustment setting of a volume group that contains the volume. However, if a volume has a priority adjustment set with the = operator (for example, =+10), it retains that value and is unaffected by any volume group priority adjustment settings.

field priority_adjustment_value: Optional[StrictInt] = None

Adjust priority by the specified amount, using the priority_adjustment_operator. Valid values are 0 and +10 for + and - operators, -10, 0, and +10 for the = operator.

ProtectionGroup

pydantic model pypureclient.flasharray.ProtectionGroup(*, name: Optional[StrictStr] = None, id: Optional[StrictStr] = None, context: Optional[FixedReference] = None, workload: Optional[WorkloadConfigurationFixedReferenceWorkload] = None, destroyed: Optional[StrictBool] = None, eradication_config: Optional[ProtectionGroupEradicationConfig] = None, host_count: Optional[StrictInt] = None, host_group_count: Optional[StrictInt] = None, is_local: Optional[StrictBool] = None, pod: Optional[FixedReference] = None, replication_schedule: Optional[ReplicationSchedule] = None, retention_lock: Optional[StrictStr] = None, snapshot_schedule: Optional[SnapshotSchedule] = None, source: Optional[FixedReference] = None, source_retention: Optional[RetentionPolicy] = None, space: Optional[Space] = None, target_count: Optional[StrictInt] = None, target_retention: Optional[RetentionPolicy] = None, time_remaining: Optional[StrictInt] = None, volume_count: Optional[StrictInt] = None)
field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field destroyed: Optional[StrictBool] = None

Has this protection group been destroyed? To destroy a protection group, patch to true. To recover a destroyed protection group, patch to false. If not specified, defaults to false.

Constraints

  • type = boolean

field eradication_config: Optional[ProtectionGroupEradicationConfig] = None
field host_count: Optional[StrictInt] = None

Number of hosts in this protection group.

field host_group_count: Optional[StrictInt] = None

Number of host groups in this protection group.

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field is_local: Optional[StrictBool] = None

If set to true, the protection group belongs to the local array. If set to false, the protection group belongs to the remote array.

Constraints

  • type = boolean

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

field pod: Optional[FixedReference] = None

The pod in which the protection group resides.

field replication_schedule: Optional[ReplicationSchedule] = None

The schedule settings for asynchronous replication.

field retention_lock: Optional[StrictStr] = None

The valid values are ratcheted and unlocked. The default value for a newly created protection group is unlocked. Set retention_lock to ratcheted to enable SafeMode restrictions on the protection group. Contact Pure Technical Services to change retention_lock to unlocked.

field snapshot_schedule: Optional[SnapshotSchedule] = None

The schedule settings for protection group snapshots.

field source: Optional[FixedReference] = None

The array or pod on which the protection group was created.

field source_retention: Optional[RetentionPolicy] = None

The retention policy for the source array of the protection group.

field space: Optional[Space] = None

Displays provisioned size and physical storage consumption data for each protection group.

field target_count: Optional[StrictInt] = None

The number of targets to where this protection group replicates.

field target_retention: Optional[RetentionPolicy] = None

The retention policy for the target(s) of the protection group.

field time_remaining: Optional[StrictInt] = None

The amount of time left until the destroyed protection group is permanently eradicated. Measured in milliseconds. Before the time_remaining period has elapsed, the destroyed protection group can be recovered by setting destroyed=false.

field volume_count: Optional[StrictInt] = None

The number of volumes in the protection group.

field workload: Optional[WorkloadConfigurationFixedReferenceWorkload] = None

ProtectionGroupEradicationConfig

pydantic model pypureclient.flasharray.ProtectionGroupEradicationConfig(*, manual_eradication: Optional[StrictStr] = None)

The configuration of the eradication feature.

field manual_eradication: Optional[StrictStr] = None

Manual eradication status of objects like protection group and protection group snapshots. If manual_eradication is disabled, you cannot eradicate objects. Values include disabled and enabled.

ProtectionGroupGetResponse

pydantic model pypureclient.flasharray.ProtectionGroupGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[ProtectionGroup]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None, total: Optional[ConstrainedListValue[ProtectionGroup]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[ProtectionGroup]] = None

Displays a list of all items after filtering. If applicable, the values are displayed for each name. If total_only=true, the items list will be empty.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total: Optional[ConstrainedListValue[ProtectionGroup]] = None

The aggregate value of all items after filtering. When applicable, the average value is displayed instead. If applicable, the values are displayed for each field.

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

ProtectionGroupPerformance

pydantic model pypureclient.flasharray.ProtectionGroupPerformance(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, bytes_per_sec: Optional[ConstrainedIntValue] = None, context: Optional[FixedReference] = None, time: Optional[StrictInt] = None)
field bytes_per_sec: Optional[ConstrainedIntValue] = None

The total number of bytes of replication data transmitted and received per second.

Constraints

  • minimum = 0

field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field name: Optional[StrictStr] = None

A locally unique, system-generated name. The name cannot be modified.

field time: Optional[StrictInt] = None

The time when the sample performance data was taken. Measured in milliseconds since the UNIX epoch.

ProtectionGroupPerformanceArray

pydantic model pypureclient.flasharray.ProtectionGroupPerformanceArray(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, bytes_per_sec: Optional[ConstrainedIntValue] = None, context: Optional[FixedReference] = None, source: Optional[StrictStr] = None, target: Optional[StrictStr] = None, time: Optional[StrictInt] = None)
field bytes_per_sec: Optional[ConstrainedIntValue] = None

The total number of bytes of replication data transmitted and received per second.

Constraints

  • minimum = 0

field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field name: Optional[StrictStr] = None

A locally unique, system-generated name. The name cannot be modified.

field source: Optional[StrictStr] = None

The source array from where the data is replicated.

field target: Optional[StrictStr] = None

The target to where the data is replicated.

field time: Optional[StrictInt] = None

The time when the sample performance data was taken. Measured in milliseconds since the UNIX epoch.

ProtectionGroupPerformanceArrayResponse

pydantic model pypureclient.flasharray.ProtectionGroupPerformanceArrayResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None, items: Optional[ConstrainedListValue[ProtectionGroupPerformanceArray]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[ProtectionGroupPerformanceArray]] = None

Lists performance data, broken down by array.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

ProtectionGroupPerformanceResponse

pydantic model pypureclient.flasharray.ProtectionGroupPerformanceResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None, items: Optional[ConstrainedListValue[ProtectionGroupPerformance]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[ProtectionGroupPerformance]] = None

A list of protection group performance objects.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

ProtectionGroupPost

pydantic model pypureclient.flasharray.ProtectionGroupPost(*, tags: Optional[ConstrainedListValue[Tag]] = None)
field tags: Optional[ConstrainedListValue[Tag]] = None

The list of tags to be upserted with the object.

ProtectionGroupResponse

pydantic model pypureclient.flasharray.ProtectionGroupResponse(*, items: Optional[ConstrainedListValue[ProtectionGroup]] = None)
field items: Optional[ConstrainedListValue[ProtectionGroup]] = None

Displays a list of all items after filtering. If applicable, the values are displayed for each name. If total_only=true, the items list will be empty.

ProtectionGroupSnapshot

pydantic model pypureclient.flasharray.ProtectionGroupSnapshot(*, name: Optional[StrictStr] = None, id: Optional[StrictStr] = None, context: Optional[FixedReference] = None, created: Optional[StrictInt] = None, destroyed: Optional[StrictBool] = None, eradication_config: Optional[ProtectionGroupEradicationConfig] = None, pod: Optional[FixedReference] = None, source: Optional[FixedReference] = None, space: Optional[Space] = None, suffix: Optional[StrictStr] = None, time_remaining: Optional[StrictInt] = None)
field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field created: Optional[StrictInt] = None

The snapshot creation time of the original snapshot source. Measured in milliseconds since the UNIX epoch.

field destroyed: Optional[StrictBool] = None

Returns a value of true if the protection group snapshot has been destroyed and is pending eradication. The time_remaining value displays the amount of time left until the destroyed snapshot is permanently eradicated. Before the time_remaining period has elapsed, the destroyed snapshot can be recovered by setting destroyed=false. Once the time_remaining period has elapsed, the snapshot is permanently eradicated and can no longer be recovered.

Constraints

  • type = boolean

field eradication_config: Optional[ProtectionGroupEradicationConfig] = None
field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

field pod: Optional[FixedReference] = None

The pod in which the protection group of the protection group snapshot resides.

field source: Optional[FixedReference] = None

The original protection group from which this snapshot was taken. For a replicated protection group snapshot being viewed on the target side, the source is the replica protection group.

field space: Optional[Space] = None

Displays provisioned size and physical storage consumption data for each protection group.

field suffix: Optional[StrictStr] = None

The name suffix appended to the protection group name to make up the full protection group snapshot name in the form PGROUP.SUFFIX. If suffix is not specified, the protection group name is in the form PGROUP.NNN, where NNN is a unique monotonically increasing number. If multiple protection group snapshots are created at a time, the suffix name is appended to those snapshots.

field time_remaining: Optional[StrictInt] = None

The amount of time left until the destroyed snapshot is permanently eradicated. Measured in milliseconds. Before the time_remaining period has elapsed, the destroyed snapshot can be recovered by setting destroyed=false.

ProtectionGroupSnapshotGetResponse

pydantic model pypureclient.flasharray.ProtectionGroupSnapshotGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[ProtectionGroupSnapshot]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None, total: Optional[ConstrainedListValue[ProtectionGroupSnapshot]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[ProtectionGroupSnapshot]] = None

Displays a list of all items after filtering. If applicable, the values are displayed for each name.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total: Optional[ConstrainedListValue[ProtectionGroupSnapshot]] = None

The aggregate value of all items after filtering. If applicable, the average value is displayed instead. If applicable, the values are displayed for each field.

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

ProtectionGroupSnapshotPatch

pydantic model pypureclient.flasharray.ProtectionGroupSnapshotPatch(*, name: Optional[StrictStr] = None, id: Optional[StrictStr] = None, context: Optional[FixedReference] = None, created: Optional[StrictInt] = None, destroyed: Optional[StrictBool] = None, eradication_config: Optional[ProtectionGroupEradicationConfig] = None, pod: Optional[FixedReference] = None, source: Optional[FixedReference] = None, space: Optional[Space] = None, suffix: Optional[StrictStr] = None, time_remaining: Optional[StrictInt] = None)
field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field created: Optional[StrictInt] = None

The snapshot creation time of the original snapshot source. Measured in milliseconds since the UNIX epoch.

field destroyed: Optional[StrictBool] = None

Returns a value of true if the protection group snapshot has been destroyed and is pending eradication. The time_remaining value displays the amount of time left until the destroyed snapshot is permanently eradicated. Before the time_remaining period has elapsed, the destroyed snapshot can be recovered by setting destroyed=false. Once the time_remaining period has elapsed, the snapshot is permanently eradicated and can no longer be recovered.

Constraints

  • type = boolean

field eradication_config: Optional[ProtectionGroupEradicationConfig] = None
field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

field pod: Optional[FixedReference] = None

The pod in which the protection group of the protection group snapshot resides.

field source: Optional[FixedReference] = None

The original protection group from which this snapshot was taken. For a replicated protection group snapshot being viewed on the target side, the source is the replica protection group.

field space: Optional[Space] = None

Displays provisioned size and physical storage consumption data for each protection group.

field suffix: Optional[StrictStr] = None
field time_remaining: Optional[StrictInt] = None

The amount of time left until the destroyed snapshot is permanently eradicated. Measured in milliseconds. Before the time_remaining period has elapsed, the destroyed snapshot can be recovered by setting destroyed=false.

ProtectionGroupSnapshotPost

pydantic model pypureclient.flasharray.ProtectionGroupSnapshotPost(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, context: Optional[FixedReference] = None, created: Optional[StrictInt] = None, destroyed: Optional[StrictBool] = None, eradication_config: Optional[ProtectionGroupEradicationConfig] = None, pod: Optional[FixedReference] = None, source: Optional[FixedReference] = None, space: Optional[Space] = None, suffix: Optional[StrictStr] = None, time_remaining: Optional[StrictInt] = None)
field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field created: Optional[StrictInt] = None

The snapshot creation time of the original snapshot source. Measured in milliseconds since the UNIX epoch.

field destroyed: Optional[StrictBool] = None
Constraints

  • type = boolean

field eradication_config: Optional[ProtectionGroupEradicationConfig] = None
field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

field pod: Optional[FixedReference] = None

The pod in which the protection group of the protection group snapshot resides.

field source: Optional[FixedReference] = None

The original protection group from which this snapshot was taken. For a replicated protection group snapshot being viewed on the target side, the source is the replica protection group.

field space: Optional[Space] = None

Displays provisioned size and physical storage consumption data for each protection group.

field suffix: Optional[StrictStr] = None

The name suffix appended to the protection group name to make up the full protection group snapshot name in the form PGROUP.SUFFIX. If suffix is not specified, the protection group name is in the form PGROUP.NNN, where NNN is a unique monotonically increasing number. If multiple protection group snapshots are created at a time, the suffix name is appended to those snapshots.

field time_remaining: Optional[StrictInt] = None

The amount of time left until the destroyed snapshot is permanently eradicated. Measured in milliseconds. Before the time_remaining period has elapsed, the destroyed snapshot can be recovered by setting destroyed=false.

ProtectionGroupSnapshotReplica

pydantic model pypureclient.flasharray.ProtectionGroupSnapshotReplica(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, context: Optional[FixedReference] = None, created: Optional[StrictInt] = None, destroyed: Optional[StrictBool] = None, eradication_config: Optional[ProtectionGroupEradicationConfig] = None, pod: Optional[FixedReference] = None, source: Optional[FixedReference] = None, space: Optional[Space] = None, suffix: Optional[StrictStr] = None, time_remaining: Optional[StrictInt] = None)
field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field created: Optional[StrictInt] = None

The snapshot creation time of the original snapshot source. Measured in milliseconds since the UNIX epoch.

field destroyed: Optional[StrictBool] = None

Returns a value of true if the protection group snapshot has been destroyed and is pending eradication. The time_remaining value displays the amount of time left until the destroyed snapshot is permanently eradicated. Before the time_remaining period has elapsed, the destroyed snapshot can be recovered by setting destroyed=false. Once the time_remaining period has elapsed, the snapshot is permanently eradicated and can no longer be recovered.

Constraints

  • type = boolean

field eradication_config: Optional[ProtectionGroupEradicationConfig] = None
field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

field pod: Optional[FixedReference] = None

The pod in which the protection group of the protection group snapshot resides.

field source: Optional[FixedReference] = None

The original protection group from which this snapshot was taken. For a replicated protection group snapshot being viewed on the target side, the source is the replica protection group.

field space: Optional[Space] = None

Displays provisioned size and physical storage consumption data for each protection group.

field suffix: Optional[StrictStr] = None

The name suffix appended to the protection group name to make up the full protection group snapshot name in the form PGROUP.SUFFIX. If suffix is not specified, the protection group name is in the form PGROUP.NNN, where NNN is a unique monotonically increasing number. If multiple protection group snapshots are created at a time, the suffix name is appended to those snapshots.

field time_remaining: Optional[StrictInt] = None

The amount of time left until the destroyed snapshot is permanently eradicated. Measured in milliseconds. Before the time_remaining period has elapsed, the destroyed snapshot can be recovered by setting destroyed=false.

ProtectionGroupSnapshotReplicaResponse

pydantic model pypureclient.flasharray.ProtectionGroupSnapshotReplicaResponse(*, items: Optional[ConstrainedListValue[ProtectionGroupSnapshotReplica]] = None)
field items: Optional[ConstrainedListValue[ProtectionGroupSnapshotReplica]] = None

Displays a list of all items after the operation. If applicable, the values are displayed for each name.

ProtectionGroupSnapshotResponse

pydantic model pypureclient.flasharray.ProtectionGroupSnapshotResponse(*, items: Optional[ConstrainedListValue[ProtectionGroupSnapshot]] = None)
field items: Optional[ConstrainedListValue[ProtectionGroupSnapshot]] = None

Displays a list of all items after filtering. If applicable, the values are displayed for each name.

ProtectionGroupSnapshotTransfer

pydantic model pypureclient.flasharray.ProtectionGroupSnapshotTransfer(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, completed: Optional[StrictInt] = None, data_transferred: Optional[StrictInt] = None, destroyed: Optional[StrictBool] = None, physical_bytes_written: Optional[StrictInt] = None, progress: Optional[Union[StrictFloat, StrictInt]] = None, started: Optional[StrictInt] = None, context: Optional[FixedReference] = None)
field completed: Optional[StrictInt] = None

The timestamp of when the snapshot replication process completed. Measured in milliseconds since the UNIX epoch.

field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field data_transferred: Optional[StrictInt] = None

The number of bytes transferred from the source to the target as part of the replication process. Measured in bytes.

field destroyed: Optional[StrictBool] = None

Returns a value of true if the snapshot has been destroyed and is pending eradication. The destroyed snapshot can be recovered by setting destroyed=false. Once the eradication pending period has elapsed, the snapshot is permanently eradicated and can no longer be recovered.

Constraints

  • type = boolean

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

field physical_bytes_written: Optional[StrictInt] = None

The amount of physical/logical data written to the target due to replication. Measured in bytes.

field progress: Optional[Union[StrictFloat, StrictInt]] = None

The percentage progress of the snapshot transfer from the source array to the target. Displayed in decimal format.

field started: Optional[StrictInt] = None

The timestamp of when the snapshot replication process started. Measured in milliseconds since the UNIX epoch.

ProtectionGroupSnapshotTransferGetResponse

pydantic model pypureclient.flasharray.ProtectionGroupSnapshotTransferGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[ProtectionGroupSnapshotTransfer]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None, total: Optional[ConstrainedListValue[ProtectionGroupSnapshotTransfer]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[ProtectionGroupSnapshotTransfer]] = None

Displays a list of all items after filtering. If applicable, the values are displayed for each name.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total: Optional[ConstrainedListValue[ProtectionGroupSnapshotTransfer]] = None

The aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. If applicable, the values are displayed for each field.

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

ProtectionGroupSnapshotTransferResponse

pydantic model pypureclient.flasharray.ProtectionGroupSnapshotTransferResponse(*, items: Optional[ConstrainedListValue[ProtectionGroupSnapshotTransfer]] = None)
field items: Optional[ConstrainedListValue[ProtectionGroupSnapshotTransfer]] = None

Displays a list of all items after filtering. If applicable, the values are displayed for each name.

ProtectionGroupTarget

pydantic model pypureclient.flasharray.ProtectionGroupTarget(*, allowed: Optional[StrictBool] = None, protection_group: Optional[ReferenceNoId] = None, target: Optional[ReferenceNoId] = None)
field allowed: Optional[StrictBool] = None

If set to true, the target array has allowed the source array to replicate protection group data to the target array. If set to false, the target array has not allowed the source array to replicate protection group data to the target.

Constraints

  • type = boolean

field protection_group: Optional[ReferenceNoId] = None
field target: Optional[ReferenceNoId] = None

ProtectionGroupTargetGetResponse

pydantic model pypureclient.flasharray.ProtectionGroupTargetGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[TargetProtectionGroup]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[TargetProtectionGroup]] = None

Displays a list of all items after filtering. If applicable, the values are displayed for each name.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

ProtectionGroupTargetResponse

pydantic model pypureclient.flasharray.ProtectionGroupTargetResponse(*, items: Optional[ConstrainedListValue[TargetProtectionGroup]] = None)
field items: Optional[ConstrainedListValue[TargetProtectionGroup]] = None

Displays a list of all items after filtering. If applicable, the values are displayed for each name.

ProtectionGroupsVolumes

pydantic model pypureclient.flasharray.ProtectionGroupsVolumes(*, context: Optional[FixedReference] = None, group: Optional[Reference] = None, member: Optional[ProtectionGroupsVolumesMember] = None)
field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field group: Optional[Reference] = None
field member: Optional[ProtectionGroupsVolumesMember] = None

ProtectionGroupsVolumesGetResponse

pydantic model pypureclient.flasharray.ProtectionGroupsVolumesGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[ProtectionGroupsVolumes]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[ProtectionGroupsVolumes]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

ProtectionGroupsVolumesMember

pydantic model pypureclient.flasharray.ProtectionGroupsVolumesMember(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None)
field destroyed: Optional[StrictBool] = None

Returns a value of true if the volume has been destroyed and is pending eradication. Through the volumes endpoint, the user can see time_remaining of the destroyed volume, recover, or eradicate the destroyed volume.

Constraints

  • type = boolean

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified.

field name: Optional[StrictStr] = None

The resource name, such as volume name, pod name, snapshot name, and so on.

ProtectionGroupsVolumesResponse

pydantic model pypureclient.flasharray.ProtectionGroupsVolumesResponse(*, items: Optional[ConstrainedListValue[ProtectionGroupsVolumes]] = None)
field items: Optional[ConstrainedListValue[ProtectionGroupsVolumes]] = None

ProtocolEndpoint

pydantic model pypureclient.flasharray.ProtocolEndpoint(*, container_version: Optional[StrictStr] = None)
field container_version: Optional[StrictStr] = None

Defines vCenter and EXSi host compatibility of the protocol endpoint and its associated container. Valid values include: 1, 2, 3. When container_version is set to 1, it’s compatible with vSphere version 7.0.1 or higher. When container_version is set to 2, it’s compatible with vSphere version 8.0.0 or higher. When container_version is set to 3, it’s compatible with vSphere version 8.0.1 or higher. The default container_version is 1.

Qos

pydantic model pypureclient.flasharray.Qos(*, bandwidth_limit: Optional[ConstrainedIntValue] = None, iops_limit: Optional[ConstrainedIntValue] = None)
field bandwidth_limit: Optional[ConstrainedIntValue] = None

The maximum QoS bandwidth limit for the volume. Whenever throughput exceeds the bandwidth limit, throttling occurs. Measured in bytes per second. Maximum limit is 512 GB/s.

Constraints

  • minimum = 1048576

  • maximum = 549755813888

field iops_limit: Optional[ConstrainedIntValue] = None

The QoS IOPs limit for the volume.

Constraints

  • minimum = 100

  • maximum = 100000000

Realm

pydantic model pypureclient.flasharray.Realm(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, created: Optional[StrictInt] = None, destroyed: Optional[StrictBool] = None, eradication_config: Optional[ContainerEradicationConfig] = None, qos: Optional[ContainerQos] = None, quota_limit: Optional[ConstrainedIntValue] = None, space: Optional[SpaceNoDeprecatedPhysicalOrEffective] = None, time_remaining: Optional[StrictInt] = None)
field created: Optional[StrictInt] = None

Creation timestamp of the realm.

field destroyed: Optional[StrictBool] = None

Returns a value of true if the realm has been destroyed and is pending eradication. The realm cannot be modified while it is in the destroyed state. The time_remaining value displays the amount of time left until the destroyed realm is permanently eradicated. Once eradication has begun, the realm can no longer be recovered. Before the time_remaining period has elapsed, the destroyed realm can be recovered through the PATCH method

Constraints

  • type = boolean

field eradication_config: Optional[ContainerEradicationConfig] = None
field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

field qos: Optional[ContainerQos] = None

Displays QoS limit information.

field quota_limit: Optional[ConstrainedIntValue] = None

The logical quota limit of the realm, measured in bytes.

Constraints

  • maximum = 4503599627370496

field space: Optional[SpaceNoDeprecatedPhysicalOrEffective] = None

Displays provisioned size and physical storage consumption information for the realm.

field time_remaining: Optional[StrictInt] = None

Time in milliseconds before the realm is eradicated. null if not destroyed.

RealmGetResponse

pydantic model pypureclient.flasharray.RealmGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Realm]] = None, total: Optional[ConstrainedListValue[Realm]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[Realm]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total: Optional[ConstrainedListValue[Realm]] = None

The aggregate value of all items after filtering. When applicable, the average value is displayed instead. The values are displayed for each field, if meaningful.

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

RealmPatch

pydantic model pypureclient.flasharray.RealmPatch(*, name: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, qos: Optional[ContainerQos] = None, quota_limit: Optional[ConstrainedIntValue] = None)
field destroyed: Optional[StrictBool] = None

If set to true, the realm will be destroyed and pending eradication. The time_remaining value displays the amount of time left until the destroyed realm is permanently eradicated. A realm can only be destroyed if it is empty or destroy_contents is set to true. Before the time_remaining period has elapsed, the destroyed realm can be recovered by setting destroyed=false. Once the time_remaining period has elapsed, the realm is permanently eradicated and can no longer be recovered.

Constraints

  • type = boolean

field name: Optional[StrictStr] = None

The new name for the resource.

field qos: Optional[ContainerQos] = None

Sets QoS limits.

field quota_limit: Optional[ConstrainedIntValue] = None

The logical quota limit of the realm, measured in bytes.

Constraints

  • minimum = 1048576

  • maximum = 4503599627370496

RealmPost

pydantic model pypureclient.flasharray.RealmPost(*, qos: Optional[ContainerQos] = None, quota_limit: Optional[ConstrainedIntValue] = None, tags: Optional[ConstrainedListValue[NonCopyableTag]] = None)
field qos: Optional[ContainerQos] = None

Sets QoS limits.

field quota_limit: Optional[ConstrainedIntValue] = None

The logical quota limit of the realm, measured in bytes. Must be a multiple of 512.

Constraints

  • minimum = 1048576

  • maximum = 4503599627370496

field tags: Optional[ConstrainedListValue[NonCopyableTag]] = None

The list of tags to be upserted with the object.

RealmResponse

pydantic model pypureclient.flasharray.RealmResponse(*, items: Optional[ConstrainedListValue[Realm]] = None)
field items: Optional[ConstrainedListValue[Realm]] = None

RealmSpaceGetResponse

pydantic model pypureclient.flasharray.RealmSpaceGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[ResourceRealmSpace]] = None, total: Optional[ConstrainedListValue[ResourceRealmSpace]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[ResourceRealmSpace]] = None

Displays a list of all items after filtering. If applicable, the values are displayed for each name. If total_only=true, the items list will be empty.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total: Optional[ConstrainedListValue[ResourceRealmSpace]] = None

The aggregate value of all items after filtering. When applicable, the average value is displayed instead. The values are displayed for each field, if meaningful.

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

Reference

pydantic model pypureclient.flasharray.Reference(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None)
field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified.

field name: Optional[StrictStr] = None

The resource name, such as volume name, pod name, snapshot name, and so on.

ReferenceNoId

pydantic model pypureclient.flasharray.ReferenceNoId(*, name: Optional[StrictStr] = None)
field name: Optional[StrictStr] = None

The resource name, such as volume name, pod name, snapshot name, and so on.

ReferenceNoIdWithType

pydantic model pypureclient.flasharray.ReferenceNoIdWithType(*, name: Optional[StrictStr] = None, resource_type: Optional[StrictStr] = None)
field name: Optional[StrictStr] = None

The resource name, such as volume name, pod name, snapshot name, and so on.

field resource_type: Optional[StrictStr] = None

Type of the object (full name of the endpoint). Valid values include hosts, host-groups, network-interfaces, pods, ports, pod-replica-links, subnets, volumes, volume-snapshots, volume-groups, directories, policies/nfs, policies/smb, and policies/snapshot, etc.

ReferenceWithFixedType

pydantic model pypureclient.flasharray.ReferenceWithFixedType(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, resource_type: Optional[StrictStr] = None)
field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified.

field name: Optional[StrictStr] = None

The resource name, such as volume name, pod name, snapshot name, and so on.

field resource_type: Optional[StrictStr] = None

Type of the object (full name of the endpoint). Valid values are hosts, host-groups, network-interfaces, pods, ports, pod-replica-links, subnets, volumes, volume-snapshots, volume-groups, directories, policies/nfs, policies/smb, and policies/snapshot, etc.

ReferenceWithType

pydantic model pypureclient.flasharray.ReferenceWithType(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, resource_type: Optional[StrictStr] = None)
field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified.

field name: Optional[StrictStr] = None

The resource name, such as volume name, pod name, snapshot name, and so on.

field resource_type: Optional[StrictStr] = None

Type of the object (full name of the endpoint). Valid values are hosts, host-groups, network-interfaces, pods, ports, pod-replica-links, subnets, volumes, volume-snapshots, volume-groups, directories, policies/nfs, policies/smb, and policies/snapshot, etc.

RemoteArray

pydantic model pypureclient.flasharray.RemoteArray(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, fleet: Optional[RemoteArrayFleet] = None, is_local: Optional[StrictBool] = None, model: Optional[StrictStr] = None, os: Optional[StrictStr] = None, version: Optional[StrictStr] = None)
field fleet: Optional[RemoteArrayFleet] = None
field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field is_local: Optional[StrictBool] = None

If set to true, this array is the current array.

Constraints

  • type = boolean

field model: Optional[StrictStr] = None

Specifies the array model.

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

field os: Optional[StrictStr] = None

Specifies the operating system. Valid values are Purity, Purity//FA, and Purity//FB.

field version: Optional[StrictStr] = None

Specifies the operating system version.

RemoteArrayFleet

pydantic model pypureclient.flasharray.RemoteArrayFleet(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, is_local: Optional[StrictBool] = None)
field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field is_local: Optional[StrictBool] = None

If set to true, the current array is a member of the fleet.

Constraints

  • type = boolean

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

RemoteArraysResponse

pydantic model pypureclient.flasharray.RemoteArraysResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[RemoteArray]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[RemoteArray]] = None

Returns a list of all items after filtering. The values are displayed for each name where meaningful.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

RemotePod

pydantic model pypureclient.flasharray.RemotePod(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, context: Optional[FixedReference] = None, arrays: Optional[ConstrainedListValue[Resource]] = None)
field arrays: Optional[ConstrainedListValue[Resource]] = None
Constraints

  • minItems = 1

field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

RemotePodsResponse

pydantic model pypureclient.flasharray.RemotePodsResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None, items: Optional[ConstrainedListValue[RemotePod]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[RemotePod]] = None

Displays a list of all items after filtering. The values are displayed for each name where meaningful.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

RemoteProtectionGroup

pydantic model pypureclient.flasharray.RemoteProtectionGroup(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, context: Optional[FixedReference] = None, destroyed: Optional[StrictBool] = None, is_local: Optional[StrictBool] = None, remote: Optional[FixedReference] = None, source: Optional[FixedReference] = None, target_retention: Optional[RetentionPolicy] = None, time_remaining: Optional[StrictInt] = None)
field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field destroyed: Optional[StrictBool] = None

Returns a value of true if the remote protection group has been destroyed and is pending eradication. The time_remaining value displays the amount of time left until the destroyed remote protection group is permanently eradicated. Before the time_remaining period has elapsed, the destroyed remote protection group can be recovered by setting destroyed=false. Once the time_remaining period has elapsed, the remote protection group is permanently eradicated and can no longer be recovered.

Constraints

  • type = boolean

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field is_local: Optional[StrictBool] = None

If set to true, the location reference is to the local array. If set to false, the location reference is to a remote location, such as a remote array or offload target.

Constraints

  • type = boolean

field name: Optional[StrictStr] = None

A locally unique, system-generated name. The name cannot be modified.

field remote: Optional[FixedReference] = None

The offload target that the remote protection group is on.

field source: Optional[FixedReference] = None

The array where the remote protection group is replicated from.

field target_retention: Optional[RetentionPolicy] = None

The retention policy for the remote protection group.

field time_remaining: Optional[StrictInt] = None

Milliseconds remaining until eradication, if remote protection group has been destroyed.

RemoteProtectionGroupGetResponse

pydantic model pypureclient.flasharray.RemoteProtectionGroupGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[RemoteProtectionGroup]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[RemoteProtectionGroup]] = None

Displays a list of all items after filtering. The values are displayed for each name where meaningful.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

RemoteProtectionGroupResponse

pydantic model pypureclient.flasharray.RemoteProtectionGroupResponse(*, items: Optional[ConstrainedListValue[RemoteProtectionGroup]] = None)
field items: Optional[ConstrainedListValue[RemoteProtectionGroup]] = None

Displays a list of all items after filtering. The values are displayed for each name where meaningful.

RemoteProtectionGroupSnapshot

pydantic model pypureclient.flasharray.RemoteProtectionGroupSnapshot(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, context: Optional[FixedReference] = None, created: Optional[StrictInt] = None, destroyed: Optional[StrictBool] = None, is_local: Optional[StrictBool] = None, remote: Optional[FixedReference] = None, source: Optional[FixedReference] = None, suffix: Optional[StrictStr] = None, time_remaining: Optional[StrictInt] = None)
field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field created: Optional[StrictInt] = None

The creation time of the snapshot on the original source of the snapshot. Measured in milliseconds since the UNIX epoch.

field destroyed: Optional[StrictBool] = None

Destroyed and pending eradication? If not specified, defaults to false.

Constraints

  • type = boolean

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field is_local: Optional[StrictBool] = None

The status of whether or not the remote protection group snapshot is replicated from the current array.

Constraints

  • type = boolean

field name: Optional[StrictStr] = None

A locally unique, system-generated name. The name cannot be modified.

field remote: Optional[FixedReference] = None

The offload target where the remote protection group snapshot is located.

field source: Optional[FixedReference] = None

The original protection group from which this snapshot was taken.

field suffix: Optional[StrictStr] = None

The suffix that is appended to the source_name value to generate the full remote protection group snapshot name in the form PGROUP.SUFFIX. If the suffix is not specified, the system constructs the snapshot name in the form PGROUP.NNN, where PGROUP is the protection group name, and NNN is a monotonically increasing number.

field time_remaining: Optional[StrictInt] = None

The time remaining until eradication, measured in milliseconds, if the snapshot has been destroyed.

RemoteProtectionGroupSnapshotGetResponse

pydantic model pypureclient.flasharray.RemoteProtectionGroupSnapshotGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[RemoteProtectionGroupSnapshot]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[RemoteProtectionGroupSnapshot]] = None

Displays a list of all items after filtering. If applicable, the values are displayed for each name.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

RemoteProtectionGroupSnapshotPost

pydantic model pypureclient.flasharray.RemoteProtectionGroupSnapshotPost(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, context: Optional[FixedReference] = None, created: Optional[StrictInt] = None, destroyed: Optional[StrictBool] = None, is_local: Optional[StrictBool] = None, remote: Optional[FixedReference] = None, source: Optional[FixedReference] = None, suffix: Optional[StrictStr] = None, time_remaining: Optional[StrictInt] = None)
field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field created: Optional[StrictInt] = None

The creation time of the snapshot on the original source of the snapshot. Measured in milliseconds since the UNIX epoch.

field destroyed: Optional[StrictBool] = None
Constraints

  • type = boolean

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field is_local: Optional[StrictBool] = None

The status of whether or not the remote protection group snapshot is replicated from the current array.

Constraints

  • type = boolean

field name: Optional[StrictStr] = None

A locally unique, system-generated name. The name cannot be modified.

field remote: Optional[FixedReference] = None

The offload target where the remote protection group snapshot is located.

field source: Optional[FixedReference] = None

The original protection group from which this snapshot was taken.

field suffix: Optional[StrictStr] = None

Specifies a name suffix for the snapshots created. The snapshot is created on the FlashArray specified by the on parameter. The on parameter cannot refer to an offload target. Snapshots with suffixes specified have names in the form PGROUP.SUFFIX instead of the default PGROUP.NNN form. The names of all snapshots created by a single command that specifies this option have the same suffix.

field time_remaining: Optional[StrictInt] = None

The time remaining until eradication, measured in milliseconds, if the snapshot has been destroyed.

RemoteProtectionGroupSnapshotResponse

pydantic model pypureclient.flasharray.RemoteProtectionGroupSnapshotResponse(*, items: Optional[ConstrainedListValue[RemoteProtectionGroupSnapshot]] = None)
field items: Optional[ConstrainedListValue[RemoteProtectionGroupSnapshot]] = None

Displays a list of all items after filtering. If applicable, the values are displayed for each name.

RemoteProtectionGroupSnapshotTransfer

pydantic model pypureclient.flasharray.RemoteProtectionGroupSnapshotTransfer(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, completed: Optional[StrictInt] = None, data_transferred: Optional[StrictInt] = None, destroyed: Optional[StrictBool] = None, physical_bytes_written: Optional[StrictInt] = None, progress: Optional[Union[StrictFloat, StrictInt]] = None, started: Optional[StrictInt] = None, context: Optional[FixedReference] = None, source: Optional[Reference] = None)
field completed: Optional[StrictInt] = None

The timestamp of when the snapshot replication process completed. Measured in milliseconds since the UNIX epoch.

field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field data_transferred: Optional[StrictInt] = None

The number of bytes transferred from the source to the target as part of the replication process. Measured in bytes.

field destroyed: Optional[StrictBool] = None

Returns a value of true if the snapshot has been destroyed and is pending eradication. The destroyed snapshot can be recovered by setting destroyed=false. Once the eradication pending period has elapsed, the snapshot is permanently eradicated and can no longer be recovered.

Constraints

  • type = boolean

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

field physical_bytes_written: Optional[StrictInt] = None

The amount of physical/logical data written to the target due to replication. Measured in bytes.

field progress: Optional[Union[StrictFloat, StrictInt]] = None

The percentage progress of the snapshot transfer from the source array to the target. Displayed in decimal format.

field source: Optional[Reference] = None

The original protection group from which this snapshot was taken.

field started: Optional[StrictInt] = None

The timestamp of when the snapshot replication process started. Measured in milliseconds since the UNIX epoch.

RemoteProtectionGroupSnapshotTransferGetResponse

pydantic model pypureclient.flasharray.RemoteProtectionGroupSnapshotTransferGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[RemoteProtectionGroupSnapshotTransfer]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None, total: Optional[ConstrainedListValue[RemoteProtectionGroupSnapshotTransfer]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[RemoteProtectionGroupSnapshotTransfer]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total: Optional[ConstrainedListValue[RemoteProtectionGroupSnapshotTransfer]] = None

The aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. If applicable, the values are displayed for each field.

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

RemoteProtectionGroupSnapshotTransferResponse

pydantic model pypureclient.flasharray.RemoteProtectionGroupSnapshotTransferResponse(*, items: Optional[ConstrainedListValue[RemoteProtectionGroupSnapshotTransfer]] = None)
field items: Optional[ConstrainedListValue[RemoteProtectionGroupSnapshotTransfer]] = None

RemoteVolumeSnapshot

pydantic model pypureclient.flasharray.RemoteVolumeSnapshot(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, created: Optional[StrictInt] = None, destroyed: Optional[StrictBool] = None, pod: Optional[FixedReference] = None, provisioned: Optional[StrictInt] = None, source: Optional[FixedReference] = None, suffix: Optional[StrictStr] = None, time_remaining: Optional[StrictInt] = None, context: Optional[FixedReference] = None, remote: Optional[FixedReference] = None)
field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field created: Optional[StrictInt] = None

The snapshot creation time. Measured in milliseconds since the UNIX epoch.

field destroyed: Optional[StrictBool] = None

Returns a value of true if the snapshot has been destroyed and is pending eradication. The time_remaining value displays the amount of time left until the destroyed volume snapshot is permanently eradicated. Before the time_remaining period has elapsed, the destroyed volume snapshot can be recovered by setting destroyed=false. Once the time_remaining period has elapsed, the volume snapshot is permanently eradicated and can no longer be recovered.

Constraints

  • type = boolean

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

field pod: Optional[FixedReference] = None

A reference to the pod.

field provisioned: Optional[StrictInt] = None

The provisioned space of the snapshot. Measured in bytes. The minimum size is 1048576 (1MB), the maximum size is 4503599627370496 (4PB)

field remote: Optional[FixedReference] = None

Remote target where this volume snapshot is located.

field source: Optional[FixedReference] = None

The volume from which this snapshot was taken. For a replicated snapshot being viewed on the target side, the source is the replica volume.

field suffix: Optional[StrictStr] = None

The suffix that is appended to the source_name value to generate the full volume snapshot name in the form VOL.SUFFIX. If the suffix is not specified, the system constructs the snapshot name in the form VOL.NNN, where VOL is the volume name, and NNN is a monotonically increasing number.

field time_remaining: Optional[StrictInt] = None

The amount of time left until the destroyed snapshot is permanently eradicated. Measured in milliseconds. Before the time_remaining period has elapsed, the destroyed snapshot can be recovered by setting destroyed=false.

RemoteVolumeSnapshotGetResponse

pydantic model pypureclient.flasharray.RemoteVolumeSnapshotGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[RemoteVolumeSnapshot]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[RemoteVolumeSnapshot]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

RemoteVolumeSnapshotPost

pydantic model pypureclient.flasharray.RemoteVolumeSnapshotPost(*, suffix: Optional[StrictStr] = None)
field suffix: Optional[StrictStr] = None

The suffix that is appended to the source_name value to generate the full volume snapshot name in the form VOL.SUFFIX. If the suffix is not specified, the system constructs the snapshot name in the form VOL.NNN, where VOL is the volume name, and NNN is a monotonically increasing number.

RemoteVolumeSnapshotResponse

pydantic model pypureclient.flasharray.RemoteVolumeSnapshotResponse(*, items: Optional[ConstrainedListValue[RemoteVolumeSnapshot]] = None)
field items: Optional[ConstrainedListValue[RemoteVolumeSnapshot]] = None

RemoteVolumeSnapshotTransfer

pydantic model pypureclient.flasharray.RemoteVolumeSnapshotTransfer(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, completed: Optional[StrictInt] = None, data_transferred: Optional[StrictInt] = None, destroyed: Optional[StrictBool] = None, physical_bytes_written: Optional[StrictInt] = None, progress: Optional[Union[StrictFloat, StrictInt]] = None, started: Optional[StrictInt] = None, context: Optional[FixedReference] = None)
field completed: Optional[StrictInt] = None

The timestamp of when the snapshot replication process completed. Measured in milliseconds since the UNIX epoch.

field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field data_transferred: Optional[StrictInt] = None

The number of bytes transferred from the source to the target as part of the replication process. Measured in bytes.

field destroyed: Optional[StrictBool] = None

Returns a value of true if the snapshot has been destroyed and is pending eradication. The destroyed snapshot can be recovered by setting destroyed=false. Once the eradication pending period has elapsed, the snapshot is permanently eradicated and can no longer be recovered.

Constraints

  • type = boolean

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

field physical_bytes_written: Optional[StrictInt] = None

The amount of physical/logical data written to the target due to replication. Measured in bytes.

field progress: Optional[Union[StrictFloat, StrictInt]] = None

The percentage progress of the snapshot transfer from the source array to the target. Displayed in decimal format.

field started: Optional[StrictInt] = None

The timestamp of when the snapshot replication process started. Measured in milliseconds since the UNIX epoch.

RemoteVolumeSnapshotTransferGetResponse

pydantic model pypureclient.flasharray.RemoteVolumeSnapshotTransferGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[RemoteVolumeSnapshotTransfer]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None, total: Optional[ConstrainedListValue[RemoteVolumeSnapshotTransfer]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[RemoteVolumeSnapshotTransfer]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total: Optional[ConstrainedListValue[RemoteVolumeSnapshotTransfer]] = None

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 field where meaningful.

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

RemoteVolumeSnapshotTransferResponse

pydantic model pypureclient.flasharray.RemoteVolumeSnapshotTransferResponse(*, items: Optional[ConstrainedListValue[RemoteVolumeSnapshotTransfer]] = None)
field items: Optional[ConstrainedListValue[RemoteVolumeSnapshotTransfer]] = None

ReplicaLinkLag

pydantic model pypureclient.flasharray.ReplicaLinkLag(*, avg: Optional[ConstrainedIntValue] = None, max: Optional[ConstrainedIntValue] = None)
field avg: Optional[ConstrainedIntValue] = None

The average time difference between the current time and recovery_point for a period of time.

Constraints

  • minimum = 0

field max: Optional[ConstrainedIntValue] = None

The maximum time difference between the current time and recovery_point for a period of time.

Constraints

  • minimum = 0

ReplicaLinkPerformanceReplication

pydantic model pypureclient.flasharray.ReplicaLinkPerformanceReplication(*, bytes_per_sec_from_remote: Optional[ConstrainedIntValue] = None, bytes_per_sec_to_remote: Optional[ConstrainedIntValue] = None, bytes_per_sec_total: Optional[ConstrainedIntValue] = None, direction: Optional[StrictStr] = None, local_pod: Optional[FixedReference] = None, remote_pod: Optional[FixedReference] = None, remotes: Optional[ConstrainedListValue[FixedReference]] = None, time: Optional[StrictInt] = None)
field bytes_per_sec_from_remote: Optional[ConstrainedIntValue] = None

The number of bytes received per second from a remote array.

Constraints

  • minimum = 0

field bytes_per_sec_to_remote: Optional[ConstrainedIntValue] = None

The number of bytes transmitted per second to a remote array.

Constraints

  • minimum = 0

field bytes_per_sec_total: Optional[ConstrainedIntValue] = None

Total bytes transmitted and received per second.

Constraints

  • minimum = 0

field direction: Optional[StrictStr] = None

The direction of replication. Valid values are inbound and outbound.

field local_pod: Optional[FixedReference] = None

Reference to a local pod.

field remote_pod: Optional[FixedReference] = None

Reference to a remote pod.

field remotes: Optional[ConstrainedListValue[FixedReference]] = None

Reference to a remote array.

field time: Optional[StrictInt] = None

Sample time in milliseconds since the UNIX epoch.

ReplicationPerformanceWithTotal

pydantic model pypureclient.flasharray.ReplicationPerformanceWithTotal(*, from_remote_bytes_per_sec: Optional[ConstrainedIntValue] = None, to_remote_bytes_per_sec: Optional[ConstrainedIntValue] = None, total_bytes_per_sec: Optional[ConstrainedIntValue] = None)
field from_remote_bytes_per_sec: Optional[ConstrainedIntValue] = None

The number of bytes received per second from a remote array. The number will be zero if the arrays are unable to communicate.

Constraints

  • minimum = 0

field to_remote_bytes_per_sec: Optional[ConstrainedIntValue] = None

The number of bytes transmitted per second to a remote array. The number will be zero if the arrays are unable to communicate.

Constraints

  • minimum = 0

field total_bytes_per_sec: Optional[ConstrainedIntValue] = None

Total bytes transmitted and received per second. The number will be zero if the arrays are unable to communicate.

Constraints

  • minimum = 0

ReplicationSchedule

pydantic model pypureclient.flasharray.ReplicationSchedule(*, at: Optional[StrictInt] = None, enabled: Optional[StrictBool] = None, frequency: Optional[StrictInt] = None, blackout: Optional[TimeWindow] = None)
field at: Optional[StrictInt] = None

The time of day the snapshot is scheduled to be taken and retained on the local array or immediately replicated to the target(s). Measured in seconds since midnight. The at value is only used if the frequency parameter is in days (e.g., 259200000, which is equal to 3 days).

field blackout: Optional[TimeWindow] = None

The range of time when to suspend replication. To clear the blackout period, set to an empty string (“”).

field enabled: Optional[StrictBool] = None

If set to true, the policy is enabled.

Constraints

  • type = boolean

field frequency: Optional[StrictInt] = None

The frequency of the scheduled action. Measured in milliseconds.

Resource

pydantic model pypureclient.flasharray.Resource(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None)

An ordinary (as opposed to built-in) resource that can be created, named, renamed or deleted by the user. This might be a virtual resource (e.g., a volume), or correspond to something in the environment, like a host or a server.

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

ResourceAccess

pydantic model pypureclient.flasharray.ResourceAccess(*, id: Optional[StrictStr] = None, resource: Optional[ReferenceWithType] = None, scope: Optional[ReferenceWithType] = None)

A resource access captures configuration of sharing a resource to a scope. For example, resource access can specify that an array host is accessible from a realm.

field id: Optional[StrictStr] = None

ID of a resource access object.

field resource: Optional[ReferenceWithType] = None

Resource to which the scope has access.

field scope: Optional[ReferenceWithType] = None

Scope which has access to the resource.

ResourceAccessStatus

pydantic model pypureclient.flasharray.ResourceAccessStatus(*, created_by: Optional[ConstrainedListValue[ResourceAccessStatusCreatedBy]] = None, resource: Optional[ReferenceWithType] = None, scope: Optional[ReferenceWithType] = None)

A resource access status realizes the configuration of resource accesses. For instance, if there is a resource access for a host group to a realm, resource access status would include the explicit host group resource access as well as an implicit resource access for each host in that host group.

field created_by: Optional[ConstrainedListValue[ResourceAccessStatusCreatedBy]] = None

Reference the IDs of resource accesses that created this status.

field resource: Optional[ReferenceWithType] = None

Resource to which the scope has access.

field scope: Optional[ReferenceWithType] = None

Scope which has access to the resource.

ResourceAccessStatusCreatedBy

pydantic model pypureclient.flasharray.ResourceAccessStatusCreatedBy(*, id: Optional[StrictStr] = None, implicit: Optional[StrictBool] = None)

Each Resource Access Status has a reference to the resource accesses that explain its existence.

field id: Optional[StrictStr] = None

ID of a Resource Access.

field implicit: Optional[StrictBool] = None

Set to true when this resource access status was not explicitly created, but instead, its existence is implied by another resource access. Usually, this happens when a scope has access to a group of resources (e.g., a host group). Then this scope has access to each member of the group, individual hosts. Set to false when a resource access status reflects explicitly created resource access. Note that if there is both implicit and explicit access of an object to a scope, there will be only one entry in the response for that object and scope pair. The created_by field will contain both implicit and explicit resource access references.

Constraints

  • type = boolean

ResourceAccessesGetResponse

pydantic model pypureclient.flasharray.ResourceAccessesGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[ResourceAccess]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[ResourceAccess]] = None

A list of resource access objects.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

ResourceAccessesResponse

pydantic model pypureclient.flasharray.ResourceAccessesResponse(*, items: Optional[ConstrainedListValue[ResourceAccess]] = None)
field items: Optional[ConstrainedListValue[ResourceAccess]] = None

A list of resource access objects.

ResourceAccessesStatusGetResponse

pydantic model pypureclient.flasharray.ResourceAccessesStatusGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[ResourceAccessStatus]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[ResourceAccessStatus]] = None

A list of resource access status objects.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

ResourceAccessesStatusResponse

pydantic model pypureclient.flasharray.ResourceAccessesStatusResponse(*, items: Optional[ConstrainedListValue[ResourceAccessStatus]] = None)
field items: Optional[ConstrainedListValue[ResourceAccessStatus]] = None

A list of resource access status objects.

ResourceDirectorySpace

pydantic model pypureclient.flasharray.ResourceDirectorySpace(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, context: Optional[FixedReference] = None, space: Optional[Space] = None, time: Optional[StrictInt] = None)
field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field name: Optional[StrictStr] = None

A locally unique, system-generated name. The name cannot be modified.

field space: Optional[Space] = None

Displays size and space consumption information.

field time: Optional[StrictInt] = None

The timestamp of when the data was taken, measured in milliseconds since the UNIX epoch.

ResourceDirectorySpaceGetResponse

pydantic model pypureclient.flasharray.ResourceDirectorySpaceGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None, items: Optional[ConstrainedListValue[ResourceDirectorySpace]] = None, total: Optional[ConstrainedListValue[ResourceDirectorySpace]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[ResourceDirectorySpace]] = None

Displays a list of all items after filtering. If applicable, the values are displayed for each name. If total_only=true, the items list will be empty.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total: Optional[ConstrainedListValue[ResourceDirectorySpace]] = None

The aggregate value of all items after filtering. Where meaningful, the average value is displayed instead. If applicable, the values are displayed for each field.

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

ResourceFixedNonUniqueName

pydantic model pypureclient.flasharray.ResourceFixedNonUniqueName(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None)

A resource with a non-unique name.

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified.

field name: Optional[StrictStr] = None

Name of the resource. The name cannot be modified.

ResourceNoId

pydantic model pypureclient.flasharray.ResourceNoId(*, name: Optional[StrictStr] = None)

An ordinary (as opposed to built-in) resource that can be created, named, renamed or deleted by the user. This might be a virtual resource (e.g., a volume), or correspond to something in the environment, like a host or a server.

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

ResourcePerformance

pydantic model pypureclient.flasharray.ResourcePerformance(*, bytes_per_mirrored_write: Optional[ConstrainedIntValue] = None, bytes_per_op: Optional[ConstrainedIntValue] = None, bytes_per_read: Optional[ConstrainedIntValue] = None, bytes_per_write: Optional[ConstrainedIntValue] = None, mirrored_write_bytes_per_sec: Optional[ConstrainedIntValue] = None, mirrored_writes_per_sec: Optional[ConstrainedIntValue] = None, qos_rate_limit_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None, qos_rate_limit_usec_per_read_op: Optional[ConstrainedIntValue] = None, qos_rate_limit_usec_per_write_op: Optional[ConstrainedIntValue] = None, queue_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None, queue_usec_per_read_op: Optional[ConstrainedIntValue] = None, queue_usec_per_write_op: Optional[ConstrainedIntValue] = None, read_bytes_per_sec: Optional[ConstrainedIntValue] = None, reads_per_sec: Optional[ConstrainedIntValue] = None, san_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None, san_usec_per_read_op: Optional[ConstrainedIntValue] = None, san_usec_per_write_op: Optional[ConstrainedIntValue] = None, service_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None, service_usec_per_read_op: Optional[ConstrainedIntValue] = None, service_usec_per_read_op_cache_reduction: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, service_usec_per_write_op: Optional[ConstrainedIntValue] = None, time: Optional[StrictInt] = None, usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None, usec_per_read_op: Optional[ConstrainedIntValue] = None, usec_per_write_op: Optional[ConstrainedIntValue] = None, write_bytes_per_sec: Optional[ConstrainedIntValue] = None, writes_per_sec: Optional[ConstrainedIntValue] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, context: Optional[FixedReference] = None)
field bytes_per_mirrored_write: Optional[ConstrainedIntValue] = None

The average I/O size per mirrored write, measured in bytes.

Constraints

  • minimum = 0

field bytes_per_op: Optional[ConstrainedIntValue] = None

The average I/O size for both read and write (all) operations.

Constraints

  • minimum = 0

field bytes_per_read: Optional[ConstrainedIntValue] = None

The average I/O size per read, measured in bytes.

Constraints

  • minimum = 0

field bytes_per_write: Optional[ConstrainedIntValue] = None

The average I/O size per write, measured in bytes.

Constraints

  • minimum = 0

field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field mirrored_write_bytes_per_sec: Optional[ConstrainedIntValue] = None

The number of mirrored bytes written per second.

Constraints

  • minimum = 0

field mirrored_writes_per_sec: Optional[ConstrainedIntValue] = None

The number of mirrored writes per second.

Constraints

  • minimum = 0

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

field qos_rate_limit_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None

The average time it takes the array to process a mirrored I/O write request, measured in microseconds.

Constraints

  • minimum = 0

field qos_rate_limit_usec_per_read_op: Optional[ConstrainedIntValue] = None

The average time spent waiting due to QoS rate limiting for a read request, measured in microseconds.

Constraints

  • minimum = 0

field qos_rate_limit_usec_per_write_op: Optional[ConstrainedIntValue] = None

The average time that a write I/O request spends waiting as a result of the volume reaching its QoS bandwidth limit, measured in microseconds.

Constraints

  • minimum = 0

field queue_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None

The average time that a mirrored write I/O request spends in the array waiting to be served, measured in microseconds.

Constraints

  • minimum = 0

field queue_usec_per_read_op: Optional[ConstrainedIntValue] = None

The average time that a read I/O request spends in the array waiting to be served, measured in microseconds.

Constraints

  • minimum = 0

field queue_usec_per_write_op: Optional[ConstrainedIntValue] = None

The average time that a write I/O request spends in the array waiting to be served, measured in microseconds.

Constraints

  • minimum = 0

field read_bytes_per_sec: Optional[ConstrainedIntValue] = None

The number of bytes read per second.

Constraints

  • minimum = 0

field reads_per_sec: Optional[ConstrainedIntValue] = None

The number of read requests processed per second.

Constraints

  • minimum = 0

field san_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None

The average time required to transfer data from the initiator to the array for a mirrored write request, measured in microseconds.

Constraints

  • minimum = 0

field san_usec_per_read_op: Optional[ConstrainedIntValue] = None

The average time required to transfer data from the array to the initiator for a read request, measured in microseconds.

Constraints

  • minimum = 0

field san_usec_per_write_op: Optional[ConstrainedIntValue] = None

The average time required to transfer data from the initiator to the array for a write request, measured in microseconds.

Constraints

  • minimum = 0

field service_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None

The average time required for the array to service a mirrored write request, measured in microseconds.

Constraints

  • minimum = 0

field service_usec_per_read_op: Optional[ConstrainedIntValue] = None

The average time required for the array to service a read request, measured in microseconds.

Constraints

  • minimum = 0

field service_usec_per_read_op_cache_reduction: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

The percentage reduction in service_usec_per_read_op due to data cache hits. For example, a value of 0.25 indicates that the value of service_usec_per_read_op is 25&#37; lower than it would have been without any data cache hits.

field service_usec_per_write_op: Optional[ConstrainedIntValue] = None

The average time required for the array to service a write request, measured in microseconds.

Constraints

  • minimum = 0

field time: Optional[StrictInt] = None

The time when the sample performance data was taken, measured in milliseconds since the UNIX epoch.

field usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None

The average time it takes the array to process a mirrored I/O write request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.

Constraints

  • minimum = 0

field usec_per_read_op: Optional[ConstrainedIntValue] = None

The average time it takes the array to process an I/O read request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.

Constraints

  • minimum = 0

field usec_per_write_op: Optional[ConstrainedIntValue] = None

The average time it takes the array to process an I/O write request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.

Constraints

  • minimum = 0

field write_bytes_per_sec: Optional[ConstrainedIntValue] = None

The number of bytes written per second.

Constraints

  • minimum = 0

field writes_per_sec: Optional[ConstrainedIntValue] = None

The number of write requests processed per second.

Constraints

  • minimum = 0

ResourcePerformanceByArray

pydantic model pypureclient.flasharray.ResourcePerformanceByArray(*, bytes_per_mirrored_write: Optional[ConstrainedIntValue] = None, bytes_per_op: Optional[ConstrainedIntValue] = None, bytes_per_read: Optional[ConstrainedIntValue] = None, bytes_per_write: Optional[ConstrainedIntValue] = None, mirrored_write_bytes_per_sec: Optional[ConstrainedIntValue] = None, mirrored_writes_per_sec: Optional[ConstrainedIntValue] = None, qos_rate_limit_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None, qos_rate_limit_usec_per_read_op: Optional[ConstrainedIntValue] = None, qos_rate_limit_usec_per_write_op: Optional[ConstrainedIntValue] = None, queue_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None, queue_usec_per_read_op: Optional[ConstrainedIntValue] = None, queue_usec_per_write_op: Optional[ConstrainedIntValue] = None, read_bytes_per_sec: Optional[ConstrainedIntValue] = None, reads_per_sec: Optional[ConstrainedIntValue] = None, san_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None, san_usec_per_read_op: Optional[ConstrainedIntValue] = None, san_usec_per_write_op: Optional[ConstrainedIntValue] = None, service_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None, service_usec_per_read_op: Optional[ConstrainedIntValue] = None, service_usec_per_read_op_cache_reduction: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, service_usec_per_write_op: Optional[ConstrainedIntValue] = None, time: Optional[StrictInt] = None, usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None, usec_per_read_op: Optional[ConstrainedIntValue] = None, usec_per_write_op: Optional[ConstrainedIntValue] = None, write_bytes_per_sec: Optional[ConstrainedIntValue] = None, writes_per_sec: Optional[ConstrainedIntValue] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, context: Optional[FixedReference] = None, array: Optional[Resource] = None)
field array: Optional[Resource] = None

The array on which the performance metrics were recorded.

field bytes_per_mirrored_write: Optional[ConstrainedIntValue] = None

The average I/O size per mirrored write, measured in bytes.

Constraints

  • minimum = 0

field bytes_per_op: Optional[ConstrainedIntValue] = None

The average I/O size for both read and write (all) operations.

Constraints

  • minimum = 0

field bytes_per_read: Optional[ConstrainedIntValue] = None

The average I/O size per read, measured in bytes.

Constraints

  • minimum = 0

field bytes_per_write: Optional[ConstrainedIntValue] = None

The average I/O size per write, measured in bytes.

Constraints

  • minimum = 0

field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field mirrored_write_bytes_per_sec: Optional[ConstrainedIntValue] = None

The number of mirrored bytes written per second.

Constraints

  • minimum = 0

field mirrored_writes_per_sec: Optional[ConstrainedIntValue] = None

The number of mirrored writes per second.

Constraints

  • minimum = 0

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

field qos_rate_limit_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None

The average time it takes the array to process a mirrored I/O write request, measured in microseconds.

Constraints

  • minimum = 0

field qos_rate_limit_usec_per_read_op: Optional[ConstrainedIntValue] = None

The average time spent waiting due to QoS rate limiting for a read request, measured in microseconds.

Constraints

  • minimum = 0

field qos_rate_limit_usec_per_write_op: Optional[ConstrainedIntValue] = None

The average time that a write I/O request spends waiting as a result of the volume reaching its QoS bandwidth limit, measured in microseconds.

Constraints

  • minimum = 0

field queue_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None

The average time that a mirrored write I/O request spends in the array waiting to be served, measured in microseconds.

Constraints

  • minimum = 0

field queue_usec_per_read_op: Optional[ConstrainedIntValue] = None

The average time that a read I/O request spends in the array waiting to be served, measured in microseconds.

Constraints

  • minimum = 0

field queue_usec_per_write_op: Optional[ConstrainedIntValue] = None

The average time that a write I/O request spends in the array waiting to be served, measured in microseconds.

Constraints

  • minimum = 0

field read_bytes_per_sec: Optional[ConstrainedIntValue] = None

The number of bytes read per second.

Constraints

  • minimum = 0

field reads_per_sec: Optional[ConstrainedIntValue] = None

The number of read requests processed per second.

Constraints

  • minimum = 0

field san_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None

The average time required to transfer data from the initiator to the array for a mirrored write request, measured in microseconds.

Constraints

  • minimum = 0

field san_usec_per_read_op: Optional[ConstrainedIntValue] = None

The average time required to transfer data from the array to the initiator for a read request, measured in microseconds.

Constraints

  • minimum = 0

field san_usec_per_write_op: Optional[ConstrainedIntValue] = None

The average time required to transfer data from the initiator to the array for a write request, measured in microseconds.

Constraints

  • minimum = 0

field service_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None

The average time required for the array to service a mirrored write request, measured in microseconds.

Constraints

  • minimum = 0

field service_usec_per_read_op: Optional[ConstrainedIntValue] = None

The average time required for the array to service a read request, measured in microseconds.

Constraints

  • minimum = 0

field service_usec_per_read_op_cache_reduction: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

The percentage reduction in service_usec_per_read_op due to data cache hits. For example, a value of 0.25 indicates that the value of service_usec_per_read_op is 25&#37; lower than it would have been without any data cache hits.

field service_usec_per_write_op: Optional[ConstrainedIntValue] = None

The average time required for the array to service a write request, measured in microseconds.

Constraints

  • minimum = 0

field time: Optional[StrictInt] = None

The time when the sample performance data was taken, measured in milliseconds since the UNIX epoch.

field usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None

The average time it takes the array to process a mirrored I/O write request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.

Constraints

  • minimum = 0

field usec_per_read_op: Optional[ConstrainedIntValue] = None

The average time it takes the array to process an I/O read request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.

Constraints

  • minimum = 0

field usec_per_write_op: Optional[ConstrainedIntValue] = None

The average time it takes the array to process an I/O write request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.

Constraints

  • minimum = 0

field write_bytes_per_sec: Optional[ConstrainedIntValue] = None

The number of bytes written per second.

Constraints

  • minimum = 0

field writes_per_sec: Optional[ConstrainedIntValue] = None

The number of write requests processed per second.

Constraints

  • minimum = 0

ResourcePerformanceByArrayGetResponse

pydantic model pypureclient.flasharray.ResourcePerformanceByArrayGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None, items: Optional[ConstrainedListValue[ResourcePerformanceByArray]] = None, total: Optional[ConstrainedListValue[ResourcePerformanceByArray]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[ResourcePerformanceByArray]] = None

Performance data, broken down by array. If total_only=true, the items list will be empty.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total: Optional[ConstrainedListValue[ResourcePerformanceByArray]] = None

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 field where meaningful.

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

ResourcePerformanceGetResponse

pydantic model pypureclient.flasharray.ResourcePerformanceGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None, items: Optional[ConstrainedListValue[ResourcePerformance]] = None, total: Optional[ConstrainedListValue[ResourcePerformance]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[ResourcePerformance]] = None

Performance data. If total_only=true, the items list will be empty.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total: Optional[ConstrainedListValue[ResourcePerformance]] = None

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 field where meaningful.

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

ResourcePerformanceNoId

pydantic model pypureclient.flasharray.ResourcePerformanceNoId(*, bytes_per_mirrored_write: Optional[ConstrainedIntValue] = None, bytes_per_op: Optional[ConstrainedIntValue] = None, bytes_per_read: Optional[ConstrainedIntValue] = None, bytes_per_write: Optional[ConstrainedIntValue] = None, mirrored_write_bytes_per_sec: Optional[ConstrainedIntValue] = None, mirrored_writes_per_sec: Optional[ConstrainedIntValue] = None, qos_rate_limit_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None, qos_rate_limit_usec_per_read_op: Optional[ConstrainedIntValue] = None, qos_rate_limit_usec_per_write_op: Optional[ConstrainedIntValue] = None, queue_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None, queue_usec_per_read_op: Optional[ConstrainedIntValue] = None, queue_usec_per_write_op: Optional[ConstrainedIntValue] = None, read_bytes_per_sec: Optional[ConstrainedIntValue] = None, reads_per_sec: Optional[ConstrainedIntValue] = None, san_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None, san_usec_per_read_op: Optional[ConstrainedIntValue] = None, san_usec_per_write_op: Optional[ConstrainedIntValue] = None, service_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None, service_usec_per_read_op: Optional[ConstrainedIntValue] = None, service_usec_per_read_op_cache_reduction: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, service_usec_per_write_op: Optional[ConstrainedIntValue] = None, time: Optional[StrictInt] = None, usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None, usec_per_read_op: Optional[ConstrainedIntValue] = None, usec_per_write_op: Optional[ConstrainedIntValue] = None, write_bytes_per_sec: Optional[ConstrainedIntValue] = None, writes_per_sec: Optional[ConstrainedIntValue] = None, name: Optional[StrictStr] = None, context: Optional[FixedReference] = None)
field bytes_per_mirrored_write: Optional[ConstrainedIntValue] = None

The average I/O size per mirrored write, measured in bytes.

Constraints

  • minimum = 0

field bytes_per_op: Optional[ConstrainedIntValue] = None

The average I/O size for both read and write (all) operations.

Constraints

  • minimum = 0

field bytes_per_read: Optional[ConstrainedIntValue] = None

The average I/O size per read, measured in bytes.

Constraints

  • minimum = 0

field bytes_per_write: Optional[ConstrainedIntValue] = None

The average I/O size per write, measured in bytes.

Constraints

  • minimum = 0

field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field mirrored_write_bytes_per_sec: Optional[ConstrainedIntValue] = None

The number of mirrored bytes written per second.

Constraints

  • minimum = 0

field mirrored_writes_per_sec: Optional[ConstrainedIntValue] = None

The number of mirrored writes per second.

Constraints

  • minimum = 0

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

field qos_rate_limit_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None

The average time it takes the array to process a mirrored I/O write request, measured in microseconds.

Constraints

  • minimum = 0

field qos_rate_limit_usec_per_read_op: Optional[ConstrainedIntValue] = None

The average time spent waiting due to QoS rate limiting for a read request, measured in microseconds.

Constraints

  • minimum = 0

field qos_rate_limit_usec_per_write_op: Optional[ConstrainedIntValue] = None

The average time that a write I/O request spends waiting as a result of the volume reaching its QoS bandwidth limit, measured in microseconds.

Constraints

  • minimum = 0

field queue_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None

The average time that a mirrored write I/O request spends in the array waiting to be served, measured in microseconds.

Constraints

  • minimum = 0

field queue_usec_per_read_op: Optional[ConstrainedIntValue] = None

The average time that a read I/O request spends in the array waiting to be served, measured in microseconds.

Constraints

  • minimum = 0

field queue_usec_per_write_op: Optional[ConstrainedIntValue] = None

The average time that a write I/O request spends in the array waiting to be served, measured in microseconds.

Constraints

  • minimum = 0

field read_bytes_per_sec: Optional[ConstrainedIntValue] = None

The number of bytes read per second.

Constraints

  • minimum = 0

field reads_per_sec: Optional[ConstrainedIntValue] = None

The number of read requests processed per second.

Constraints

  • minimum = 0

field san_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None

The average time required to transfer data from the initiator to the array for a mirrored write request, measured in microseconds.

Constraints

  • minimum = 0

field san_usec_per_read_op: Optional[ConstrainedIntValue] = None

The average time required to transfer data from the array to the initiator for a read request, measured in microseconds.

Constraints

  • minimum = 0

field san_usec_per_write_op: Optional[ConstrainedIntValue] = None

The average time required to transfer data from the initiator to the array for a write request, measured in microseconds.

Constraints

  • minimum = 0

field service_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None

The average time required for the array to service a mirrored write request, measured in microseconds.

Constraints

  • minimum = 0

field service_usec_per_read_op: Optional[ConstrainedIntValue] = None

The average time required for the array to service a read request, measured in microseconds.

Constraints

  • minimum = 0

field service_usec_per_read_op_cache_reduction: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

The percentage reduction in service_usec_per_read_op due to data cache hits. For example, a value of 0.25 indicates that the value of service_usec_per_read_op is 25&#37; lower than it would have been without any data cache hits.

field service_usec_per_write_op: Optional[ConstrainedIntValue] = None

The average time required for the array to service a write request, measured in microseconds.

Constraints

  • minimum = 0

field time: Optional[StrictInt] = None

The time when the sample performance data was taken, measured in milliseconds since the UNIX epoch.

field usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None

The average time it takes the array to process a mirrored I/O write request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.

Constraints

  • minimum = 0

field usec_per_read_op: Optional[ConstrainedIntValue] = None

The average time it takes the array to process an I/O read request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.

Constraints

  • minimum = 0

field usec_per_write_op: Optional[ConstrainedIntValue] = None

The average time it takes the array to process an I/O write request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.

Constraints

  • minimum = 0

field write_bytes_per_sec: Optional[ConstrainedIntValue] = None

The number of bytes written per second.

Constraints

  • minimum = 0

field writes_per_sec: Optional[ConstrainedIntValue] = None

The number of write requests processed per second.

Constraints

  • minimum = 0

ResourcePerformanceNoIdByArray

pydantic model pypureclient.flasharray.ResourcePerformanceNoIdByArray(*, bytes_per_mirrored_write: Optional[ConstrainedIntValue] = None, bytes_per_op: Optional[ConstrainedIntValue] = None, bytes_per_read: Optional[ConstrainedIntValue] = None, bytes_per_write: Optional[ConstrainedIntValue] = None, mirrored_write_bytes_per_sec: Optional[ConstrainedIntValue] = None, mirrored_writes_per_sec: Optional[ConstrainedIntValue] = None, qos_rate_limit_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None, qos_rate_limit_usec_per_read_op: Optional[ConstrainedIntValue] = None, qos_rate_limit_usec_per_write_op: Optional[ConstrainedIntValue] = None, queue_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None, queue_usec_per_read_op: Optional[ConstrainedIntValue] = None, queue_usec_per_write_op: Optional[ConstrainedIntValue] = None, read_bytes_per_sec: Optional[ConstrainedIntValue] = None, reads_per_sec: Optional[ConstrainedIntValue] = None, san_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None, san_usec_per_read_op: Optional[ConstrainedIntValue] = None, san_usec_per_write_op: Optional[ConstrainedIntValue] = None, service_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None, service_usec_per_read_op: Optional[ConstrainedIntValue] = None, service_usec_per_read_op_cache_reduction: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, service_usec_per_write_op: Optional[ConstrainedIntValue] = None, time: Optional[StrictInt] = None, usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None, usec_per_read_op: Optional[ConstrainedIntValue] = None, usec_per_write_op: Optional[ConstrainedIntValue] = None, write_bytes_per_sec: Optional[ConstrainedIntValue] = None, writes_per_sec: Optional[ConstrainedIntValue] = None, name: Optional[StrictStr] = None, context: Optional[FixedReference] = None, array: Optional[Resource] = None)
field array: Optional[Resource] = None

The array on which the performance metrics were recorded.

field bytes_per_mirrored_write: Optional[ConstrainedIntValue] = None

The average I/O size per mirrored write, measured in bytes.

Constraints

  • minimum = 0

field bytes_per_op: Optional[ConstrainedIntValue] = None

The average I/O size for both read and write (all) operations.

Constraints

  • minimum = 0

field bytes_per_read: Optional[ConstrainedIntValue] = None

The average I/O size per read, measured in bytes.

Constraints

  • minimum = 0

field bytes_per_write: Optional[ConstrainedIntValue] = None

The average I/O size per write, measured in bytes.

Constraints

  • minimum = 0

field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field mirrored_write_bytes_per_sec: Optional[ConstrainedIntValue] = None

The number of mirrored bytes written per second.

Constraints

  • minimum = 0

field mirrored_writes_per_sec: Optional[ConstrainedIntValue] = None

The number of mirrored writes per second.

Constraints

  • minimum = 0

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

field qos_rate_limit_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None

The average time it takes the array to process a mirrored I/O write request, measured in microseconds.

Constraints

  • minimum = 0

field qos_rate_limit_usec_per_read_op: Optional[ConstrainedIntValue] = None

The average time spent waiting due to QoS rate limiting for a read request, measured in microseconds.

Constraints

  • minimum = 0

field qos_rate_limit_usec_per_write_op: Optional[ConstrainedIntValue] = None

The average time that a write I/O request spends waiting as a result of the volume reaching its QoS bandwidth limit, measured in microseconds.

Constraints

  • minimum = 0

field queue_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None

The average time that a mirrored write I/O request spends in the array waiting to be served, measured in microseconds.

Constraints

  • minimum = 0

field queue_usec_per_read_op: Optional[ConstrainedIntValue] = None

The average time that a read I/O request spends in the array waiting to be served, measured in microseconds.

Constraints

  • minimum = 0

field queue_usec_per_write_op: Optional[ConstrainedIntValue] = None

The average time that a write I/O request spends in the array waiting to be served, measured in microseconds.

Constraints

  • minimum = 0

field read_bytes_per_sec: Optional[ConstrainedIntValue] = None

The number of bytes read per second.

Constraints

  • minimum = 0

field reads_per_sec: Optional[ConstrainedIntValue] = None

The number of read requests processed per second.

Constraints

  • minimum = 0

field san_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None

The average time required to transfer data from the initiator to the array for a mirrored write request, measured in microseconds.

Constraints

  • minimum = 0

field san_usec_per_read_op: Optional[ConstrainedIntValue] = None

The average time required to transfer data from the array to the initiator for a read request, measured in microseconds.

Constraints

  • minimum = 0

field san_usec_per_write_op: Optional[ConstrainedIntValue] = None

The average time required to transfer data from the initiator to the array for a write request, measured in microseconds.

Constraints

  • minimum = 0

field service_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None

The average time required for the array to service a mirrored write request, measured in microseconds.

Constraints

  • minimum = 0

field service_usec_per_read_op: Optional[ConstrainedIntValue] = None

The average time required for the array to service a read request, measured in microseconds.

Constraints

  • minimum = 0

field service_usec_per_read_op_cache_reduction: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

The percentage reduction in service_usec_per_read_op due to data cache hits. For example, a value of 0.25 indicates that the value of service_usec_per_read_op is 25&#37; lower than it would have been without any data cache hits.

field service_usec_per_write_op: Optional[ConstrainedIntValue] = None

The average time required for the array to service a write request, measured in microseconds.

Constraints

  • minimum = 0

field time: Optional[StrictInt] = None

The time when the sample performance data was taken, measured in milliseconds since the UNIX epoch.

field usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None

The average time it takes the array to process a mirrored I/O write request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.

Constraints

  • minimum = 0

field usec_per_read_op: Optional[ConstrainedIntValue] = None

The average time it takes the array to process an I/O read request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.

Constraints

  • minimum = 0

field usec_per_write_op: Optional[ConstrainedIntValue] = None

The average time it takes the array to process an I/O write request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.

Constraints

  • minimum = 0

field write_bytes_per_sec: Optional[ConstrainedIntValue] = None

The number of bytes written per second.

Constraints

  • minimum = 0

field writes_per_sec: Optional[ConstrainedIntValue] = None

The number of write requests processed per second.

Constraints

  • minimum = 0

ResourcePerformanceNoIdByArrayGetResponse

pydantic model pypureclient.flasharray.ResourcePerformanceNoIdByArrayGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None, items: Optional[ConstrainedListValue[ResourcePerformanceNoIdByArray]] = None, total: Optional[ConstrainedListValue[ResourcePerformanceNoIdByArray]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[ResourcePerformanceNoIdByArray]] = None

Performance data, broken down by array. If total_only=true, the items list will be empty.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total: Optional[ConstrainedListValue[ResourcePerformanceNoIdByArray]] = None

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 field where meaningful.

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

ResourcePerformanceNoIdGetResponse

pydantic model pypureclient.flasharray.ResourcePerformanceNoIdGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None, items: Optional[ConstrainedListValue[ResourcePerformanceNoId]] = None, total: Optional[ConstrainedListValue[ResourcePerformanceNoId]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[ResourcePerformanceNoId]] = None

Performance data. If total_only=true, the items list will be empty.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total: Optional[ConstrainedListValue[ResourcePerformanceNoId]] = None

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 field where meaningful.

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

ResourcePodSpace

pydantic model pypureclient.flasharray.ResourcePodSpace(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, context: Optional[FixedReference] = None, space: Optional[PodSpace] = None, time: Optional[StrictInt] = None)
field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field name: Optional[StrictStr] = None

A locally unique, system-generated name. The name cannot be modified.

field space: Optional[PodSpace] = None

Displays size and space consumption information.

field time: Optional[StrictInt] = None

The timestamp of when the data was taken, measured in milliseconds since the UNIX epoch.

ResourcePodSpaceGetResponse

pydantic model pypureclient.flasharray.ResourcePodSpaceGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None, items: Optional[ConstrainedListValue[ResourcePodSpace]] = None, total: Optional[ConstrainedListValue[ResourcePodSpace]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[ResourcePodSpace]] = None

Displays a list of all items after filtering. If applicable, the values are displayed for each name. If total_only=true, the items list will be empty.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total: Optional[ConstrainedListValue[ResourcePodSpace]] = None

The aggregate value of all items after filtering. When applicable, the average value is displayed instead. If applicable, the values are displayed for each field.

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

ResourceRealmSpace

pydantic model pypureclient.flasharray.ResourceRealmSpace(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, space: Optional[SpaceNoDeprecatedPhysicalOrEffective] = None, time: Optional[StrictInt] = None)
field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field name: Optional[StrictStr] = None

A locally unique, system-generated name. The name cannot be modified.

field space: Optional[SpaceNoDeprecatedPhysicalOrEffective] = None

Displays size and space consumption information.

field time: Optional[StrictInt] = None

The timestamp of when the data was taken, measured in milliseconds since the UNIX epoch.

ResourceSpace

pydantic model pypureclient.flasharray.ResourceSpace(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, context: Optional[FixedReference] = None, space: Optional[Space] = None, time: Optional[StrictInt] = None)
field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field name: Optional[StrictStr] = None

A locally unique, system-generated name. The name cannot be modified.

field space: Optional[Space] = None

Displays size and space consumption information.

field time: Optional[StrictInt] = None

The timestamp of when the data was taken, measured in milliseconds since the UNIX epoch.

ResourceSpaceGetResponse

pydantic model pypureclient.flasharray.ResourceSpaceGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None, items: Optional[ConstrainedListValue[ResourceSpace]] = None, total: Optional[ConstrainedListValue[ResourceSpace]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[ResourceSpace]] = None

Displays a list of all items after filtering. If applicable, the values are displayed for each name. If total_only=true, the items list will be empty.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total: Optional[ConstrainedListValue[ResourceSpace]] = None

The aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. If applicable, the values are displayed for each field.

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

ResourceSpaceNoId

pydantic model pypureclient.flasharray.ResourceSpaceNoId(*, name: Optional[StrictStr] = None, context: Optional[FixedReference] = None, space: Optional[Space] = None, time: Optional[StrictInt] = None)
field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field name: Optional[StrictStr] = None

A locally unique, system-generated name. The name cannot be modified.

field space: Optional[Space] = None

Displays size and space consumption information.

field time: Optional[StrictInt] = None

ResourceSpaceNoIdGetResponse

pydantic model pypureclient.flasharray.ResourceSpaceNoIdGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None, items: Optional[ConstrainedListValue[ResourceSpaceNoId]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[ResourceSpaceNoId]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

RetentionPolicy

pydantic model pypureclient.flasharray.RetentionPolicy(*, all_for_sec: Optional[StrictInt] = None, days: Optional[StrictInt] = None, per_day: Optional[StrictInt] = None)

The snapshot retention policy.

field all_for_sec: Optional[StrictInt] = None

The length of time to keep the specified snapshots. Measured in seconds. Prior to 6.8.2 the range of 60 to 34560000 is accepted. In 6.8.2 and onwards the range of 60 to 2147483647 is accepted.

field days: Optional[StrictInt] = None

The number of days to keep the snapshots after the all_for_sec period has passed. Prior to 6.6.4 the range of 0 to 4000 is accepted. In 6.6.4 and onwards the range of 0 to 2147483647 is accepted.

field per_day: Optional[StrictInt] = None

The number of snapshots to keep per day after the all_for_sec period has passed. Prior to 6.8.2 the range of 0 to 1440 is accepted. In 6.8.2 and onwards the range of 0 to 2147483647 is accepted.

Saml2Sso

pydantic model pypureclient.flasharray.Saml2Sso(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, array_url: Optional[StrictStr] = None, enabled: Optional[StrictBool] = None, idp: Optional[Saml2SsoIdp] = None, sp: Optional[Saml2SsoSp] = None)
field array_url: Optional[StrictStr] = None

The URL of the array.

field enabled: Optional[StrictBool] = None

If set to true, the SAML2 SSO configuration is enabled.

Constraints

  • type = boolean

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified.

field idp: Optional[Saml2SsoIdp] = None
field name: Optional[StrictStr] = None

Name of the resource. The name cannot be modified.

field sp: Optional[Saml2SsoSp] = None

Saml2SsoGetResponse

pydantic model pypureclient.flasharray.Saml2SsoGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Saml2Sso]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[Saml2Sso]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

Saml2SsoIdp

pydantic model pypureclient.flasharray.Saml2SsoIdp(*, encrypt_assertion_enabled: Optional[StrictBool] = None, entity_id: Optional[StrictStr] = None, metadata_url: Optional[StrictStr] = None, sign_request_enabled: Optional[StrictBool] = None, url: Optional[StrictStr] = None, verification_certificate: Optional[StrictStr] = None)

Properties specific to the identity provider.

field encrypt_assertion_enabled: Optional[StrictBool] = None

If set to true, SAML assertions will be encrypted by the identity provider.

Constraints

  • type = boolean

field entity_id: Optional[StrictStr] = None

A globally unique name for the identity provider.

field metadata_url: Optional[StrictStr] = None

The URL of the identity provider metadata.

field sign_request_enabled: Optional[StrictBool] = None

If set to true, SAML requests will be signed by the service provider.

Constraints

  • type = boolean

field url: Optional[StrictStr] = None

The URL of the identity provider.

field verification_certificate: Optional[StrictStr] = None

The X509 certificate that the service provider uses to verify the SAML response signature from the identity provider.

Saml2SsoPatch

pydantic model pypureclient.flasharray.Saml2SsoPatch(*, array_url: Optional[StrictStr] = None, idp: Optional[Saml2SsoIdp] = None, sp: Optional[Saml2SsoSpCredential] = None, enabled: Optional[StrictBool] = None)
field array_url: Optional[StrictStr] = None

The URL of the array.

field enabled: Optional[StrictBool] = None

If set to true, the SAML2 SSO configuration is enabled.

Constraints

  • type = boolean

field idp: Optional[Saml2SsoIdp] = None
field sp: Optional[Saml2SsoSpCredential] = None

Properties specific to the service provider.

Saml2SsoPost

pydantic model pypureclient.flasharray.Saml2SsoPost(*, array_url: Optional[StrictStr] = None, idp: Optional[Saml2SsoIdp] = None, sp: Optional[Saml2SsoSpCredential] = None)
field array_url: Optional[StrictStr] = None

The URL of the array.

field idp: Optional[Saml2SsoIdp] = None
field sp: Optional[Saml2SsoSpCredential] = None

Properties specific to the service provider.

Saml2SsoResponse

pydantic model pypureclient.flasharray.Saml2SsoResponse(*, items: Optional[ConstrainedListValue[Saml2Sso]] = None)
field items: Optional[ConstrainedListValue[Saml2Sso]] = None

Saml2SsoSp

pydantic model pypureclient.flasharray.Saml2SsoSp(*, decryption_credential: Optional[ReferenceNoId] = None, signing_credential: Optional[ReferenceNoId] = None, assertion_consumer_url: Optional[StrictStr] = None, entity_id: Optional[StrictStr] = None, metadata_url: Optional[StrictStr] = None)
field assertion_consumer_url: Optional[StrictStr] = None

The URL where the identity provider will send its SAML response after authenticating a user.

field decryption_credential: Optional[ReferenceNoId] = None

The credential used by the service provider to decrypt encrypted SAML assertions from the identity provider. The credential is managed by the certificates endpoint and purecert CLI commands.

field entity_id: Optional[StrictStr] = None

A globally unique name for the service provider.

field metadata_url: Optional[StrictStr] = None

The URL of the service provider metadata.

field signing_credential: Optional[ReferenceNoId] = None

The credential used by the service provider to sign SAML requests. The credential is managed by the certificates endpoint and purecert CLI commands.

Saml2SsoSpCredential

pydantic model pypureclient.flasharray.Saml2SsoSpCredential(*, decryption_credential: Optional[ReferenceNoId] = None, signing_credential: Optional[ReferenceNoId] = None)
field decryption_credential: Optional[ReferenceNoId] = None

The credential used by the service provider to decrypt encrypted SAML assertions from the identity provider. The credential is managed by the certificates endpoint and purecert CLI commands.

field signing_credential: Optional[ReferenceNoId] = None

The credential used by the service provider to sign SAML requests. The credential is managed by the certificates endpoint and purecert CLI commands.

Session

pydantic model pypureclient.flasharray.Session(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, end_time: Optional[StrictInt] = None, event: Optional[StrictStr] = None, event_count: Optional[StrictInt] = None, location: Optional[StrictStr] = None, method: Optional[StrictStr] = None, start_time: Optional[StrictInt] = None, user: Optional[StrictStr] = None, user_interface: Optional[StrictStr] = None)
field end_time: Optional[StrictInt] = None

Date and time the user logged out of the Purity//FA interface. Not set if the session is still active.

field event: Optional[StrictStr] = None

Description of session events such as login and user session. Valid values include failed authentication, user session, login, logout, API token obtained, and request without session.

field event_count: Optional[StrictInt] = None

Number of session events.

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field location: Optional[StrictStr] = None

IP address of the user client connecting to the array or console if connected through local console.

field method: Optional[StrictStr] = None

Method by which the user attempted to log in. Valid values include API token, JWT, password, and public key.

field name: Optional[StrictStr] = None

A locally unique, system-generated name. The name cannot be modified.

field start_time: Optional[StrictInt] = None

Date and time the user logged in to the Purity//FA interface.

field user: Optional[StrictStr] = None

Username of the Purity//FA user who triggered the user session event.

field user_interface: Optional[StrictStr] = None

The user interface through which the user session event was performed. Valid values include CLI, GUI, and REST.

SessionGetResponse

pydantic model pypureclient.flasharray.SessionGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Session]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[Session]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

Smis

pydantic model pypureclient.flasharray.Smis(*, slp_enabled: Optional[StrictBool] = None, wbem_https_enabled: Optional[StrictBool] = None)
field slp_enabled: Optional[StrictBool] = None

If set to true, the Service Location Protocol (SLP) and its ports, TCP 427 and UDP 427, are enabled.

Constraints

  • type = boolean

field wbem_https_enabled: Optional[StrictBool] = None

If set to true, the SMI-S provider and its port, TCP 5989 is enabled.

Constraints

  • type = boolean

SmisGetResponse

pydantic model pypureclient.flasharray.SmisGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Smis]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[Smis]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

SmisResponse

pydantic model pypureclient.flasharray.SmisResponse(*, items: Optional[ConstrainedListValue[Smis]] = None)
field items: Optional[ConstrainedListValue[Smis]] = None

SmtpServer

pydantic model pypureclient.flasharray.SmtpServer(*, name: Optional[StrictStr] = None, body_prefix: Optional[ConstrainedStrValue] = None, encryption_mode: Optional[StrictStr] = None, password: Optional[StrictStr] = None, relay_host: Optional[StrictStr] = None, sender_domain: Optional[StrictStr] = None, sender_username: Optional[StrictStr] = None, subject_prefix: Optional[ConstrainedStrValue] = None, user_name: Optional[StrictStr] = None)
field body_prefix: Optional[ConstrainedStrValue] = None

Optional string added to the beginning of the email body when sending alert email messages. HTML tags are not allowed.

Constraints

  • maxLength = 256

field encryption_mode: Optional[StrictStr] = None

Enforces an encryption mode when sending alert email messages. Valid values are starttls. Use “” to clear.

field name: Optional[StrictStr] = None

A locally unique, system-generated name. The name cannot be modified.

field password: Optional[StrictStr] = None

Password for the relay host, if needed.

field relay_host: Optional[StrictStr] = None

Relay server used as a forwarding point for email sent from the array. Can be set as a hostname, IPv4 address, or IPv6 address, with optional port numbers. The expected format for IPv4 is ddd.ddd.ddd.ddd:PORT. The expected format for IPv6 is xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx or, if a port number is specified, [xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx]:PORT.

field sender_domain: Optional[StrictStr] = None

Domain name appended to alert email messages.

field sender_username: Optional[StrictStr] = None

The local-part of the email address used when sending alert email messages.

field subject_prefix: Optional[ConstrainedStrValue] = None

Optional string added to the beginning of the subject when sending alert email messages. HTML tags are not allowed.

Constraints

  • maxLength = 64

field user_name: Optional[StrictStr] = None

User name for the relay host, if needed.

SmtpServerGetResponse

pydantic model pypureclient.flasharray.SmtpServerGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[SmtpServer]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[SmtpServer]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

SmtpServerResponse

pydantic model pypureclient.flasharray.SmtpServerResponse(*, items: Optional[ConstrainedListValue[SmtpServer]] = None)
field items: Optional[ConstrainedListValue[SmtpServer]] = None

Snapshot

pydantic model pypureclient.flasharray.Snapshot(*, created: Optional[StrictInt] = None, destroyed: Optional[StrictBool] = None, pod: Optional[FixedReference] = None, provisioned: Optional[StrictInt] = None, source: Optional[FixedReference] = None, suffix: Optional[StrictStr] = None, time_remaining: Optional[StrictInt] = None)
field created: Optional[StrictInt] = None

The snapshot creation time. Measured in milliseconds since the UNIX epoch.

field destroyed: Optional[StrictBool] = None

Returns a value of true if the snapshot has been destroyed and is pending eradication. The time_remaining value displays the amount of time left until the destroyed volume snapshot is permanently eradicated. Before the time_remaining period has elapsed, the destroyed volume snapshot can be recovered by setting destroyed=false. Once the time_remaining period has elapsed, the volume snapshot is permanently eradicated and can no longer be recovered.

Constraints

  • type = boolean

field pod: Optional[FixedReference] = None

A reference to the pod.

field provisioned: Optional[StrictInt] = None

The provisioned space of the snapshot. Measured in bytes. The minimum size is 1048576 (1MB), the maximum size is 4503599627370496 (4PB)

field source: Optional[FixedReference] = None

The volume from which this snapshot was taken. For a replicated snapshot being viewed on the target side, the source is the replica volume.

field suffix: Optional[StrictStr] = None

The suffix that is appended to the source_name value to generate the full volume snapshot name in the form VOL.SUFFIX. If the suffix is not specified, the system constructs the snapshot name in the form VOL.NNN, where VOL is the volume name, and NNN is a monotonically increasing number.

field time_remaining: Optional[StrictInt] = None

The amount of time left until the destroyed snapshot is permanently eradicated. Measured in milliseconds. Before the time_remaining period has elapsed, the destroyed snapshot can be recovered by setting destroyed=false.

SnapshotSchedule

pydantic model pypureclient.flasharray.SnapshotSchedule(*, at: Optional[StrictInt] = None, enabled: Optional[StrictBool] = None, frequency: Optional[StrictInt] = None)

The replication or snapshot schedule.

field at: Optional[StrictInt] = None

The time of day the snapshot is scheduled to be taken and retained on the local array or immediately replicated to the target(s). Measured in seconds since midnight. The at value is only used if the frequency parameter is in days (e.g., 259200000, which is equal to 3 days).

field enabled: Optional[StrictBool] = None

If set to true, the policy is enabled.

Constraints

  • type = boolean

field frequency: Optional[StrictInt] = None

The frequency of the scheduled action. Measured in milliseconds.

SnapshotSpace

pydantic model pypureclient.flasharray.SnapshotSpace(*, data_reduction: Optional[Union[StrictFloat, StrictInt]] = None, footprint: Optional[ConstrainedIntValue] = None, shared: Optional[ConstrainedIntValue] = None, snapshots: Optional[ConstrainedIntValue] = None, system: Optional[ConstrainedIntValue] = None, thin_provisioning: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, total_physical: Optional[ConstrainedIntValue] = None, total_provisioned: Optional[ConstrainedIntValue] = None, total_reduction: Optional[Union[StrictFloat, StrictInt]] = None, total_used: Optional[ConstrainedIntValue] = None, unique: Optional[ConstrainedIntValue] = None, used_provisioned: Optional[ConstrainedIntValue] = None, virtual: Optional[ConstrainedIntValue] = None, snapshots_effective: Optional[ConstrainedIntValue] = None)
field data_reduction: Optional[Union[StrictFloat, StrictInt]] = None

The ratio of mapped sectors within a volume versus the amount of physical space the data occupies after data compression and deduplication. The data reduction ratio does not include thin provisioning savings. For example, a data reduction ratio of 5&#58;1 means that for every 5 MB the host writes to the array, 1 MB is stored on the array’s flash modules.

field footprint: Optional[ConstrainedIntValue] = None

The maximum amount of physical space the container consumes on an array, ignoring any data shared outside the container, measured in bytes. On Evergreen//One arrays, this is the maximum amount of effective used space. The footprint metric is mostly used for capacity planning. This field will be null in non-container contexts.

Constraints

  • minimum = 0

field shared: Optional[ConstrainedIntValue] = None

The physical space occupied by deduplicated data, meaning that the space is shared with other volumes and snapshots as a result of data deduplication. Measured in bytes. On Evergreen//One arrays, this is the effective space contributed by data that is not unique to a specific volume, managed directory, or snapshot, measured in bytes.

Constraints

  • minimum = 0

field snapshots: Optional[ConstrainedIntValue] = None

The physical space occupied by data unique to one or more snapshots. Measured in bytes. On Evergreen//One arrays, this is the effective space contributed by data unique to one or more snapshots, measured in bytes.

Constraints

  • minimum = 0

field snapshots_effective: Optional[ConstrainedIntValue] = None

This field has been deprecated. The effective space contributed by data unique to one or more snapshots, measured in bytes. Use the snapshots field in the future, as it contains the same information for Evergreen//One arrays.

Constraints

  • minimum = 0

field system: Optional[ConstrainedIntValue] = None

The physical space occupied by internal array metadata. Measured in bytes.

Constraints

  • minimum = 0

field thin_provisioning: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

The percentage of volume sectors that do not contain host-written data because the hosts have not written data to them or the sectors have been explicitly trimmed.

field total_physical: Optional[ConstrainedIntValue] = None

This field has been deprecated. Use the total_used field, as it contains the same information.

Constraints

  • minimum = 0

field total_provisioned: Optional[ConstrainedIntValue] = None

The provisioned size of a volume for a single volume, host or host group, protocol endpoint, managed directory, and containers can be infinite or measured in bytes. Infinite is represented by null. The provisioned size for a host or host group, includes all volumes that are connected to the resource. The provisioned size for a protocol endpoint is null’. The provisioned size for a managed directory is the quota limit if it or its parent has a managed directory configured, otherwise it defaults to `null. The provisioned size for a container is the sum of the total_provisioned of the object it contains, capped by the container’s quota limit (or the container’s used_provisioned if current usage is above the quota limit), if any. Provisioned size represents the storage capacity reported to hosts.

Constraints

  • minimum = 0

field total_reduction: Optional[Union[StrictFloat, StrictInt]] = None

The ratio of provisioned sectors within a volume versus the amount of physical space the data occupies after reduction via data compression and deduplication and with thin provisioning savings. Total reduction is data reduction with thin provisioning savings. For example, a total reduction ratio of 10&#58;1 means that for every 10 MB of provisioned space, 1 MB is stored on the array’s flash modules.

field total_used: Optional[ConstrainedIntValue] = None

The total space contributed by customer data, measured in bytes.

Constraints

  • minimum = 0

field unique: Optional[ConstrainedIntValue] = None

The unique physical space occupied by customer data. Unique physical space does not include shared space, snapshots, and internal array metadata. Measured in bytes. On Evergreen//One arrays, this is the effective space contributed by unique customer data, measured in bytes. Unique data does not include shared space, snapshots, and internal array metadata.

Constraints

  • minimum = 0

field used_provisioned: Optional[ConstrainedIntValue] = None

The amount of logical space a container has consumed, compared against the quota limit if the container has one configured. Used provisioned does not include destroyed objects inside the container. Used provisioned can include destroyed objects for a destroyed container and represents how much logical space it would take to recover the container.

Constraints

  • minimum = 0

field virtual: Optional[ConstrainedIntValue] = None

The amount of logically written data that a volume or a snapshot references. Measured in bytes.

Constraints

  • minimum = 0

SnmpAgent

pydantic model pypureclient.flasharray.SnmpAgent(*, name: Optional[StrictStr] = None, engine_id: Optional[ConstrainedStrValue] = None, v2c: Optional[SnmpV2c] = None, v3: Optional[SnmpV3] = None, version: Optional[StrictStr] = None)
field engine_id: Optional[ConstrainedStrValue] = None

The administration domain unique name of an SNMP agent.

Constraints

  • maxLength = 32

field name: Optional[StrictStr] = None

A locally unique, system-generated name. The name cannot be modified.

field v2c: Optional[SnmpV2c] = None
field v3: Optional[SnmpV3] = None
field version: Optional[StrictStr] = None

Version of the SNMP protocol to be used by Purity//FA in communications with the specified manager. Valid values are v2c and v3.

SnmpAgentGetResponse

pydantic model pypureclient.flasharray.SnmpAgentGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[SnmpAgent]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[SnmpAgent]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

SnmpAgentMib

pydantic model pypureclient.flasharray.SnmpAgentMib(*, mib: Optional[StrictStr] = None)
field mib: Optional[StrictStr] = None

MIB text.

SnmpAgentMibGetResponse

pydantic model pypureclient.flasharray.SnmpAgentMibGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[SnmpAgentMib]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[SnmpAgentMib]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

SnmpAgentMibResponse

pydantic model pypureclient.flasharray.SnmpAgentMibResponse(*, items: Optional[ConstrainedListValue[SnmpAgentMib]] = None)
field items: Optional[ConstrainedListValue[SnmpAgentMib]] = None

SnmpAgentPatch

pydantic model pypureclient.flasharray.SnmpAgentPatch(*, name: Optional[StrictStr] = None, engine_id: Optional[ConstrainedStrValue] = None, v2c: Optional[SnmpV2c] = None, v3: Optional[SnmpV3Patch] = None, version: Optional[StrictStr] = None)
field engine_id: Optional[ConstrainedStrValue] = None

The administration domain unique name of an SNMP agent.

Constraints

  • maxLength = 32

field name: Optional[StrictStr] = None

A locally unique, system-generated name. The name cannot be modified.

field v2c: Optional[SnmpV2c] = None
field v3: Optional[SnmpV3Patch] = None
field version: Optional[StrictStr] = None

Version of the SNMP protocol to be used by Purity//FA in communications with the specified manager. Valid values are v2c and v3.

SnmpAgentResponse

pydantic model pypureclient.flasharray.SnmpAgentResponse(*, items: Optional[ConstrainedListValue[SnmpAgent]] = None)
field items: Optional[ConstrainedListValue[SnmpAgent]] = None

SnmpManager

pydantic model pypureclient.flasharray.SnmpManager(*, name: Optional[StrictStr] = None, host: Optional[StrictStr] = None, notification: Optional[StrictStr] = None, v2c: Optional[SnmpV2c] = None, v3: Optional[SnmpV3] = None, version: Optional[StrictStr] = None)
field host: Optional[StrictStr] = None

DNS hostname or IP address of a computer that hosts an SNMP manager to which Purity//FA is to send trap messages when it generates alerts.

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

field notification: Optional[StrictStr] = None

The type of notification the agent will send. Valid values are inform and trap.

field v2c: Optional[SnmpV2c] = None
field v3: Optional[SnmpV3] = None
field version: Optional[StrictStr] = None

Version of the SNMP protocol to be used by Purity//FA to communicate with the specified manager. Valid values are v2c and v3.

SnmpManagerGetResponse

pydantic model pypureclient.flasharray.SnmpManagerGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[SnmpManager]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[SnmpManager]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

SnmpManagerPatch

pydantic model pypureclient.flasharray.SnmpManagerPatch(*, name: Optional[StrictStr] = None, host: Optional[StrictStr] = None, notification: Optional[StrictStr] = None, v2c: Optional[SnmpV2c] = None, v3: Optional[SnmpV3Patch] = None, version: Optional[StrictStr] = None)
field host: Optional[StrictStr] = None

DNS hostname or IP address of a computer that hosts an SNMP manager to which Purity//FA is to send trap messages when it generates alerts.

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

field notification: Optional[StrictStr] = None

The type of notification the agent will send. Valid values are inform and trap.

field v2c: Optional[SnmpV2c] = None
field v3: Optional[SnmpV3Patch] = None
field version: Optional[StrictStr] = None

Version of the SNMP protocol to be used by Purity//FA to communicate with the specified manager. Valid values are v2c and v3.

SnmpManagerPost

pydantic model pypureclient.flasharray.SnmpManagerPost(*, host: Optional[StrictStr] = None, notification: Optional[StrictStr] = None, v2c: Optional[SnmpV2c] = None, v3: Optional[SnmpV3Post] = None, version: Optional[StrictStr] = None)
field host: Optional[StrictStr] = None

DNS hostname or IP address of a computer that hosts an SNMP manager to which Purity//FA is to send trap messages when it generates alerts.

field notification: Optional[StrictStr] = None

The type of notification the agent will send. Valid values are inform and trap.

field v2c: Optional[SnmpV2c] = None
field v3: Optional[SnmpV3Post] = None
field version: Optional[StrictStr] = None

Version of the SNMP protocol to be used by Purity//FA to communicate with the specified manager. Valid values are v2c and v3.

SnmpManagerResponse

pydantic model pypureclient.flasharray.SnmpManagerResponse(*, items: Optional[ConstrainedListValue[SnmpManager]] = None)
field items: Optional[ConstrainedListValue[SnmpManager]] = None

SnmpV2c

pydantic model pypureclient.flasharray.SnmpV2c(*, community: Optional[ConstrainedStrValue] = None)

The v2c configurations of SNMP.

field community: Optional[ConstrainedStrValue] = None

Manager community ID under which Purity//FA is to communicate with the specified managers.

Constraints

  • maxLength = 32

SnmpV3

pydantic model pypureclient.flasharray.SnmpV3(*, auth_passphrase: Optional[StrictStr] = None, auth_protocol: Optional[StrictStr] = None, privacy_passphrase: Optional[StrictStr] = None, privacy_protocol: Optional[StrictStr] = None, user: Optional[StrictStr] = None)

The v3 configurations of SNMP.

field auth_passphrase: Optional[StrictStr] = None

Passphrase used by Purity//FA to authenticate the array with the specified managers.

field auth_protocol: Optional[StrictStr] = None

Hash algorithm used to validate the authentication passphrase. Valid values are MD5 and SHA.

field privacy_passphrase: Optional[StrictStr] = None

Passphrase used to encrypt SNMP messages.

field privacy_protocol: Optional[StrictStr] = None

Encryption protocol for SNMP messages. Valid values are AES and DES.

field user: Optional[StrictStr] = None

User ID recognized by the specified SNMP managers which Purity//FA is to use in communications with them.

SnmpV3Patch

pydantic model pypureclient.flasharray.SnmpV3Patch(*, auth_passphrase: Optional[ConstrainedStrValue] = None, auth_protocol: Optional[StrictStr] = None, privacy_passphrase: Optional[ConstrainedStrValue] = None, privacy_protocol: Optional[StrictStr] = None, user: Optional[StrictStr] = None)

The v3 configurations of SNMP.

field auth_passphrase: Optional[ConstrainedStrValue] = None

Passphrase used by Purity//FA to authenticate the array with the specified managers.

Constraints

  • maxLength = 32

field auth_protocol: Optional[StrictStr] = None

Hash algorithm used to validate the authentication passphrase. Valid values are MD5 and SHA.

field privacy_passphrase: Optional[ConstrainedStrValue] = None

Passphrase used to encrypt SNMP messages.

Constraints

  • minLength = 8

  • maxLength = 63

field privacy_protocol: Optional[StrictStr] = None

Encryption protocol for SNMP messages. Valid values are AES and DES.

field user: Optional[StrictStr] = None

User ID recognized by the specified SNMP managers which Purity//FA is to use in communications with them.

SnmpV3Post

pydantic model pypureclient.flasharray.SnmpV3Post(*, auth_passphrase: Optional[ConstrainedStrValue] = None, auth_protocol: Optional[StrictStr] = None, privacy_passphrase: Optional[ConstrainedStrValue] = None, privacy_protocol: Optional[StrictStr] = None, user: Optional[StrictStr] = None)

The v3 configurations of SNMP.

field auth_passphrase: Optional[ConstrainedStrValue] = None

Passphrase used by Purity//FA to authenticate the array with the specified managers.

Constraints

  • maxLength = 32

field auth_protocol: Optional[StrictStr] = None

Hash algorithm used to validate the authentication passphrase. Valid values are MD5 and SHA.

field privacy_passphrase: Optional[ConstrainedStrValue] = None

Passphrase used to encrypt SNMP messages.

Constraints

  • minLength = 8

  • maxLength = 63

field privacy_protocol: Optional[StrictStr] = None

Encryption protocol for SNMP messages. Valid values are AES and DES.

field user: Optional[StrictStr] = None

User ID recognized by the specified SNMP managers which Purity//FA is to use in communications with them.

Software

pydantic model pypureclient.flasharray.Software(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, details: Optional[StrictStr] = None, payload_id: Optional[StrictStr] = None, progress: Optional[Union[StrictFloat, StrictInt]] = None, status: Optional[StrictStr] = None, upgrade_hops: Optional[ConstrainedListValue[StrictStr]] = None, upgrade_plan: Optional[ConstrainedListValue[SoftwareUpgradePlan]] = None, version: Optional[StrictStr] = None)
field details: Optional[StrictStr] = None

The detailed reason for the status.

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified.

field name: Optional[StrictStr] = None

Name of the resource. The name cannot be modified.

field payload_id: Optional[StrictStr] = None

A checksum hash referring to the update bundle.

field progress: Optional[Union[StrictFloat, StrictInt]] = None

The progress of the software upgrade. Displayed in decimal format.

field status: Optional[StrictStr] = None

The status of the software package. Valid values are available, downloaded, downloading, download_failed, checking, installing, new, paused, aborting, abort, canceled, partially_installed, and installed. A status of available indicates that the package is available for download. This only applies if automatic-download is not enabled. A status of downloaded indicates that the package is downloaded and ready for installation. A status of downloading indicates that the package is currently downloading. A status of download_failed indicates that the download of the package failed. A status of checking indicates that the package is currently running in check-only mode. A status of installing indicates that the package is currently installing. A status of new indicates that Pure1 cloud is still building the package. A status of paused indicates that the upgrade is paused and waiting for user input to proceed. A status of aborting indicates that the upgrade is being aborted, due to an unrecoverable error or an abort command issued by the user. A status of canceled indicates that the upgrade has been canceled. A status of partially_installed indicates that the upgrade has been partially installed due to an abort. The array has been upgraded to an intermediate version and the software is no longer available for installation. A status of installed indicates that the upgrade has finished.

field upgrade_hops: Optional[ConstrainedListValue[StrictStr]] = None

The plan by which the upgrade will be conducted. The first element is the current version, the last element is the destination version, and the elements in between are intermediate versions.

Constraints

  • uniqueItems = True

field upgrade_plan: Optional[ConstrainedListValue[SoftwareUpgradePlan]] = None

A list of steps that are planned to run during the upgrade in an optimal scenario (i.e., all upgrade checks pass, no step is retried, and the upgrade is not aborted). Steps are listed in the order that they should occur.

field version: Optional[StrictStr] = None

The version of the software package.

SoftwareBundle

pydantic model pypureclient.flasharray.SoftwareBundle(*, id: Optional[StrictStr] = None, created: Optional[Union[StrictFloat, StrictInt]] = None, details: Optional[StrictStr] = None, download_progress: Optional[Union[StrictFloat, StrictInt]] = None, source: Optional[StrictStr] = None, status: Optional[StrictStr] = None)
field created: Optional[Union[StrictFloat, StrictInt]] = None

Creation time in milliseconds since the UNIX epoch.

field details: Optional[StrictStr] = None

The detailed reason for the status.

field download_progress: Optional[Union[StrictFloat, StrictInt]] = None

The progress of the download. Displayed in decimal format.

field id: Optional[StrictStr] = None

A non-modifiable, globally unique ID chosen by the system.

field source: Optional[StrictStr] = None

The location of the upgrade bundle.

field status: Optional[StrictStr] = None

The status of the software bundle. Valid values are downloading, failed, ready, and verifying. A status of downloading indicates that the array is downloading the upgrade bundle. A status of failed indicates that the array has failed to download the upgrade bundle. A status of ready indicates that the upgrade bundle is ready to be installed. A status of verifying indicates that the array is verifying the upgrade bundle.

SoftwareBundleGetResponse

pydantic model pypureclient.flasharray.SoftwareBundleGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[SoftwareBundle]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[SoftwareBundle]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

SoftwareBundlePost

pydantic model pypureclient.flasharray.SoftwareBundlePost(*, source: Optional[StrictStr] = None)

The source of the software bundle.

field source: Optional[StrictStr] = None

The source of the software bundle. Accepts HTTP, HTTPS or FTP, and paths.

SoftwareBundleResponse

pydantic model pypureclient.flasharray.SoftwareBundleResponse(*, items: Optional[ConstrainedListValue[SoftwareBundle]] = None)
field items: Optional[ConstrainedListValue[SoftwareBundle]] = None

SoftwareCheck

pydantic model pypureclient.flasharray.SoftwareCheck(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, end_time: Optional[StrictInt] = None, start_time: Optional[StrictInt] = None, checks: Optional[ConstrainedListValue[SoftwareChecksChecks]] = None, details: Optional[StrictStr] = None, software_name: Optional[StrictStr] = None, software_upgrade_hops: Optional[ConstrainedListValue[StrictStr]] = None, software_version: Optional[StrictStr] = None, status: Optional[StrictStr] = None)
field checks: Optional[ConstrainedListValue[SoftwareChecksChecks]] = None

A list of checks in this check task.

field details: Optional[StrictStr] = None

The detailed reason for the status.

field end_time: Optional[StrictInt] = None

End time in milliseconds since the UNIX epoch.

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified.

field name: Optional[StrictStr] = None

Name of the resource. The name cannot be modified.

field software_name: Optional[StrictStr] = None

The name of the software the upgrade checks will test.

field software_upgrade_hops: Optional[ConstrainedListValue[StrictStr]] = None

The list of software versions the upgrade goes through. The upgrade checks also test this particular path.

field software_version: Optional[StrictStr] = None

The version of the software that the upgrade checks will test.

field start_time: Optional[StrictInt] = None

Start time in milliseconds since the UNIX epoch.

field status: Optional[StrictStr] = None

The status of the check task. Valid values are queued, running, passed, and failed. A status of queued indicates that the task is queued to run and is waiting for other check tasks to complete. A status of running indicates that the task is currently running. A status of passed indicates that all upgrade checks in the task are complete. A status of failed indicates that at least one upgrade check in the task has failed.

SoftwareChecksChecks

pydantic model pypureclient.flasharray.SoftwareChecksChecks(*, details: Optional[StrictStr] = None, name: Optional[StrictStr] = None, status: Optional[StrictStr] = None)
field details: Optional[StrictStr] = None

Detailed result of the check used to diagnose check failures.

field name: Optional[StrictStr] = None

Name of the upgrade check.

field status: Optional[StrictStr] = None

Status of the check. Valid values are running, failed, and passed. A status of running indicates that the check has not finished. A status of failed indicates that the check has failed. A status of passed indicates that the check has passed.

SoftwareChecksGetResponse

pydantic model pypureclient.flasharray.SoftwareChecksGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[SoftwareCheck]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[SoftwareCheck]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

SoftwareChecksResponse

pydantic model pypureclient.flasharray.SoftwareChecksResponse(*, items: Optional[ConstrainedListValue[SoftwareCheck]] = None)
field items: Optional[ConstrainedListValue[SoftwareCheck]] = None

SoftwareGetResponse

pydantic model pypureclient.flasharray.SoftwareGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Software]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[Software]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

SoftwareInstallation

pydantic model pypureclient.flasharray.SoftwareInstallation(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, end_time: Optional[StrictInt] = None, start_time: Optional[StrictInt] = None, current_step_id: Optional[StrictStr] = None, details: Optional[StrictStr] = None, mode: Optional[StrictStr] = None, override_checks: Optional[ConstrainedListValue[OverrideCheck]] = None, software: Optional[Reference] = None, status: Optional[StrictStr] = None, upgrade_parameters: Optional[ConstrainedListValue[UpgradeParameters]] = None)
field current_step_id: Optional[StrictStr] = None

The id of the current step or null if the upgrade is not active.

field details: Optional[StrictStr] = None

The detailed reason for the status.

field end_time: Optional[StrictInt] = None

End time in milliseconds since the UNIX epoch.

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified.

field mode: Optional[StrictStr] = None

Mode that the upgrade is in. Valid values are check-only, interactive, semi-interactive, and one-click. The check_only mode is deprecated. Use /software-checks. In this mode, the upgrade only runs pre-upgrade checks and returns. In interactive mode, the upgrade pauses at several points, at which users must enter certain commands to proceed. In semi-interactive mode, the upgrade pauses if there are any upgrade check failures, and functions like one-click mode otherwise. In one-click mode, the upgrade proceeds automatically without pausing.

field name: Optional[StrictStr] = None

Name of the resource. The name cannot be modified.

field override_checks: Optional[ConstrainedListValue[OverrideCheck]] = None

A list of upgrade checks whose failure is overridden during the upgrade. If any optional args are provided, they are validated later when the corresponding check script runs.

field software: Optional[Reference] = None

Referenced software to which the upgrade belongs.

field start_time: Optional[StrictInt] = None

Start time in milliseconds since the UNIX epoch.

field status: Optional[StrictStr] = None

Status of the upgrade. Valid values are installing, paused, aborting, aborted, and finished. A status of installing indicates that the upgrade is running. A status of paused indicates that the upgrade is paused and waiting for user input. A status of aborting indicates that the upgrade is being aborted. A status of aborted indicates that the upgrade has stopped due to an abort. A status of finished indicates that the upgrade has finished successfully.

field upgrade_parameters: Optional[ConstrainedListValue[UpgradeParameters]] = None

A list of parameters to be sent to the upgrade process. These parameters can be used to change the behavior of the upgrade process in specific ways such as enabling or disabling features in the target version or changing the attributes of the appliance at upgrade time. When there is a need or option to set an upgrade parameter, Pure Storage will provide documentation for the specific parameter. If you have been provided documentation related to a specific upgrade parameter, follow the instructions in the documentation. Otherwise, do not set any upgrade parameters.

SoftwareInstallationPatch

pydantic model pypureclient.flasharray.SoftwareInstallationPatch(*, add_override_checks: Optional[ConstrainedListValue[OverrideCheck]] = None)
field add_override_checks: Optional[ConstrainedListValue[OverrideCheck]] = None

Adds the specified checks to the current list of override checks.

SoftwareInstallationPost

pydantic model pypureclient.flasharray.SoftwareInstallationPost(*, mode: Optional[StrictStr] = None, override_checks: Optional[ConstrainedListValue[OverrideCheck]] = None, upgrade_parameters: Optional[ConstrainedListValue[UpgradeParameters]] = None)

Software upgrade attempt.

field mode: Optional[StrictStr] = None

Mode that the upgrade is in. Valid values are check-only, interactive, semi-interactive, and one-click. The check_only mode is deprecated. Use /software-checks. In this mode, the upgrade only runs pre-upgrade checks and returns. In interactive mode, the upgrade pauses at several points, at which users must enter certain commands to proceed. In semi-interactive mode, the upgrade pauses if there are any upgrade check failures and functions like one-click mode otherwise. In one-click mode, the upgrade proceeds automatically without pausing.

field override_checks: Optional[ConstrainedListValue[OverrideCheck]] = None

A list of upgrade checks whose failures are overridden during the upgrade. If any optional args are provided, they are validated later when the corresponding check script runs.

field upgrade_parameters: Optional[ConstrainedListValue[UpgradeParameters]] = None

A list of parameters to be sent to the upgrade process. These parameters can be used to change the behavior of the upgrade process in specific ways such as enabling or disabling features in the target version or changing the attributes of the appliance at upgrade time. When there is a need or option to set an upgrade parameter, Pure Storage will provide documentation for the specific parameter. If you have been provided documentation related to a specific upgrade parameter, follow the instructions in the documentation. Otherwise, do not set any upgrade parameters.

SoftwareInstallationStep

pydantic model pypureclient.flasharray.SoftwareInstallationStep(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, end_time: Optional[StrictInt] = None, start_time: Optional[StrictInt] = None, checks: Optional[ConstrainedListValue[SoftwareInstallationStepsChecks]] = None, description: Optional[StrictStr] = None, details: Optional[StrictStr] = None, hop_version: Optional[StrictStr] = None, installation: Optional[Reference] = None, status: Optional[StrictStr] = None)
field checks: Optional[ConstrainedListValue[SoftwareInstallationStepsChecks]] = None

A list of checks in this upgrade step.

field description: Optional[StrictStr] = None

Detailed description of the step.

field details: Optional[StrictStr] = None

Detailed result of the step used to diagnose step failures.

field end_time: Optional[StrictInt] = None

End time in milliseconds since the UNIX epoch.

field hop_version: Optional[StrictStr] = None

The version to which the current hop is upgrading.

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified.

field installation: Optional[Reference] = None

Referenced software-installation to which the step belongs.

field name: Optional[StrictStr] = None

Name of the resource. The name cannot be modified.

field start_time: Optional[StrictInt] = None

Start time in milliseconds since the UNIX epoch.

field status: Optional[StrictStr] = None

Status of the step. Valid values are running and finished. A status of running indicates that the step has not finished. A status of finished indicates that the check has finished.

SoftwareInstallationStepsChecks

pydantic model pypureclient.flasharray.SoftwareInstallationStepsChecks(*, details: Optional[StrictStr] = None, name: Optional[StrictStr] = None, overridable: Optional[StrictBool] = None, status: Optional[StrictStr] = None)
field details: Optional[StrictStr] = None

Detailed result of the check used to diagnose check failures.

field name: Optional[StrictStr] = None

Name of the upgrade check.

field overridable: Optional[StrictBool] = None

Whether the check failure can be overridden.

Constraints

  • type = boolean

field status: Optional[StrictStr] = None

Status of the check. Valid values are running, failed, passed, and overridden. A status of running indicates that the check has not finished. A status of failed indicates that the check has failed. A status of passed indicates that the check has passed. A status of overridden indicates that the check has failed, but the failure has been overridden.

SoftwareInstallationStepsGetResponse

pydantic model pypureclient.flasharray.SoftwareInstallationStepsGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[SoftwareInstallationStep]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[SoftwareInstallationStep]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

SoftwareInstallationStepsResponse

pydantic model pypureclient.flasharray.SoftwareInstallationStepsResponse(*, items: Optional[ConstrainedListValue[SoftwareInstallationStep]] = None)
field items: Optional[ConstrainedListValue[SoftwareInstallationStep]] = None

SoftwareInstallationsGetResponse

pydantic model pypureclient.flasharray.SoftwareInstallationsGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[SoftwareInstallation]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[SoftwareInstallation]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

SoftwareInstallationsResponse

pydantic model pypureclient.flasharray.SoftwareInstallationsResponse(*, items: Optional[ConstrainedListValue[SoftwareInstallation]] = None)
field items: Optional[ConstrainedListValue[SoftwareInstallation]] = None

SoftwarePatch

pydantic model pypureclient.flasharray.SoftwarePatch(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, alert_code: Optional[StrictInt] = None, description: Optional[StrictStr] = None, details: Optional[StrictStr] = None, ha_reduction_required: Optional[StrictBool] = None, progress: Optional[Union[StrictFloat, StrictInt]] = None, status: Optional[StrictStr] = None)
field alert_code: Optional[StrictInt] = None

Alert code for the Software Patch. This code is used to uniquely identify the Software Patch.

field description: Optional[StrictStr] = None

The detailed description of the patch.

field details: Optional[StrictStr] = None

The detailed reason for the status.

field ha_reduction_required: Optional[StrictBool] = None

If set to true, indicates reduction in high availability is required for Software Patch installation. If set to false, indicates such a reduction is not required.

Constraints

  • type = boolean

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified.

field name: Optional[StrictStr] = None

Name of the resource. The name cannot be modified.

field progress: Optional[Union[StrictFloat, StrictInt]] = None

The progress of the software patch installation, displayed in decimal format.

field status: Optional[StrictStr] = None

The status of the software patch installation. Valid values are available, downloaded, downloading, download_failed, installing, installed, failed, and not_applicable. A status of available indicates that the patch is available for download. A status of downloaded indicates that the patch has been downloaded and will be installed. A status of downloading indicates that the patch is currently downloading. A status of download_failed indicates that the download of the patch failed. A status of installing indicates that the patch is currently being installed. A status of installed indicates that the patch has been installed. A status of failed indicates that the patch failed to be installed. A status of not_applicable indicates the patch does not need to be installed on the array.

SoftwarePatchesGetResponse

pydantic model pypureclient.flasharray.SoftwarePatchesGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[SoftwarePatch]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[SoftwarePatch]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

SoftwarePatchesResponse

pydantic model pypureclient.flasharray.SoftwarePatchesResponse(*, items: Optional[ConstrainedListValue[SoftwarePatch]] = None)
field items: Optional[ConstrainedListValue[SoftwarePatch]] = None

SoftwarePost

pydantic model pypureclient.flasharray.SoftwarePost(*, name: Optional[StrictStr] = None, version: Optional[StrictStr] = None)

Software to be installed on the array.

field name: Optional[StrictStr] = None

The name of the software.

field version: Optional[StrictStr] = None

The version of the software.

SoftwareResponse

pydantic model pypureclient.flasharray.SoftwareResponse(*, items: Optional[ConstrainedListValue[Software]] = None)
field items: Optional[ConstrainedListValue[Software]] = None

SoftwareUpgradePlan

pydantic model pypureclient.flasharray.SoftwareUpgradePlan(*, description: Optional[StrictStr] = None, hop_version: Optional[StrictStr] = None, step_name: Optional[StrictStr] = None)
field description: Optional[StrictStr] = None

Description of the upgrade step.

field hop_version: Optional[StrictStr] = None

The version to which the step is upgrading.

field step_name: Optional[StrictStr] = None

Name of the upgrade step.

SoftwareVersion

pydantic model pypureclient.flasharray.SoftwareVersion(*, details: Optional[StrictStr] = None, name: Optional[StrictStr] = None, release_family: Optional[StrictStr] = None, upgrade_hops: Optional[ConstrainedListValue[StrictStr]] = None, version: Optional[StrictStr] = None)

Version candidates for software upgrade.

field details: Optional[StrictStr] = None

The description of the version.

field name: Optional[StrictStr] = None

The name of the software.

field release_family: Optional[StrictStr] = None

The major and minor release number of the version.

field upgrade_hops: Optional[ConstrainedListValue[StrictStr]] = None

The list of software versions the upgrade will go through.

field version: Optional[StrictStr] = None

The version of the software.

SoftwareVersionsGetResponse

pydantic model pypureclient.flasharray.SoftwareVersionsGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[SoftwareVersion]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[SoftwareVersion]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

SoftwareVersionsResponse

pydantic model pypureclient.flasharray.SoftwareVersionsResponse(*, items: Optional[ConstrainedListValue[SoftwareVersion]] = None)
field items: Optional[ConstrainedListValue[SoftwareVersion]] = None

Space

pydantic model pypureclient.flasharray.Space(*, data_reduction: Optional[Union[StrictFloat, StrictInt]] = None, footprint: Optional[ConstrainedIntValue] = None, shared: Optional[ConstrainedIntValue] = None, snapshots: Optional[ConstrainedIntValue] = None, system: Optional[ConstrainedIntValue] = None, thin_provisioning: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, total_physical: Optional[ConstrainedIntValue] = None, total_provisioned: Optional[ConstrainedIntValue] = None, total_reduction: Optional[Union[StrictFloat, StrictInt]] = None, total_used: Optional[ConstrainedIntValue] = None, unique: Optional[ConstrainedIntValue] = None, used_provisioned: Optional[ConstrainedIntValue] = None, virtual: Optional[ConstrainedIntValue] = None)
field data_reduction: Optional[Union[StrictFloat, StrictInt]] = None

The ratio of mapped sectors within a volume versus the amount of physical space the data occupies after data compression and deduplication. The data reduction ratio does not include thin provisioning savings. For example, a data reduction ratio of 5&#58;1 means that for every 5 MB the host writes to the array, 1 MB is stored on the array’s flash modules.

field footprint: Optional[ConstrainedIntValue] = None

The maximum amount of physical space the container consumes on an array, ignoring any data shared outside the container, measured in bytes. On Evergreen//One arrays, this is the maximum amount of effective used space. The footprint metric is mostly used for capacity planning. This field will be null in non-container contexts.

Constraints

  • minimum = 0

field shared: Optional[ConstrainedIntValue] = None

The physical space occupied by deduplicated data, meaning that the space is shared with other volumes and snapshots as a result of data deduplication. Measured in bytes. On Evergreen//One arrays, this is the effective space contributed by data that is not unique to a specific volume, managed directory, or snapshot, measured in bytes.

Constraints

  • minimum = 0

field snapshots: Optional[ConstrainedIntValue] = None

The physical space occupied by data unique to one or more snapshots. Measured in bytes. On Evergreen//One arrays, this is the effective space contributed by data unique to one or more snapshots, measured in bytes.

Constraints

  • minimum = 0

field system: Optional[ConstrainedIntValue] = None

The physical space occupied by internal array metadata. Measured in bytes.

Constraints

  • minimum = 0

field thin_provisioning: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

The percentage of volume sectors that do not contain host-written data because the hosts have not written data to them or the sectors have been explicitly trimmed.

field total_physical: Optional[ConstrainedIntValue] = None

This field has been deprecated. Use the total_used field, as it contains the same information.

Constraints

  • minimum = 0

field total_provisioned: Optional[ConstrainedIntValue] = None

The provisioned size of a volume for a single volume, host or host group, protocol endpoint, managed directory, and containers can be infinite or measured in bytes. Infinite is represented by null. The provisioned size for a host or host group, includes all volumes that are connected to the resource. The provisioned size for a protocol endpoint is null’. The provisioned size for a managed directory is the quota limit if it or its parent has a managed directory configured, otherwise it defaults to `null. The provisioned size for a container is the sum of the total_provisioned of the object it contains, capped by the container’s quota limit (or the container’s used_provisioned if current usage is above the quota limit), if any. Provisioned size represents the storage capacity reported to hosts.

Constraints

  • minimum = 0

field total_reduction: Optional[Union[StrictFloat, StrictInt]] = None

The ratio of provisioned sectors within a volume versus the amount of physical space the data occupies after reduction via data compression and deduplication and with thin provisioning savings. Total reduction is data reduction with thin provisioning savings. For example, a total reduction ratio of 10&#58;1 means that for every 10 MB of provisioned space, 1 MB is stored on the array’s flash modules.

field total_used: Optional[ConstrainedIntValue] = None

The total space contributed by customer data, measured in bytes.

Constraints

  • minimum = 0

field unique: Optional[ConstrainedIntValue] = None

The unique physical space occupied by customer data. Unique physical space does not include shared space, snapshots, and internal array metadata. Measured in bytes. On Evergreen//One arrays, this is the effective space contributed by unique customer data, measured in bytes. Unique data does not include shared space, snapshots, and internal array metadata.

Constraints

  • minimum = 0

field used_provisioned: Optional[ConstrainedIntValue] = None

The amount of logical space a container has consumed, compared against the quota limit if the container has one configured. Used provisioned does not include destroyed objects inside the container. Used provisioned can include destroyed objects for a destroyed container and represents how much logical space it would take to recover the container.

Constraints

  • minimum = 0

field virtual: Optional[ConstrainedIntValue] = None

The amount of logically written data that a volume or a snapshot references. Measured in bytes.

Constraints

  • minimum = 0

SpaceNoDeprecatedPhysicalOrEffective

pydantic model pypureclient.flasharray.SpaceNoDeprecatedPhysicalOrEffective(*, data_reduction: Optional[Union[StrictFloat, StrictInt]] = None, footprint: Optional[ConstrainedIntValue] = None, shared: Optional[ConstrainedIntValue] = None, snapshots: Optional[ConstrainedIntValue] = None, system: Optional[ConstrainedIntValue] = None, thin_provisioning: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, total_provisioned: Optional[ConstrainedIntValue] = None, total_reduction: Optional[Union[StrictFloat, StrictInt]] = None, total_used: Optional[ConstrainedIntValue] = None, unique: Optional[ConstrainedIntValue] = None, used_provisioned: Optional[ConstrainedIntValue] = None, virtual: Optional[ConstrainedIntValue] = None)
field data_reduction: Optional[Union[StrictFloat, StrictInt]] = None

The ratio of mapped sectors within a volume versus the amount of physical space the data occupies after data compression and deduplication. The data reduction ratio does not include thin provisioning savings. For example, a data reduction ratio of 5&#58;1 means that for every 5 MB the host writes to the array, 1 MB is stored on the array’s flash modules.

field footprint: Optional[ConstrainedIntValue] = None

The maximum amount of physical space the container would take up on any array, ignoring any data shared outside the container. Measured in bytes. On Evergreen//One arrays, this is the maximum amount of effective used space, measured in bytes. The footprint metric is mostly used for capacity planning. This field will be null in non-container contexts.

Constraints

  • minimum = 0

field shared: Optional[ConstrainedIntValue] = None

The physical space occupied by deduplicated data, meaning that the space is shared with other volumes and snapshots as a result of data deduplication, measured in bytes. On Evergreen//One arrays, this is the effective space contributed by data that is not unique to a specific volume, managed directory, or snapshot, measured in bytes.

Constraints

  • minimum = 0

field snapshots: Optional[ConstrainedIntValue] = None

The physical space occupied by data unique to one or more snapshots, measured in bytes. On Evergreen//One arrays, this is the effective space contributed by data unique to one or more snapshots, measured in bytes.

Constraints

  • minimum = 0

field system: Optional[ConstrainedIntValue] = None

The physical space occupied by internal array metadata, measured in bytes.

Constraints

  • minimum = 0

field thin_provisioning: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

The percentage of volume sectors that do not contain host-written data because the hosts have not written data to them or the sectors have been explicitly trimmed.

field total_provisioned: Optional[ConstrainedIntValue] = None

The provisioned size of a volume for a single volume, host or host group, protocol endpoint, managed directory, and containers can be infinite or measured in bytes. Infinite is represented by null. The provisioned size for a host or host group, includes all volumes that are connected to the resource. The provisioned size for a protocol endpoint is null’. The provisioned size for a managed directory is the quota limit if it or its parent has a managed directory configured, otherwise it defaults to `null. The provisioned size for a container is the sum of the total_provisioned of the object it contains, capped by the container’s quota limit (or the container’s used_provisioned if current usage is above the quota limit), if any. Provisioned size represents the storage capacity reported to hosts.

Constraints

  • minimum = 0

field total_reduction: Optional[Union[StrictFloat, StrictInt]] = None

The ratio of provisioned sectors within a volume versus the amount of physical space the data occupies after reduction via data compression and deduplication and with thin provisioning savings. Total reduction is data reduction with thin provisioning savings. For example, a total reduction ratio of 10&#58;1 means that for every 10 MB of provisioned space, 1 MB is stored on the array’s flash modules.

field total_used: Optional[ConstrainedIntValue] = None

The total space contributed by customer data, measured in bytes.

Constraints

  • minimum = 0

field unique: Optional[ConstrainedIntValue] = None

The unique physical space occupied by customer data. Unique physical space does not include shared space, snapshots, and internal array metadata. Measured in bytes. On Evergreen//One arrays, this is the effective space contributed by unique customer data, measured in bytes. Unique data does not include shared space, snapshots, and internal array metadata.

Constraints

  • minimum = 0

field used_provisioned: Optional[ConstrainedIntValue] = None

The amount of logical space a container has consumed. The amount of logical space is compared against the quota limit if the container has one configured. Used provisioned does not include destroyed objects inside the container. For a destroyed container, used provisioned can include destroyed objects and represents how much logical space it would take to recover the container.

Constraints

  • minimum = 0

field virtual: Optional[ConstrainedIntValue] = None

The amount of logically written data that a volume or a snapshot references, measured in bytes.

Constraints

  • minimum = 0

StartEndTime

pydantic model pypureclient.flasharray.StartEndTime(*, end_time: Optional[StrictInt] = None, start_time: Optional[StrictInt] = None)

A resource with a start time and end time.

field end_time: Optional[StrictInt] = None

End time in milliseconds since the UNIX epoch.

field start_time: Optional[StrictInt] = None

Start time in milliseconds since the UNIX epoch.

Subnet

pydantic model pypureclient.flasharray.Subnet(*, name: Optional[StrictStr] = None, enabled: Optional[StrictBool] = None, gateway: Optional[StrictStr] = None, mtu: Optional[ConstrainedIntValue] = None, prefix: Optional[StrictStr] = None, vlan: Optional[StrictInt] = None, interfaces: Optional[ConstrainedListValue[FixedReferenceNoId]] = None, services: Optional[ConstrainedListValue[StrictStr]] = None)
field enabled: Optional[StrictBool] = None

Returns a value of true if subnet is enabled. Returns a value of false if subnet is disabled. If not specified, defaults to true.

Constraints

  • type = boolean

field gateway: Optional[StrictStr] = None

The IPv4 or IPv6 address of the gateway through which the specified subnet is to communicate with the network.

field interfaces: Optional[ConstrainedListValue[FixedReferenceNoId]] = None

List of network interfaces associated with this subnet.

field mtu: Optional[ConstrainedIntValue] = None

Maximum message transfer unit (packet) size for the subnet in bytes. MTU setting cannot exceed the MTU of the corresponding physical interface. If not specified, defaults to 1500.

Constraints

  • minimum = 1280

  • maximum = 9216

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

field prefix: Optional[StrictStr] = None

The IPv4 or IPv6 address to be associated with the specified subnet.

field services: Optional[ConstrainedListValue[StrictStr]] = None

The services provided by this subnet, as inherited from all of its interfaces.

field vlan: Optional[StrictInt] = None

VLAN ID number.

SubnetGetResponse

pydantic model pypureclient.flasharray.SubnetGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Subnet]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[Subnet]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

SubnetPatch

pydantic model pypureclient.flasharray.SubnetPatch(*, name: Optional[StrictStr] = None, enabled: Optional[StrictBool] = None, gateway: Optional[StrictStr] = None, mtu: Optional[ConstrainedIntValue] = None, prefix: Optional[StrictStr] = None, vlan: Optional[StrictInt] = None)
field enabled: Optional[StrictBool] = None

Returns a value of true if subnet is enabled. Returns a value of false if subnet is disabled. If not specified, defaults to true.

Constraints

  • type = boolean

field gateway: Optional[StrictStr] = None

The IPv4 or IPv6 address of the gateway through which the specified subnet is to communicate with the network.

field mtu: Optional[ConstrainedIntValue] = None

Maximum message transfer unit (packet) size for the subnet in bytes. MTU setting cannot exceed the MTU of the corresponding physical interface. If not specified, defaults to 1500.

Constraints

  • minimum = 1280

  • maximum = 9216

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

field prefix: Optional[StrictStr] = None

The IPv4 or IPv6 address to be associated with the specified subnet.

field vlan: Optional[StrictInt] = None

VLAN ID number.

SubnetPost

pydantic model pypureclient.flasharray.SubnetPost(*, enabled: Optional[StrictBool] = None, gateway: Optional[StrictStr] = None, mtu: Optional[ConstrainedIntValue] = None, prefix: Optional[StrictStr] = None, vlan: Optional[StrictInt] = None)
field enabled: Optional[StrictBool] = None

Returns a value of true if subnet is enabled. Returns a value of false if subnet is disabled. If not specified, defaults to true.

Constraints

  • type = boolean

field gateway: Optional[StrictStr] = None

The IPv4 or IPv6 address of the gateway through which the specified subnet is to communicate with the network.

field mtu: Optional[ConstrainedIntValue] = None

Maximum message transfer unit (packet) size for the subnet in bytes. MTU setting cannot exceed the MTU of the corresponding physical interface. If not specified, defaults to 1500.

Constraints

  • minimum = 1280

  • maximum = 9216

field prefix: Optional[StrictStr] = None

The IPv4 or IPv6 address to be associated with the specified subnet.

field vlan: Optional[StrictInt] = None

VLAN ID number.

SubnetResponse

pydantic model pypureclient.flasharray.SubnetResponse(*, items: Optional[ConstrainedListValue[Subnet]] = None)
field items: Optional[ConstrainedListValue[Subnet]] = None

Subscription

pydantic model pypureclient.flasharray.Subscription(*, id: Optional[StrictStr] = None, service: Optional[StrictStr] = None)
field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified.

field service: Optional[StrictStr] = None

The service type of the subscription.

SubscriptionAsset

pydantic model pypureclient.flasharray.SubscriptionAsset(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, subscription: Optional[SubscriptionAssetSubscription] = None)
field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

field subscription: Optional[SubscriptionAssetSubscription] = None

SubscriptionAssetGetResponse

pydantic model pypureclient.flasharray.SubscriptionAssetGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[SubscriptionAsset]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[SubscriptionAsset]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

SubscriptionAssetResponse

pydantic model pypureclient.flasharray.SubscriptionAssetResponse(*, items: Optional[ConstrainedListValue[SubscriptionAsset]] = None)
field items: Optional[ConstrainedListValue[SubscriptionAsset]] = None

SubscriptionAssetSubscription

pydantic model pypureclient.flasharray.SubscriptionAssetSubscription(*, id: Optional[StrictStr] = None)

A reference to which subscription this appliance belongs.

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified.

SubscriptionGetResponse

pydantic model pypureclient.flasharray.SubscriptionGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Subscription]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[Subscription]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

SubscriptionResponse

pydantic model pypureclient.flasharray.SubscriptionResponse(*, items: Optional[ConstrainedListValue[Subscription]] = None)
field items: Optional[ConstrainedListValue[Subscription]] = None

Support

pydantic model pypureclient.flasharray.Support(*, phonehome_enabled: Optional[StrictBool] = None, proxy: Optional[StrictStr] = None, remote_assist_active: Optional[StrictBool] = None, remote_assist_duration: Optional[StrictInt] = None, remote_assist_expires: Optional[StrictInt] = None, remote_assist_opened: Optional[StrictInt] = None, remote_assist_paths: Optional[ConstrainedListValue[SupportRemoteAssistPaths]] = None, remote_assist_status: Optional[StrictStr] = None)
field phonehome_enabled: Optional[StrictBool] = None

If set to true, enables phonehome. If set to false, disables phonehome.

Constraints

  • type = boolean

field proxy: Optional[StrictStr] = None

The value of the current proxy, which is used to connect to cloud services such as phonehome and remote assist. Specify the server name, including the scheme and proxy port number.

field remote_assist_active: Optional[StrictBool] = None

If set to true, enables the remote assist session. If set to false, disables the remote assist session.

Constraints

  • type = boolean

field remote_assist_duration: Optional[StrictInt] = None

Specifies the duration of the remote assist session in milliseconds. This parameter should only be provided when establishing a new session. It determines the length of time the session will remain active after it’s initiated.

field remote_assist_expires: Optional[StrictInt] = None

The timestamp when the session expires, measured in milliseconds since the UNIX epoch.

field remote_assist_opened: Optional[StrictInt] = None

The timestamp when the session opened, measured in milliseconds since the UNIX epoch.

field remote_assist_paths: Optional[ConstrainedListValue[SupportRemoteAssistPaths]] = None
field remote_assist_status: Optional[StrictStr] = None

The status of the remote assist session. Values include connected, connecting, disconnected, and session-active.

SupportDiagnosticsDetails

pydantic model pypureclient.flasharray.SupportDiagnosticsDetails(*, result_details: Optional[StrictStr] = None, severity: Optional[StrictStr] = None, test_name: Optional[StrictStr] = None, test_type: Optional[StrictStr] = None)

Details of diagnostics tests tasks

field result_details: Optional[StrictStr] = None

Additional details related to the test. This field also provides remediation information.

field severity: Optional[StrictStr] = None

Severity level of the test. Valid values are info, warning, and critical.

field test_name: Optional[StrictStr] = None

Name of the test that was performed.

field test_type: Optional[StrictStr] = None

The category to which the test belongs to.

SupportDiagnosticsDetailsGetResponse

pydantic model pypureclient.flasharray.SupportDiagnosticsDetailsGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[SupportDiagnosticsDetails]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[SupportDiagnosticsDetails]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

SupportDiagnosticsDetailsResponse

pydantic model pypureclient.flasharray.SupportDiagnosticsDetailsResponse(*, items: Optional[ConstrainedListValue[SupportDiagnosticsDetails]] = None)
field items: Optional[ConstrainedListValue[SupportDiagnosticsDetails]] = None

SupportDiagnosticsGetResponse

pydantic model pypureclient.flasharray.SupportDiagnosticsGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[SupportDiagnosticsSettings]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[SupportDiagnosticsSettings]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

SupportDiagnosticsResponse

pydantic model pypureclient.flasharray.SupportDiagnosticsResponse(*, items: Optional[ConstrainedListValue[SupportDiagnosticsSettings]] = None)
field items: Optional[ConstrainedListValue[SupportDiagnosticsSettings]] = None

SupportDiagnosticsSettings

pydantic model pypureclient.flasharray.SupportDiagnosticsSettings(*, last_updated: Optional[StrictInt] = None, version: Optional[StrictStr] = None)

Diagnostics tools

field last_updated: Optional[StrictInt] = None

Date the diagnostics tool was last updated.

field version: Optional[StrictStr] = None

Version of the diagnostics tool.

SupportGetResponse

pydantic model pypureclient.flasharray.SupportGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Support]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[Support]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

SupportPatch

pydantic model pypureclient.flasharray.SupportPatch(*, phonehome_enabled: Optional[StrictBool] = None, proxy: Optional[StrictStr] = None, remote_assist_active: Optional[StrictBool] = None, remote_assist_duration: Optional[StrictInt] = None)
field phonehome_enabled: Optional[StrictBool] = None

The status of phonehome. If set to true, enable phonehome. If set to false, disable phonehome.

Constraints

  • type = boolean

field proxy: Optional[StrictStr] = None

The value of the current proxy, which is used for connecting to cloud services such as phonehome, remote assist, etc. Specify the server name, including the scheme and proxy port number.

field remote_assist_active: Optional[StrictBool] = None

The status of a remote assist session. If set to true, enable the remote assist session. If set to false, disable the remote assist session.

Constraints

  • type = boolean

field remote_assist_duration: Optional[StrictInt] = None

Specifies the duration of the remote assist session in milliseconds. This parameter should only be provided when establishing a new session. This parameter determines the length of time the session will remain active after it is initiated.

SupportRemoteAssistPaths

pydantic model pypureclient.flasharray.SupportRemoteAssistPaths(*, component_name: Optional[StrictStr] = None, status: Optional[StrictStr] = None)
field component_name: Optional[StrictStr] = None

The name of the local controller that is running the remote assist session.

field status: Optional[StrictStr] = None

The status of the remote assist session on the local controller. Values include connected, connecting, disconnected, and session-active.

SupportRemoteAssistSessions

pydantic model pypureclient.flasharray.SupportRemoteAssistSessions(*, access_level: Optional[StrictStr] = None, active: Optional[StrictBool] = None, duration: Optional[StrictInt] = None, expires: Optional[StrictInt] = None, opened: Optional[StrictInt] = None, paths: Optional[ConstrainedListValue[SupportRemoteAssistSessionsPaths]] = None, status: Optional[StrictStr] = None)

Remote assist session settings.

field access_level: Optional[StrictStr] = None

The access level for this remote assist session. This is set to default_access_level unless access_level_override is provided. Values include restricted and elevated.

field active: Optional[StrictBool] = None

The status of a remote assist session. If set to true, enables the remote assist session. If set to false, disables the remote assist session.

Constraints

  • type = boolean

field duration: Optional[StrictInt] = None

Specifies the duration of the remote assist session in milliseconds. This parameter should only be provided when establishing a new session. This parameter determines the length of time the session will remain active after initiation. Defaults to 86400000 (24h) with a min of 14400000 (4h) and a max of 172800000 (48h).

field expires: Optional[StrictInt] = None

The timestamp when the session expires, measured in milliseconds since the UNIX epoch.

field opened: Optional[StrictInt] = None

The timestamp when the session opened, measured in milliseconds since the UNIX epoch.

field paths: Optional[ConstrainedListValue[SupportRemoteAssistSessionsPaths]] = None
field status: Optional[StrictStr] = None

The status of the remote assist session. Values include connected, connecting, disconnected, and session-active.

SupportRemoteAssistSessionsGetResponse

pydantic model pypureclient.flasharray.SupportRemoteAssistSessionsGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[SupportRemoteAssistSessions]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[SupportRemoteAssistSessions]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

SupportRemoteAssistSessionsPatch

pydantic model pypureclient.flasharray.SupportRemoteAssistSessionsPatch(*, access_level_override: Optional[StrictStr] = None, active: Optional[StrictBool] = None, duration: Optional[StrictInt] = None)
field access_level_override: Optional[StrictStr] = None

Overrides the default access level for the remote assist session only. Values include restricted and elevated. If not provided, the remote assist session will use the default_access_level setting.

field active: Optional[StrictBool] = None

The status of a remote assist session. If set to true, enables the remote assist session. If set to false, disables the remote assist session.

Constraints

  • type = boolean

field duration: Optional[StrictInt] = None

Specifies the duration of the remote assist session in milliseconds. This parameter should only be provided when establishing a new session. This parameter determines the length of time the session will remain active after initiation. Defaults to 86400000 (24h) with a min of 14400000 (4h) and a max of 172800000 (48h).

SupportRemoteAssistSessionsPaths

pydantic model pypureclient.flasharray.SupportRemoteAssistSessionsPaths(*, component_name: Optional[StrictStr] = None, status: Optional[StrictStr] = None)
field component_name: Optional[StrictStr] = None

The name of the local controller running the remote assist session.

field status: Optional[StrictStr] = None

The status of the remote assist session on the local controller. Values include connected, connecting, disconnected, and session-active.

SupportRemoteAssistSessionsResponse

pydantic model pypureclient.flasharray.SupportRemoteAssistSessionsResponse(*, items: Optional[ConstrainedListValue[SupportRemoteAssistSessions]] = None)
field items: Optional[ConstrainedListValue[SupportRemoteAssistSessions]] = None

SupportRemoteAssistSessionsSettings

pydantic model pypureclient.flasharray.SupportRemoteAssistSessionsSettings(*, default_access_level: Optional[StrictStr] = None)
field default_access_level: Optional[StrictStr] = None

The default access level that support will have when connecting to the array. Values include restricted and elevated.

SupportRemoteAssistSessionsSettingsGetResponse

pydantic model pypureclient.flasharray.SupportRemoteAssistSessionsSettingsGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[SupportRemoteAssistSessionsSettings]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[SupportRemoteAssistSessionsSettings]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

SupportRemoteAssistSessionsSettingsResponse

pydantic model pypureclient.flasharray.SupportRemoteAssistSessionsSettingsResponse(*, items: Optional[ConstrainedListValue[SupportRemoteAssistSessionsSettings]] = None)
field items: Optional[ConstrainedListValue[SupportRemoteAssistSessionsSettings]] = None

SupportResponse

pydantic model pypureclient.flasharray.SupportResponse(*, items: Optional[ConstrainedListValue[Support]] = None)
field items: Optional[ConstrainedListValue[Support]] = None

SyslogServer

pydantic model pypureclient.flasharray.SyslogServer(*, name: Optional[StrictStr] = None, context: Optional[FixedReference] = None, target_type: Optional[StrictStr] = None, services: Optional[ConstrainedListValue[StrictStr]] = None, uri: Optional[StrictStr] = None)
field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and cannot be changed.

field services: Optional[ConstrainedListValue[StrictStr]] = None

Valid values are data-audit and management. If not specified, defaults to management.

field target_type: Optional[StrictStr] = None

The type of log target. Valid values include file, and syslog.

field uri: Optional[StrictStr] = None

The URI of the syslog server in the format PROTOCOL://HOSTNAME:PORT.

SyslogServerGetResponse

pydantic model pypureclient.flasharray.SyslogServerGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[SyslogServer]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[SyslogServer]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

SyslogServerResponse

pydantic model pypureclient.flasharray.SyslogServerResponse(*, items: Optional[ConstrainedListValue[SyslogServer]] = None)
field items: Optional[ConstrainedListValue[SyslogServer]] = None

SyslogServerSettings

pydantic model pypureclient.flasharray.SyslogServerSettings(*, context: Optional[FixedReference] = None, ca_certificate: Optional[StrictStr] = None, logging_severity: Optional[StrictStr] = None, tls_audit_enabled: Optional[StrictBool] = None)

Global settings for syslog servers.

field ca_certificate: Optional[StrictStr] = None

The certificate of the certificate authority (CA) that signed the directory servers’ certificate(s), which is used to validate the authenticity of the configured servers.

field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field logging_severity: Optional[StrictStr] = None

Returns the configured logging severity threshold for which events will be forwarded to the configured syslog servers. Default configuration is info level severity. Valid values are debug, info, and notice.

field tls_audit_enabled: Optional[StrictBool] = None

Returns a value of true if messages that are necessary in order to audit TLS negotiations performed by the array are forwarded to the configured syslog servers.

Constraints

  • type = boolean

SyslogServerSettingsGetResponse

pydantic model pypureclient.flasharray.SyslogServerSettingsGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[SyslogServerSettings]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[SyslogServerSettings]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

SyslogServerSettingsResponse

pydantic model pypureclient.flasharray.SyslogServerSettingsResponse(*, items: Optional[ConstrainedListValue[SyslogServerSettings]] = None)
field items: Optional[ConstrainedListValue[SyslogServerSettings]] = None

Tag

pydantic model pypureclient.flasharray.Tag(*, context: Optional[FixedReference] = None, copyable: Optional[StrictBool] = None, key: Optional[StrictStr] = None, namespace: Optional[StrictStr] = None, resource: Optional[FixedReference] = None, value: Optional[StrictStr] = None)
field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field copyable: Optional[StrictBool] = None

Specifies whether or not to include the tag when copying the parent resource. If set to true, the tag is included in resource copying. If set to false, the tag is not included. If not specified, defaults to true.

Constraints

  • type = boolean

field key: Optional[StrictStr] = None

Key of the tag. Supports up to 64 Unicode characters.

field namespace: Optional[StrictStr] = None

Optional namespace of the tag. Namespace identifies the category of the tag. Omitting the namespace defaults to the namespace default. The pure&#42; namespaces are reserved for plugins and integration partners. It is recommended that customers avoid using reserved namespaces.

field resource: Optional[FixedReference] = None
field value: Optional[StrictStr] = None

Value of the tag. Supports up to 256 Unicode characters.

TagBatch

pydantic model pypureclient.flasharray.TagBatch(*, copyable: Optional[StrictBool] = None, key: Optional[StrictStr] = None, namespace: Optional[StrictStr] = None, resource: Optional[Reference] = None, value: Optional[StrictStr] = None)
field copyable: Optional[StrictBool] = None

Specifies whether or not to include the tag when copying the parent resource. If set to true, the tag is included in resource copying. If set to false, the tag is not included. If not specified, defaults to true.

Constraints

  • type = boolean

field key: Optional[StrictStr] = None

Key of the tag. Supports up to 64 Unicode characters.

field namespace: Optional[StrictStr] = None

Optional namespace of the tag. Namespace identifies the category of the tag. Omitting the namespace defaults to the namespace default. The pure&#42; namespaces are reserved for plugins and integration partners. It is recommended that customers avoid using reserved namespaces.

field resource: Optional[Reference] = None

A reference to the parent object.

field value: Optional[StrictStr] = None

Value of the tag. Supports up to 256 Unicode characters.

TagGetResponse

pydantic model pypureclient.flasharray.TagGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Tag]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[Tag]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

TagResponse

pydantic model pypureclient.flasharray.TagResponse(*, items: Optional[ConstrainedListValue[Tag]] = None)
field items: Optional[ConstrainedListValue[Tag]] = None

TargetProtectionGroup

pydantic model pypureclient.flasharray.TargetProtectionGroup(*, context: Optional[FixedReference] = None, allowed: Optional[StrictBool] = None, group: Optional[Reference] = None, member: Optional[ReferenceWithType] = None, status: Optional[StrictStr] = None)
field allowed: Optional[StrictBool] = None

If set to true, the target array or pod allows the source array to replicate protection group data to the target. If set to false, the target array or pod does not allow the source array to replicate protection group data to the target.

Constraints

  • type = boolean

field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field group: Optional[Reference] = None
field member: Optional[ReferenceWithType] = None
field status: Optional[StrictStr] = None

The replication status of the target. Valid values are replicating, suspended, and disallowed. If allowed is true and protection group data is replicating to the target, status will display replicating. If allowed is true, but replication is suspended due to the target being demoted, linked, stretched, etc., status will display suspended. Replication will be automatically resumed if the target becomes promoted or local only again. If allowed is false, status will display disallowed.

TargetProtectionGroupPostPatch

pydantic model pypureclient.flasharray.TargetProtectionGroupPostPatch(*, allowed: Optional[StrictBool] = None, protection_group: Optional[FixedReference] = None, target: Optional[FixedReferenceNoId] = None)
field allowed: Optional[StrictBool] = None

If set to true, the target array has allowed the source array to replicate protection group data to the target array. If set to false, the target array has not allowed the source array to replicate protection group data to the target.

Constraints

  • type = boolean

field protection_group: Optional[FixedReference] = None
field target: Optional[FixedReferenceNoId] = None

TestResult

pydantic model pypureclient.flasharray.TestResult(*, component_address: Optional[StrictStr] = None, component_name: Optional[StrictStr] = None, description: Optional[StrictStr] = None, destination: Optional[StrictStr] = None, enabled: Optional[StrictBool] = None, result_details: Optional[StrictStr] = None, success: Optional[StrictBool] = None, test_type: Optional[StrictStr] = None)
field component_address: Optional[StrictStr] = None

Address of the component running the test.

field component_name: Optional[StrictStr] = None

Name of the component running the test.

field description: Optional[StrictStr] = None

What the test is doing.

field destination: Optional[StrictStr] = None

The URI of the target server being tested.

field enabled: Optional[StrictBool] = None

Whether the object being tested is enabled or not. Returns a value of true if the the service is enabled. Returns a value of false if the service is disabled.

Constraints

  • type = boolean

field result_details: Optional[StrictStr] = None

Additional information about the test result.

field success: Optional[StrictBool] = None

Whether the object being tested passed the test or not. Returns a value of true if the specified test has succeeded. Returns a value of false if the specified test has failed.

Constraints

  • type = boolean

field test_type: Optional[StrictStr] = None

Displays the type of test being performed. The returned values are determined by the resource being tested and its configuration. Values include array-admin-group-searching, binding, connecting, phonehome, phonehome-ping, remote-assist, rootdse-searching, read-only-group-searching, storage-admin-group-searching, and validate-ntp-configuration.

TestResultGetResponse

pydantic model pypureclient.flasharray.TestResultGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[TestResult]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[TestResult]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

TestResultResponse

pydantic model pypureclient.flasharray.TestResultResponse(*, items: Optional[ConstrainedListValue[TestResult]] = None)
field items: Optional[ConstrainedListValue[TestResult]] = None

TestResultWithResource

pydantic model pypureclient.flasharray.TestResultWithResource(*, component_address: Optional[StrictStr] = None, component_name: Optional[StrictStr] = None, description: Optional[StrictStr] = None, destination: Optional[StrictStr] = None, enabled: Optional[StrictBool] = None, result_details: Optional[StrictStr] = None, success: Optional[StrictBool] = None, test_type: Optional[StrictStr] = None, context: Optional[FixedReference] = None, resource: Optional[FixedReferenceNoId] = None)
field component_address: Optional[StrictStr] = None

Address of the component running the test.

field component_name: Optional[StrictStr] = None

Name of the component running the test.

field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field description: Optional[StrictStr] = None

What the test is doing.

field destination: Optional[StrictStr] = None

The URI of the target server being tested.

field enabled: Optional[StrictBool] = None

Whether the object being tested is enabled or not. Returns a value of true if the the service is enabled. Returns a value of false if the service is disabled.

Constraints

  • type = boolean

field resource: Optional[FixedReferenceNoId] = None

A reference to the object being tested.

field result_details: Optional[StrictStr] = None

Additional information about the test result.

field success: Optional[StrictBool] = None

Whether the object being tested passed the test or not. Returns a value of true if the specified test has succeeded. Returns a value of false if the specified test has failed.

Constraints

  • type = boolean

field test_type: Optional[StrictStr] = None

Displays the type of test being performed. The returned values are determined by the resource being tested and its configuration. Values include array-admin-group-searching, binding, connecting, phonehome, phonehome-ping, remote-assist, rootdse-searching, read-only-group-searching, storage-admin-group-searching, and validate-ntp-configuration.

TestResultWithResourceGetResponse

pydantic model pypureclient.flasharray.TestResultWithResourceGetResponse(*, total_item_count: Optional[StrictInt] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None, items: Optional[ConstrainedListValue[TestResultWithResource]] = None)
field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[TestResultWithResource]] = None
field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

TestResultWithResourcePatchResponse

pydantic model pypureclient.flasharray.TestResultWithResourcePatchResponse(*, items: Optional[ConstrainedListValue[TestResultWithResource]] = None)
field items: Optional[ConstrainedListValue[TestResultWithResource]] = None

TestResultWithResourcePostResponse

pydantic model pypureclient.flasharray.TestResultWithResourcePostResponse(*, items: Optional[ConstrainedListValue[TestResultWithResource]] = None)
field items: Optional[ConstrainedListValue[TestResultWithResource]] = None

TestResultWithResourceResponse

pydantic model pypureclient.flasharray.TestResultWithResourceResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[TestResultWithResource]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[TestResultWithResource]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

TestResultWithResourceWithId

pydantic model pypureclient.flasharray.TestResultWithResourceWithId(*, component_address: Optional[StrictStr] = None, component_name: Optional[StrictStr] = None, description: Optional[StrictStr] = None, destination: Optional[StrictStr] = None, enabled: Optional[StrictBool] = None, result_details: Optional[StrictStr] = None, success: Optional[StrictBool] = None, test_type: Optional[StrictStr] = None, context: Optional[FixedReference] = None, resource: Optional[FixedReference] = None)
field component_address: Optional[StrictStr] = None

Address of the component running the test.

field component_name: Optional[StrictStr] = None

Name of the component running the test.

field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field description: Optional[StrictStr] = None

What the test is doing.

field destination: Optional[StrictStr] = None

The URI of the target server being tested.

field enabled: Optional[StrictBool] = None

Whether the object being tested is enabled or not. Returns a value of true if the the service is enabled. Returns a value of false if the service is disabled.

Constraints

  • type = boolean

field resource: Optional[FixedReference] = None

A reference to the object being tested.

field result_details: Optional[StrictStr] = None

Additional information about the test result.

field success: Optional[StrictBool] = None

Whether the object being tested passed the test or not. Returns a value of true if the specified test has succeeded. Returns a value of false if the specified test has failed.

Constraints

  • type = boolean

field test_type: Optional[StrictStr] = None

Displays the type of test being performed. The returned values are determined by the resource being tested and its configuration. Values include array-admin-group-searching, binding, connecting, phonehome, phonehome-ping, remote-assist, rootdse-searching, read-only-group-searching, storage-admin-group-searching, and validate-ntp-configuration.

TestResultWithResourceWithIdPostResponse

pydantic model pypureclient.flasharray.TestResultWithResourceWithIdPostResponse(*, items: Optional[ConstrainedListValue[TestResultWithResourceWithId]] = None)
field items: Optional[ConstrainedListValue[TestResultWithResourceWithId]] = None

Throttle

pydantic model pypureclient.flasharray.Throttle(*, default_limit: Optional[StrictInt] = None, window: Optional[TimeWindow] = None, window_limit: Optional[StrictInt] = None)

The bandwidth throttling for an array connection. Configurable on PATCH only.

field default_limit: Optional[StrictInt] = None

Default maximum bandwidth threshold for outbound traffic in bytes. Once exceeded, bandwidth throttling occurs.

field window: Optional[TimeWindow] = None

The time during which the window_limit threshold is in effect.

field window_limit: Optional[StrictInt] = None

Maximum bandwidth threshold for outbound traffic during the specified window_limit time range in bytes. Once exceeded, bandwidth throttling occurs.

ThrottleDeprecated

pydantic model pypureclient.flasharray.ThrottleDeprecated(*, default_limit: Optional[StrictInt] = None, window: Optional[TimeWindow] = None, window_limit: Optional[StrictInt] = None)
field default_limit: Optional[StrictInt] = None

Deprecated. Default maximum bandwidth threshold for outbound traffic in bytes. Once exceeded, bandwidth throttling occurs.

field window: Optional[TimeWindow] = None

Deprecated. The time during which the window_limit threshold is in effect.

field window_limit: Optional[StrictInt] = None

Deprecated. Maximum bandwidth threshold for outbound traffic during the specified window_limit time range in bytes. Once exceeded, bandwidth throttling occurs.

TimeWindow

pydantic model pypureclient.flasharray.TimeWindow(*, end: Optional[StrictInt] = None, start: Optional[StrictInt] = None)
field end: Optional[StrictInt] = None

The window end time. Measured in milliseconds since midnight. The time must be set on the hour. (e.g., 28800000, which is equal to 8:00 AM).

field start: Optional[StrictInt] = None

The window start time. Measured in milliseconds since midnight. The time must be set on the hour. (e.g., 18000000, which is equal to 5:00 AM).

TotalItemCountResponse

pydantic model pypureclient.flasharray.TotalItemCountResponse(*, total_item_count: Optional[StrictInt] = None)
field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

Transfer

pydantic model pypureclient.flasharray.Transfer(*, completed: Optional[StrictInt] = None, data_transferred: Optional[StrictInt] = None, destroyed: Optional[StrictBool] = None, physical_bytes_written: Optional[StrictInt] = None, progress: Optional[Union[StrictFloat, StrictInt]] = None, started: Optional[StrictInt] = None)
field completed: Optional[StrictInt] = None

The timestamp of when the snapshot replication process completed. Measured in milliseconds since the UNIX epoch.

field data_transferred: Optional[StrictInt] = None

The number of bytes transferred from the source to the target as part of the replication process. Measured in bytes.

field destroyed: Optional[StrictBool] = None

Returns a value of true if the snapshot has been destroyed and is pending eradication. The destroyed snapshot can be recovered by setting destroyed=false. Once the eradication pending period has elapsed, the snapshot is permanently eradicated and can no longer be recovered.

Constraints

  • type = boolean

field physical_bytes_written: Optional[StrictInt] = None

The amount of physical/logical data written to the target due to replication. Measured in bytes.

field progress: Optional[Union[StrictFloat, StrictInt]] = None

The percentage progress of the snapshot transfer from the source array to the target. Displayed in decimal format.

field started: Optional[StrictInt] = None

The timestamp of when the snapshot replication process started. Measured in milliseconds since the UNIX epoch.

UpgradeParameters

pydantic model pypureclient.flasharray.UpgradeParameters(*, name: Optional[StrictStr] = None, value: Optional[ConstrainedStrValue] = None)
field name: Optional[StrictStr] = None

The name of the upgrade parameter to be sent to the upgrade process.

field value: Optional[ConstrainedStrValue] = None

The value of the upgrade parameter to be sent to the upgrade process.

Constraints

  • maxLength = 1024

Username

pydantic model pypureclient.flasharray.Username(*, username: Optional[StrictStr] = None)
field username: Optional[StrictStr] = None

The username of the user.

UsernameResponse

pydantic model pypureclient.flasharray.UsernameResponse(*, items: Optional[ConstrainedListValue[Username]] = None)
field items: Optional[ConstrainedListValue[Username]] = None

Vchost

pydantic model pypureclient.flasharray.Vchost(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, vcuuid: Optional[StrictStr] = None)
field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

field vcuuid: Optional[StrictStr] = None

The vCenter Server uuid of the vchost.

VchostCertificate

pydantic model pypureclient.flasharray.VchostCertificate(*, certificate: Optional[ReferenceNoIdWithType] = None, endpoints: Optional[ConstrainedListValue[StrictStr]] = None, id: Optional[StrictStr] = None, is_local: Optional[StrictBool] = None, vchost: Optional[ReferenceWithType] = None)
field certificate: Optional[ReferenceNoIdWithType] = None

A reference to the certificate that will be presented to clients accessing the referenced vchost using any of the network addresses defined by endpoints.

field endpoints: Optional[ConstrainedListValue[StrictStr]] = None

The IPv4 or IPv6 addresses of the endpoints to configure for the vchost, over which the configured certificate will be presented.

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified.

field is_local: Optional[StrictBool] = None

Returns true if the vchost certificate is local to the array, and false otherwise.

Constraints

  • type = boolean

field vchost: Optional[ReferenceWithType] = None

The vchost by which the certificate is to be presented over the configured endpoints.

VchostCertificateGetResponse

pydantic model pypureclient.flasharray.VchostCertificateGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[VchostCertificate]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[VchostCertificate]] = None

Returns a list of all items after filtering. If applicable, the values are displayed for each name.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

VchostCertificatePatch

pydantic model pypureclient.flasharray.VchostCertificatePatch(*, endpoints: Optional[ConstrainedListValue[StrictStr]] = None)
field endpoints: Optional[ConstrainedListValue[StrictStr]] = None

The IPv4 or IPv6 addresses of the endpoints to configure for the vchost, over which the configured certificate will be presented.

VchostCertificatePost

pydantic model pypureclient.flasharray.VchostCertificatePost(*, certificate: Optional[ReferenceNoIdWithType] = None, endpoints: Optional[ConstrainedListValue[StrictStr]] = None)
field certificate: Optional[ReferenceNoIdWithType] = None

The certificate to be presented by the vchost over the configured endpoints.

field endpoints: Optional[ConstrainedListValue[StrictStr]] = None

The IPv4 or IPv6 addresses of the endpoints to configure for the vchost, over which the configured certificate will be presented.

VchostCertificateResponse

pydantic model pypureclient.flasharray.VchostCertificateResponse(*, items: Optional[ConstrainedListValue[VchostCertificate]] = None)
field items: Optional[ConstrainedListValue[VchostCertificate]] = None

Returns a list of all items after filtering. If applicable, the values are displayed for each name.

VchostConnection

pydantic model pypureclient.flasharray.VchostConnection(*, all_vchosts: Optional[StrictBool] = False, protocol_endpoint: Optional[FixedReference] = None, vchost: Optional[FixedReference] = None)
field all_vchosts: Optional[StrictBool] = False

If set to true, the storage container represented by the protocol endpoint is accessible to all vchosts. If set to false, the storage container represented by the protocol endpoint is only accesible to the vchosts that have explicit vchost-connections to this protocol endpoint. The default is false.

Constraints

  • type = boolean

field protocol_endpoint: Optional[FixedReference] = None

A reference to the protocol endpoint, representing a storage container that vCenter can use.

field vchost: Optional[FixedReference] = None

For vchost-connections, a vchost represents a vCenter. By connecting to a protocol endpoint, the corresponding vCenter gets the access to the storage container represented by this protocol endpoint. The vchost name should be null if all_vchosts is set to true, which means the storage container is accessible to all vchosts.

VchostConnectionGetResponse

pydantic model pypureclient.flasharray.VchostConnectionGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[VchostConnection]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[VchostConnection]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

VchostConnectionResponse

pydantic model pypureclient.flasharray.VchostConnectionResponse(*, items: Optional[ConstrainedListValue[VchostConnection]] = None)
field items: Optional[ConstrainedListValue[VchostConnection]] = None

VchostEndpoint

pydantic model pypureclient.flasharray.VchostEndpoint(*, certificates: Optional[ConstrainedListValue[ReferenceNoIdWithType]] = None, endpoint: Optional[StrictStr] = None, id: Optional[StrictStr] = None, is_local: Optional[StrictBool] = None, vchost: Optional[ReferenceWithType] = None)
field certificates: Optional[ConstrainedListValue[ReferenceNoIdWithType]] = None

The certificate to be presented by the vchost over the configured endpoints.

field endpoint: Optional[StrictStr] = None

The IPv4 or IPv6 address of the endpoint.

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified.

field is_local: Optional[StrictBool] = None

Returns true if the vchost endpoint is local to the array, and false otherwise.

Constraints

  • type = boolean

field vchost: Optional[ReferenceWithType] = None

The vchost for which this endpoint is to be configured.

VchostEndpointGetResponse

pydantic model pypureclient.flasharray.VchostEndpointGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[VchostEndpoint]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[VchostEndpoint]] = None

Returns a list of all items after filtering. If applicable, the values are displayed for each name.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

VchostEndpointPatch

pydantic model pypureclient.flasharray.VchostEndpointPatch(*, certificates: Optional[ConstrainedListValue[ReferenceNoIdWithType]] = None)
field certificates: Optional[ConstrainedListValue[ReferenceNoIdWithType]] = None

The certificate to be presented by the vchost over the configured endpoints.

VchostEndpointPost

pydantic model pypureclient.flasharray.VchostEndpointPost(*, certificates: Optional[ConstrainedListValue[ReferenceNoIdWithType]] = None, endpoint: Optional[StrictStr] = None)
field certificates: Optional[ConstrainedListValue[ReferenceNoIdWithType]] = None

The certificate to be presented by the vchost over the configured endpoints.

field endpoint: Optional[StrictStr] = None

The IPv4 or IPv6 address of the endpoint.

VchostEndpointResponse

pydantic model pypureclient.flasharray.VchostEndpointResponse(*, items: Optional[ConstrainedListValue[VchostEndpoint]] = None)
field items: Optional[ConstrainedListValue[VchostEndpoint]] = None

Returns a list of all items after filtering. If applicable, the values are displayed for each name.

VchostGetResponse

pydantic model pypureclient.flasharray.VchostGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Vchost]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[Vchost]] = None

Returns a list of all items after filtering. If applicable, the values are displayed for each name.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

VchostPatch

pydantic model pypureclient.flasharray.VchostPatch(*, name: Optional[StrictStr] = None)
field name: Optional[StrictStr] = None

The new name of the vchost.

VchostPost

pydantic model pypureclient.flasharray.VchostPost(*, vcuuid: Optional[StrictStr] = None)
field vcuuid: Optional[StrictStr] = None

The vCenter Server uuid of the vchost.

VchostResponse

pydantic model pypureclient.flasharray.VchostResponse(*, items: Optional[ConstrainedListValue[Vchost]] = None)
field items: Optional[ConstrainedListValue[Vchost]] = None

Returns a list of all items after filtering. If applicable, the values are displayed for each name.

VirtualMachine

pydantic model pypureclient.flasharray.VirtualMachine(*, created: Optional[StrictInt] = None, destroyed: Optional[StrictBool] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, recover_context: Optional[FixedReference] = None, time_remaining: Optional[StrictInt] = None, vm_id: Optional[StrictStr] = None, vm_type: Optional[StrictStr] = None)
field created: Optional[StrictInt] = None

The virtual machine creation time, measured in milliseconds since the UNIX epoch.

field destroyed: Optional[StrictBool] = None

Returns a value of true if the virtual machine has been destroyed and is pending eradication.

Constraints

  • type = boolean

field id: Optional[StrictStr] = None

The ID of the virtual machine to create or modify, as assigned by the external system. id is deprecated. Use vm_id instead.

field name: Optional[StrictStr] = None

The name of the virtual machine, as assigned by the external system

field recover_context: Optional[FixedReference] = None

A reference to any additional entities needed to recover this virtual machine.

field time_remaining: Optional[StrictInt] = None

The amount of time left until the destroyed volume is permanently eradicated, measured in milliseconds. Before the time_remaining period has elapsed, the destroyed volume can be recovered by setting destroyed=false.

field vm_id: Optional[StrictStr] = None

The ID of the virtual machine, as assigned by the external system.

field vm_type: Optional[StrictStr] = None

The type of virtual machine. The only valid value is vvol.

VirtualMachineGetResponse

pydantic model pypureclient.flasharray.VirtualMachineGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[VirtualMachine]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[VirtualMachine]] = None

Displays a list of all items after filtering. The values are displayed for each name if meaningful.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

VirtualMachinePost

pydantic model pypureclient.flasharray.VirtualMachinePost(*, id: Optional[StrictStr] = None, source: Optional[Reference] = None, vm_id: Optional[StrictStr] = None, vm_type: Optional[StrictStr] = None)
field id: Optional[StrictStr] = None

The ID of the virtual machine to create or modify, as assigned by the external system. id is deprecated. Use vm_id instead.

field source: Optional[Reference] = None

The recovery context for the virtual machine or virtual machine snapshot being modified.

field vm_id: Optional[StrictStr] = None

The ID of the virtual machine to create or modify, as assigned by the external system.

field vm_type: Optional[StrictStr] = None

The type of virtual machine. The only valid value is vvol.

VirtualMachineResponse

pydantic model pypureclient.flasharray.VirtualMachineResponse(*, items: Optional[ConstrainedListValue[VirtualMachine]] = None)
field items: Optional[ConstrainedListValue[VirtualMachine]] = None

Displays a list of all items after filtering. The values are displayed for each name if meaningful.

VirtualMachineVolumeSnapshot

pydantic model pypureclient.flasharray.VirtualMachineVolumeSnapshot(*, created: Optional[StrictInt] = None, destroyed: Optional[StrictBool] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, recover_context: Optional[FixedReference] = None, time_remaining: Optional[StrictInt] = None, vm_id: Optional[StrictStr] = None, vm_type: Optional[StrictStr] = None, vvol_name: Optional[StrictStr] = None, vvol_type: Optional[StrictStr] = None)
field created: Optional[StrictInt] = None

The virtual machine volume snapshot creation time measured in milliseconds since the UNIX epoch.

field destroyed: Optional[StrictBool] = None

Returns a value of true if the virtual machine volume snapshot has been destroyed and is pending eradication.

Constraints

  • type = boolean

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified.

field name: Optional[StrictStr] = None

The name of the virtual machine volume snapshot.

field recover_context: Optional[FixedReference] = None

A reference to any additional entities needed to recover this virtual machine.

field time_remaining: Optional[StrictInt] = None

Specifies the amount of time left until the destroyed volume snapshot is permanently eradicated, measured in milliseconds. Once the time_remaining period has elapsed, the volume snapshot is permanently eradicated and can no longer be recovered.

field vm_id: Optional[StrictStr] = None

The ID of the virtual machine, as assigned by the external system.

field vm_type: Optional[StrictStr] = None

The type of virtual machine. The only valid value is vvol.

field vvol_name: Optional[StrictStr] = None

The name of the virtual machine volume.

field vvol_type: Optional[StrictStr] = None

The type of virtual machine volume. Values include config and data.

VirtualMachineVolumeSnapshotResponse

pydantic model pypureclient.flasharray.VirtualMachineVolumeSnapshotResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[VirtualMachineVolumeSnapshot]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[VirtualMachineVolumeSnapshot]] = None

Displays a list of all items after filtering. The values are displayed for each name if meaningful.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

Volume

pydantic model pypureclient.flasharray.Volume(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, connection_count: Optional[StrictInt] = None, created: Optional[StrictInt] = None, destroyed: Optional[StrictBool] = None, host_encryption_key_status: Optional[StrictStr] = None, priority_adjustment: Optional[PriorityAdjustment] = None, provisioned: Optional[StrictInt] = None, qos: Optional[Qos] = None, serial: Optional[StrictStr] = None, space: Optional[VolumeSpaceCommon] = None, time_remaining: Optional[StrictInt] = None, context: Optional[FixedReference] = None, pod: Optional[Reference] = None, priority: Optional[StrictInt] = None, promotion_status: Optional[StrictStr] = None, protocol_endpoint: Optional[ProtocolEndpoint] = None, requested_promotion_state: Optional[StrictStr] = None, source: Optional[FixedReference] = None, subtype: Optional[StrictStr] = None, volume_group: Optional[Reference] = None, workload: Optional[WorkloadConfigurationReference] = None)
field connection_count: Optional[StrictInt] = None

The total number of hosts and host groups connected to the volume.

field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field created: Optional[StrictInt] = None

The volume creation time, measured in milliseconds since the UNIX epoch.

field destroyed: Optional[StrictBool] = None

Returns a value of true if the volume has been destroyed and is pending eradication. The time_remaining value displays the amount of time left until the destroyed volume is permanently eradicated. Before the time_remaining period has elapsed, the destroyed volume can be recovered by setting destroyed=false. Once the time_remaining period has elapsed, the volume is permanently eradicated and can no longer be recovered.

Constraints

  • type = boolean

field host_encryption_key_status: Optional[StrictStr] = None

The host encryption key status for this volume. Values include none, detected, and fetched.

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

field pod: Optional[Reference] = None

A reference to the pod.

field priority: Optional[StrictInt] = None

The current priority value. Priority is calculated by combining all applicable relative priority_adjustment values or taking the exact value if the volume has an absolute priority_adjustment (specified by an = priority_adjustment_operator).

field priority_adjustment: Optional[PriorityAdjustment] = None

Priority adjustment operator and value.

field promotion_status: Optional[StrictStr] = None

Current promotion status of a volume. Values include promoted and demoted. A status of promoted indicates that the volume has been promoted and can accept write requests from hosts. This is the default status for a volume when it is created. A status of demoted indicates that the volume has been demoted and no longer accepts write requests.

field protocol_endpoint: Optional[ProtocolEndpoint] = None

Properties that are specific to volumes of subtype=protocol_endpoint.

field provisioned: Optional[StrictInt] = None

The virtual size of the volume as a multiple of 512, measured in bytes. The maximum size is 4503599627370496 (4PB).

field qos: Optional[Qos] = None

Displays QoS limit information.

field requested_promotion_state: Optional[StrictStr] = None

Values include promoted and demoted. Patch requested_promotion_state to demoted to demote the volume so that the volume stops accepting write requests. Patch requested_promotion_state to promoted to promote the volume so that the volume starts accepting write requests.

field serial: Optional[StrictStr] = None

A globally unique serial number generated by the FlashArray when the volume is created.

field source: Optional[FixedReference] = None

A reference to the originating volume as a result of a volume copy.

field space: Optional[VolumeSpaceCommon] = None

Displays size and space consumption information.

field subtype: Optional[StrictStr] = None

The type of volume. Values include protocol_endpoint and regular.

field time_remaining: Optional[StrictInt] = None

The amount of time left until the destroyed volume is permanently eradicated, measured in milliseconds. Before the time_remaining period has elapsed, the destroyed volume can be recovered by setting destroyed=false.

field volume_group: Optional[Reference] = None

A reference to the volume group.

field workload: Optional[WorkloadConfigurationReference] = None

A reference to the workload that is managing this volume. The name may show as an empty string briefly after controller failover.

VolumeBatchPost

pydantic model pypureclient.flasharray.VolumeBatchPost(*, destroyed: Optional[StrictBool] = None, priority_adjustment: Optional[PriorityAdjustment] = None, protocol_endpoint: Optional[ProtocolEndpoint] = None, provisioned: Optional[ConstrainedIntValue] = None, qos: Optional[Qos] = None, source: Optional[Reference] = None, subtype: Optional[StrictStr] = None, tags: Optional[ConstrainedListValue[Tag]] = None, add_to_protection_groups: Optional[ConstrainedListValue[Reference]] = None, name: Optional[StrictStr] = None)
field add_to_protection_groups: Optional[ConstrainedListValue[Reference]] = None

Specifies a list of protection groups that will compose the initial protection for the volume.

field destroyed: Optional[StrictBool] = None

If set to true, destroys a resource. Once set to true, the time_remaining value will display the amount of time left until the destroyed resource is permanently eradicated. Before the time_remaining period has elapsed, the destroyed resource can be recovered by setting destroyed=false. Once the time_remaining period has elapsed, the resource is permanently eradicated and can no longer be recovered.

Constraints

  • type = boolean

field name: Optional[StrictStr] = None

Specifies the name of the volume.

field priority_adjustment: Optional[PriorityAdjustment] = None

Adjusts volume priority.

field protocol_endpoint: Optional[ProtocolEndpoint] = None

Sets the properties that are specific to protocol endpoints. This can only be used in conjunction to subtype=protocol_endpoint.

field provisioned: Optional[ConstrainedIntValue] = None

Sets the virtual size of the volume, measured in bytes.

Constraints

  • maximum = 4503599627370496

field qos: Optional[Qos] = None

Sets QoS limits.

field source: Optional[Reference] = None

The source volume of a volume copy.

field subtype: Optional[StrictStr] = None

The type of volume. Valid values are protocol_endpoint and regular.

field tags: Optional[ConstrainedListValue[Tag]] = None

The list of tags to be upserted with the object.

VolumeCommon

pydantic model pypureclient.flasharray.VolumeCommon(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, connection_count: Optional[StrictInt] = None, created: Optional[StrictInt] = None, destroyed: Optional[StrictBool] = None, host_encryption_key_status: Optional[StrictStr] = None, priority_adjustment: Optional[PriorityAdjustment] = None, provisioned: Optional[StrictInt] = None, qos: Optional[Qos] = None, serial: Optional[StrictStr] = None, space: Optional[VolumeSpaceCommon] = None, time_remaining: Optional[StrictInt] = None)
field connection_count: Optional[StrictInt] = None

The total number of hosts and host groups connected to the volume.

field created: Optional[StrictInt] = None

The volume creation time, measured in milliseconds since the UNIX epoch.

field destroyed: Optional[StrictBool] = None

Returns a value of true if the volume has been destroyed and is pending eradication. The time_remaining value displays the amount of time left until the destroyed volume is permanently eradicated. Before the time_remaining period has elapsed, the destroyed volume can be recovered by setting destroyed=false. Once the time_remaining period has elapsed, the volume is permanently eradicated and can no longer be recovered.

Constraints

  • type = boolean

field host_encryption_key_status: Optional[StrictStr] = None

The host encryption key status for this volume. Values include none, detected, and fetched.

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

field priority_adjustment: Optional[PriorityAdjustment] = None

Priority adjustment operator and value.

field provisioned: Optional[StrictInt] = None

The virtual size of the volume as a multiple of 512, measured in bytes. The maximum size is 4503599627370496 (4PB).

field qos: Optional[Qos] = None

Displays QoS limit information.

field serial: Optional[StrictStr] = None

A globally unique serial number generated by the FlashArray when the volume is created.

field space: Optional[VolumeSpaceCommon] = None

Displays size and space consumption information.

field time_remaining: Optional[StrictInt] = None

The amount of time left until the destroyed volume is permanently eradicated, measured in milliseconds. Before the time_remaining period has elapsed, the destroyed volume can be recovered by setting destroyed=false.

VolumeDiff

pydantic model pypureclient.flasharray.VolumeDiff(*, context: Optional[FixedReference] = None, length: Optional[StrictInt] = None, offset: Optional[StrictInt] = None)
field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field length: Optional[StrictInt] = None

Length of the chunk that is different, in bytes.

field offset: Optional[StrictInt] = None

Absolute offset of the chunk that is different, in bytes.

VolumeGetResponse

pydantic model pypureclient.flasharray.VolumeGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[Volume]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None, total: Optional[ConstrainedListValue[Volume]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[Volume]] = None

Displays a list of all items after filtering. If applicable, the values are displayed for each name. If total_only=true, the items list is empty.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total: Optional[ConstrainedListValue[Volume]] = None

The aggregate value of all items after filtering. If applicable, the average value is displayed instead. If applicable, the values are displayed for each field.

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

VolumeGroup

pydantic model pypureclient.flasharray.VolumeGroup(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, context: Optional[FixedReference] = None, workload: Optional[WorkloadConfigurationFixedReferenceWorkload] = None, destroyed: Optional[StrictBool] = None, pod: Optional[Reference] = None, priority_adjustment: Optional[PriorityAdjustment] = None, qos: Optional[Qos] = None, space: Optional[Space] = None, time_remaining: Optional[StrictInt] = None, volume_count: Optional[StrictInt] = None)
field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field destroyed: Optional[StrictBool] = None

Returns a value of true if the volume group has been destroyed and is pending eradication. Before the time_remaining period has elapsed, the destroyed volume group can be recovered by setting destroyed=false. After the time_remaining period has elapsed, the volume group is permanently eradicated and cannot be recovered.

Constraints

  • type = boolean

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

field pod: Optional[Reference] = None

A reference to the pod.

field priority_adjustment: Optional[PriorityAdjustment] = None
field qos: Optional[Qos] = None
field space: Optional[Space] = None
field time_remaining: Optional[StrictInt] = None

The amount of time left until the destroyed volume group is permanently eradicated, measured in milliseconds.

field volume_count: Optional[StrictInt] = None

The number of volumes in the volume group.

field workload: Optional[WorkloadConfigurationFixedReferenceWorkload] = None

VolumeGroupGetResponse

pydantic model pypureclient.flasharray.VolumeGroupGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[VolumeGroup]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None, total: Optional[ConstrainedListValue[VolumeGroup]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[VolumeGroup]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total: Optional[ConstrainedListValue[VolumeGroup]] = None

The aggregate value of all items after filtering. Where meaningful, the average value is displayed instead. If applicable, the values are displayed for each field.

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

VolumeGroupPatch

pydantic model pypureclient.flasharray.VolumeGroupPatch(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, priority_adjustment: Optional[PriorityAdjustment] = None, qos: Optional[Qos] = None, space: Optional[Space] = None)
field destroyed: Optional[StrictBool] = None

Returns a value of true if the volume group has been destroyed and is pending eradication. Before the time_remaining period has elapsed, the destroyed volume group can be recovered by setting destroyed=false. After the time_remaining period has elapsed, the volume group is permanently eradicated and cannot be recovered.

Constraints

  • type = boolean

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

field priority_adjustment: Optional[PriorityAdjustment] = None
field qos: Optional[Qos] = None
field space: Optional[Space] = None

VolumeGroupPerformance

pydantic model pypureclient.flasharray.VolumeGroupPerformance(*, bytes_per_mirrored_write: Optional[ConstrainedIntValue] = None, bytes_per_op: Optional[ConstrainedIntValue] = None, bytes_per_read: Optional[ConstrainedIntValue] = None, bytes_per_write: Optional[ConstrainedIntValue] = None, mirrored_write_bytes_per_sec: Optional[ConstrainedIntValue] = None, mirrored_writes_per_sec: Optional[ConstrainedIntValue] = None, qos_rate_limit_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None, qos_rate_limit_usec_per_read_op: Optional[ConstrainedIntValue] = None, qos_rate_limit_usec_per_write_op: Optional[ConstrainedIntValue] = None, queue_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None, queue_usec_per_read_op: Optional[ConstrainedIntValue] = None, queue_usec_per_write_op: Optional[ConstrainedIntValue] = None, read_bytes_per_sec: Optional[ConstrainedIntValue] = None, reads_per_sec: Optional[ConstrainedIntValue] = None, san_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None, san_usec_per_read_op: Optional[ConstrainedIntValue] = None, san_usec_per_write_op: Optional[ConstrainedIntValue] = None, service_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None, service_usec_per_read_op: Optional[ConstrainedIntValue] = None, service_usec_per_read_op_cache_reduction: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, service_usec_per_write_op: Optional[ConstrainedIntValue] = None, time: Optional[StrictInt] = None, usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None, usec_per_read_op: Optional[ConstrainedIntValue] = None, usec_per_write_op: Optional[ConstrainedIntValue] = None, write_bytes_per_sec: Optional[ConstrainedIntValue] = None, writes_per_sec: Optional[ConstrainedIntValue] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None)
field bytes_per_mirrored_write: Optional[ConstrainedIntValue] = None

The average I/O size per mirrored write, measured in bytes.

Constraints

  • minimum = 0

field bytes_per_op: Optional[ConstrainedIntValue] = None

The average I/O size for both read and write (all) operations.

Constraints

  • minimum = 0

field bytes_per_read: Optional[ConstrainedIntValue] = None

The average I/O size per read, measured in bytes.

Constraints

  • minimum = 0

field bytes_per_write: Optional[ConstrainedIntValue] = None

The average I/O size per write, measured in bytes.

Constraints

  • minimum = 0

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field mirrored_write_bytes_per_sec: Optional[ConstrainedIntValue] = None

The number of mirrored bytes written per second.

Constraints

  • minimum = 0

field mirrored_writes_per_sec: Optional[ConstrainedIntValue] = None

The number of mirrored writes per second.

Constraints

  • minimum = 0

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

field qos_rate_limit_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None

The average time it takes the array to process a mirrored I/O write request, measured in microseconds.

Constraints

  • minimum = 0

field qos_rate_limit_usec_per_read_op: Optional[ConstrainedIntValue] = None

The average time spent waiting due to QoS rate limiting for a read request, measured in microseconds.

Constraints

  • minimum = 0

field qos_rate_limit_usec_per_write_op: Optional[ConstrainedIntValue] = None

The average time that a write I/O request spends waiting as a result of the volume reaching its QoS bandwidth limit, measured in microseconds.

Constraints

  • minimum = 0

field queue_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None

The average time that a mirrored write I/O request spends in the array waiting to be served, measured in microseconds.

Constraints

  • minimum = 0

field queue_usec_per_read_op: Optional[ConstrainedIntValue] = None

The average time that a read I/O request spends in the array waiting to be served, measured in microseconds.

Constraints

  • minimum = 0

field queue_usec_per_write_op: Optional[ConstrainedIntValue] = None

The average time that a write I/O request spends in the array waiting to be served, measured in microseconds.

Constraints

  • minimum = 0

field read_bytes_per_sec: Optional[ConstrainedIntValue] = None

The number of bytes read per second.

Constraints

  • minimum = 0

field reads_per_sec: Optional[ConstrainedIntValue] = None

The number of read requests processed per second.

Constraints

  • minimum = 0

field san_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None

The average time required to transfer data from the initiator to the array for a mirrored write request, measured in microseconds.

Constraints

  • minimum = 0

field san_usec_per_read_op: Optional[ConstrainedIntValue] = None

The average time required to transfer data from the array to the initiator for a read request, measured in microseconds.

Constraints

  • minimum = 0

field san_usec_per_write_op: Optional[ConstrainedIntValue] = None

The average time required to transfer data from the initiator to the array for a write request, measured in microseconds.

Constraints

  • minimum = 0

field service_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None

The average time required for the array to service a mirrored write request, measured in microseconds.

Constraints

  • minimum = 0

field service_usec_per_read_op: Optional[ConstrainedIntValue] = None

The average time required for the array to service a read request, measured in microseconds.

Constraints

  • minimum = 0

field service_usec_per_read_op_cache_reduction: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

The percentage reduction in service_usec_per_read_op due to data cache hits. For example, a value of 0.25 indicates that the value of service_usec_per_read_op is 25&#37; lower than it would have been without any data cache hits.

field service_usec_per_write_op: Optional[ConstrainedIntValue] = None

The average time required for the array to service a write request, measured in microseconds.

Constraints

  • minimum = 0

field time: Optional[StrictInt] = None

The time when the sample performance data was taken, measured in milliseconds since the UNIX epoch.

field usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None

The average time it takes the array to process a mirrored I/O write request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.

Constraints

  • minimum = 0

field usec_per_read_op: Optional[ConstrainedIntValue] = None

The average time it takes the array to process an I/O read request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.

Constraints

  • minimum = 0

field usec_per_write_op: Optional[ConstrainedIntValue] = None

The average time it takes the array to process an I/O write request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.

Constraints

  • minimum = 0

field write_bytes_per_sec: Optional[ConstrainedIntValue] = None

The number of bytes written per second.

Constraints

  • minimum = 0

field writes_per_sec: Optional[ConstrainedIntValue] = None

The number of write requests processed per second.

Constraints

  • minimum = 0

VolumeGroupPost

pydantic model pypureclient.flasharray.VolumeGroupPost(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, priority_adjustment: Optional[PriorityAdjustment] = None, qos: Optional[Qos] = None, space: Optional[Space] = None, tags: Optional[ConstrainedListValue[Tag]] = None, time_remaining: Optional[StrictInt] = None, volume_count: Optional[StrictInt] = None)
field destroyed: Optional[StrictBool] = None

If set to true, destroys a volume group. If set to false, recovers a destroyed volume group. If not specified, defaults to false.

Constraints

  • type = boolean

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

field priority_adjustment: Optional[PriorityAdjustment] = None
field qos: Optional[Qos] = None
field space: Optional[Space] = None
field tags: Optional[ConstrainedListValue[Tag]] = None

The list of tags to be upserted with the object.

field time_remaining: Optional[StrictInt] = None

The amount of time left until the destroyed volume group is permanently eradicated, measured in milliseconds.

field volume_count: Optional[StrictInt] = None

The number of volumes in the volume group.

VolumeGroupResponse

pydantic model pypureclient.flasharray.VolumeGroupResponse(*, items: Optional[ConstrainedListValue[VolumeGroup]] = None)
field items: Optional[ConstrainedListValue[VolumeGroup]] = None

VolumePatch

pydantic model pypureclient.flasharray.VolumePatch(*, destroyed: Optional[StrictBool] = None, name: Optional[StrictStr] = None, pod: Optional[Reference] = None, priority_adjustment: Optional[PriorityAdjustment] = None, protocol_endpoint: Optional[ProtocolEndpoint] = None, provisioned: Optional[ConstrainedIntValue] = None, qos: Optional[Qos] = None, requested_promotion_state: Optional[StrictStr] = None, volume_group: Optional[Reference] = None, workload: Optional[ReferenceWithFixedType] = None)
field destroyed: Optional[StrictBool] = None

If set to true, destroys a resource. Once set to true, the time_remaining value will display the amount of time left until the destroyed resource is permanently eradicated. Before the time_remaining period has elapsed, the destroyed resource can be recovered by setting destroyed=false. Once the time_remaining period has elapsed, the resource is permanently eradicated and can no longer be recovered.

Constraints

  • type = boolean

field name: Optional[StrictStr] = None

The new name for the resource.

field pod: Optional[Reference] = None

Moves the volume into the specified pod.

field priority_adjustment: Optional[PriorityAdjustment] = None

Adjusts volume priority.

field protocol_endpoint: Optional[ProtocolEndpoint] = None

Sets the properties that are specific to protocol endpoints. This can only be used in conjunction to subtype=protocol_endpoint.

field provisioned: Optional[ConstrainedIntValue] = None

Updates the virtual size of the volume, measured in bytes.

Constraints

  • maximum = 4503599627370496

field qos: Optional[Qos] = None

Sets QoS limits.

field requested_promotion_state: Optional[StrictStr] = None

Valid values are promoted and demoted. Patch requested_promotion_state to demoted to demote the volume so that the volume stops accepting write requests. Patch requested_promotion_state to promoted to promote the volume so that the volume starts accepting write requests.

field volume_group: Optional[Reference] = None

Adds the volume to the specified volume group.

field workload: Optional[ReferenceWithFixedType] = None

Set the id or name of the workload to an empty string to remove the volume from the workload.

VolumePerformance

pydantic model pypureclient.flasharray.VolumePerformance(*, bytes_per_mirrored_write: Optional[ConstrainedIntValue] = None, bytes_per_op: Optional[ConstrainedIntValue] = None, bytes_per_read: Optional[ConstrainedIntValue] = None, bytes_per_write: Optional[ConstrainedIntValue] = None, mirrored_write_bytes_per_sec: Optional[ConstrainedIntValue] = None, mirrored_writes_per_sec: Optional[ConstrainedIntValue] = None, qos_rate_limit_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None, qos_rate_limit_usec_per_read_op: Optional[ConstrainedIntValue] = None, qos_rate_limit_usec_per_write_op: Optional[ConstrainedIntValue] = None, queue_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None, queue_usec_per_read_op: Optional[ConstrainedIntValue] = None, queue_usec_per_write_op: Optional[ConstrainedIntValue] = None, read_bytes_per_sec: Optional[ConstrainedIntValue] = None, reads_per_sec: Optional[ConstrainedIntValue] = None, san_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None, san_usec_per_read_op: Optional[ConstrainedIntValue] = None, san_usec_per_write_op: Optional[ConstrainedIntValue] = None, service_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None, service_usec_per_read_op: Optional[ConstrainedIntValue] = None, service_usec_per_read_op_cache_reduction: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, service_usec_per_write_op: Optional[ConstrainedIntValue] = None, time: Optional[StrictInt] = None, usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None, usec_per_read_op: Optional[ConstrainedIntValue] = None, usec_per_write_op: Optional[ConstrainedIntValue] = None, write_bytes_per_sec: Optional[ConstrainedIntValue] = None, writes_per_sec: Optional[ConstrainedIntValue] = None, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None)
field bytes_per_mirrored_write: Optional[ConstrainedIntValue] = None

The average I/O size per mirrored write, measured in bytes.

Constraints

  • minimum = 0

field bytes_per_op: Optional[ConstrainedIntValue] = None

The average I/O size for both read and write (all) operations.

Constraints

  • minimum = 0

field bytes_per_read: Optional[ConstrainedIntValue] = None

The average I/O size per read, measured in bytes.

Constraints

  • minimum = 0

field bytes_per_write: Optional[ConstrainedIntValue] = None

The average I/O size per write, measured in bytes.

Constraints

  • minimum = 0

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field mirrored_write_bytes_per_sec: Optional[ConstrainedIntValue] = None

The number of mirrored bytes written per second.

Constraints

  • minimum = 0

field mirrored_writes_per_sec: Optional[ConstrainedIntValue] = None

The number of mirrored writes per second.

Constraints

  • minimum = 0

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

field qos_rate_limit_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None

The average time it takes the array to process a mirrored I/O write request, measured in microseconds.

Constraints

  • minimum = 0

field qos_rate_limit_usec_per_read_op: Optional[ConstrainedIntValue] = None

The average time spent waiting due to QoS rate limiting for a read request, measured in microseconds.

Constraints

  • minimum = 0

field qos_rate_limit_usec_per_write_op: Optional[ConstrainedIntValue] = None

The average time that a write I/O request spends waiting as a result of the volume reaching its QoS bandwidth limit, measured in microseconds.

Constraints

  • minimum = 0

field queue_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None

The average time that a mirrored write I/O request spends in the array waiting to be served, measured in microseconds.

Constraints

  • minimum = 0

field queue_usec_per_read_op: Optional[ConstrainedIntValue] = None

The average time that a read I/O request spends in the array waiting to be served, measured in microseconds.

Constraints

  • minimum = 0

field queue_usec_per_write_op: Optional[ConstrainedIntValue] = None

The average time that a write I/O request spends in the array waiting to be served, measured in microseconds.

Constraints

  • minimum = 0

field read_bytes_per_sec: Optional[ConstrainedIntValue] = None

The number of bytes read per second.

Constraints

  • minimum = 0

field reads_per_sec: Optional[ConstrainedIntValue] = None

The number of read requests processed per second.

Constraints

  • minimum = 0

field san_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None

The average time required to transfer data from the initiator to the array for a mirrored write request, measured in microseconds.

Constraints

  • minimum = 0

field san_usec_per_read_op: Optional[ConstrainedIntValue] = None

The average time required to transfer data from the array to the initiator for a read request, measured in microseconds.

Constraints

  • minimum = 0

field san_usec_per_write_op: Optional[ConstrainedIntValue] = None

The average time required to transfer data from the initiator to the array for a write request, measured in microseconds.

Constraints

  • minimum = 0

field service_usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None

The average time required for the array to service a mirrored write request, measured in microseconds.

Constraints

  • minimum = 0

field service_usec_per_read_op: Optional[ConstrainedIntValue] = None

The average time required for the array to service a read request, measured in microseconds.

Constraints

  • minimum = 0

field service_usec_per_read_op_cache_reduction: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

The percentage reduction in service_usec_per_read_op due to data cache hits. For example, a value of 0.25 indicates that the value of service_usec_per_read_op is 25&#37; lower than it would have been without any data cache hits.

field service_usec_per_write_op: Optional[ConstrainedIntValue] = None

The average time required for the array to service a write request, measured in microseconds.

Constraints

  • minimum = 0

field time: Optional[StrictInt] = None

The time when the sample performance data was taken, measured in milliseconds since the UNIX epoch.

field usec_per_mirrored_write_op: Optional[ConstrainedIntValue] = None

The average time it takes the array to process a mirrored I/O write request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.

Constraints

  • minimum = 0

field usec_per_read_op: Optional[ConstrainedIntValue] = None

The average time it takes the array to process an I/O read request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.

Constraints

  • minimum = 0

field usec_per_write_op: Optional[ConstrainedIntValue] = None

The average time it takes the array to process an I/O write request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time.

Constraints

  • minimum = 0

field write_bytes_per_sec: Optional[ConstrainedIntValue] = None

The number of bytes written per second.

Constraints

  • minimum = 0

field writes_per_sec: Optional[ConstrainedIntValue] = None

The number of write requests processed per second.

Constraints

  • minimum = 0

VolumePost

pydantic model pypureclient.flasharray.VolumePost(*, destroyed: Optional[StrictBool] = None, priority_adjustment: Optional[PriorityAdjustment] = None, protocol_endpoint: Optional[ProtocolEndpoint] = None, provisioned: Optional[ConstrainedIntValue] = None, qos: Optional[Qos] = None, source: Optional[Reference] = None, subtype: Optional[StrictStr] = None, tags: Optional[ConstrainedListValue[Tag]] = None, workload: Optional[WorkloadConfigurationReference] = None)
field destroyed: Optional[StrictBool] = None

If set to true, destroys a resource. Once set to true, the time_remaining value will display the amount of time left until the destroyed resource is permanently eradicated. Before the time_remaining period has elapsed, the destroyed resource can be recovered by setting destroyed=false. Once the time_remaining period has elapsed, the resource is permanently eradicated and can no longer be recovered.

Constraints

  • type = boolean

field priority_adjustment: Optional[PriorityAdjustment] = None

Adjusts volume priority.

field protocol_endpoint: Optional[ProtocolEndpoint] = None

Sets the properties that are specific to protocol endpoints. This can only be used in conjunction to subtype=protocol_endpoint.

field provisioned: Optional[ConstrainedIntValue] = None

Sets the virtual size of the volume, measured in bytes.

Constraints

  • maximum = 4503599627370496

field qos: Optional[Qos] = None

Sets QoS limits.

field source: Optional[Reference] = None

The source volume of a volume copy.

field subtype: Optional[StrictStr] = None

The type of volume. Valid values are protocol_endpoint and regular.

field tags: Optional[ConstrainedListValue[Tag]] = None

The list of tags to be upserted with the object.

field workload: Optional[WorkloadConfigurationReference] = None

The workload to which the volume is added. Set one of id or name, and configuration to add the volume to the workload and configure it based on the configuration from the preset the workload was originally provisioned from.

VolumePostBase

pydantic model pypureclient.flasharray.VolumePostBase(*, destroyed: Optional[StrictBool] = None, priority_adjustment: Optional[PriorityAdjustment] = None, protocol_endpoint: Optional[ProtocolEndpoint] = None, provisioned: Optional[ConstrainedIntValue] = None, qos: Optional[Qos] = None, source: Optional[Reference] = None, subtype: Optional[StrictStr] = None, tags: Optional[ConstrainedListValue[Tag]] = None)
field destroyed: Optional[StrictBool] = None

If set to true, destroys a resource. Once set to true, the time_remaining value will display the amount of time left until the destroyed resource is permanently eradicated. Before the time_remaining period has elapsed, the destroyed resource can be recovered by setting destroyed=false. Once the time_remaining period has elapsed, the resource is permanently eradicated and can no longer be recovered.

Constraints

  • type = boolean

field priority_adjustment: Optional[PriorityAdjustment] = None

Adjusts volume priority.

field protocol_endpoint: Optional[ProtocolEndpoint] = None

Sets the properties that are specific to protocol endpoints. This can only be used in conjunction to subtype=protocol_endpoint.

field provisioned: Optional[ConstrainedIntValue] = None

Sets the virtual size of the volume, measured in bytes.

Constraints

  • maximum = 4503599627370496

field qos: Optional[Qos] = None

Sets QoS limits.

field source: Optional[Reference] = None

The source volume of a volume copy.

field subtype: Optional[StrictStr] = None

The type of volume. Valid values are protocol_endpoint and regular.

field tags: Optional[ConstrainedListValue[Tag]] = None

The list of tags to be upserted with the object.

VolumeResponse

pydantic model pypureclient.flasharray.VolumeResponse(*, items: Optional[ConstrainedListValue[Volume]] = None)
field items: Optional[ConstrainedListValue[Volume]] = None

Displays a list of all items after filtering. If applicable, the values are displayed for each name. If total_only=true, the items list is empty.

VolumeSnapshot

pydantic model pypureclient.flasharray.VolumeSnapshot(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, created: Optional[StrictInt] = None, destroyed: Optional[StrictBool] = None, pod: Optional[FixedReference] = None, provisioned: Optional[StrictInt] = None, source: Optional[FixedReference] = None, suffix: Optional[StrictStr] = None, time_remaining: Optional[StrictInt] = None, context: Optional[FixedReference] = None, serial: Optional[StrictStr] = None, space: Optional[SnapshotSpace] = None, volume_group: Optional[FixedReference] = None)
field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field created: Optional[StrictInt] = None

The snapshot creation time. Measured in milliseconds since the UNIX epoch.

field destroyed: Optional[StrictBool] = None

Returns a value of true if the snapshot has been destroyed and is pending eradication. The time_remaining value displays the amount of time left until the destroyed volume snapshot is permanently eradicated. Before the time_remaining period has elapsed, the destroyed volume snapshot can be recovered by setting destroyed=false. Once the time_remaining period has elapsed, the volume snapshot is permanently eradicated and can no longer be recovered.

Constraints

  • type = boolean

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

field pod: Optional[FixedReference] = None

A reference to the pod.

field provisioned: Optional[StrictInt] = None

The provisioned space of the snapshot. Measured in bytes. The minimum size is 1048576 (1MB), the maximum size is 4503599627370496 (4PB)

field serial: Optional[StrictStr] = None

A serial number generated by the system when the snapshot is created. The serial number is unique across all arrays.

field source: Optional[FixedReference] = None

The volume from which this snapshot was taken. For a replicated snapshot being viewed on the target side, the source is the replica volume.

field space: Optional[SnapshotSpace] = None

Displays size and space consumption information.

field suffix: Optional[StrictStr] = None

The suffix that is appended to the source_name value to generate the full volume snapshot name in the form VOL.SUFFIX. If the suffix is not specified, the system constructs the snapshot name in the form VOL.NNN, where VOL is the volume name, and NNN is a monotonically increasing number.

field time_remaining: Optional[StrictInt] = None

The amount of time left until the destroyed snapshot is permanently eradicated. Measured in milliseconds. Before the time_remaining period has elapsed, the destroyed snapshot can be recovered by setting destroyed=false.

field volume_group: Optional[FixedReference] = None

The volume group to which the volume that is the source of the volume snapshot belongs.

VolumeSnapshotGetResponse

pydantic model pypureclient.flasharray.VolumeSnapshotGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[VolumeSnapshot]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None, total: Optional[ConstrainedListValue[VolumeSnapshot]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[VolumeSnapshot]] = None

Displays a list of all items after filtering. If applicable, the values are displayed for each name. If total_only=true, the items list will be empty.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total: Optional[ConstrainedListValue[VolumeSnapshot]] = None

The aggregate value of all items after filtering. Where meaningful, the average value is displayed instead. If applicable, the values are displayed for each field.

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

VolumeSnapshotPatch

pydantic model pypureclient.flasharray.VolumeSnapshotPatch(*, destroyed: Optional[StrictBool] = None, name: Optional[StrictStr] = None)
field destroyed: Optional[StrictBool] = None

If set to true, destroys a resource. Once set to true, the time_remaining value will display the amount of time left until the destroyed resource is permanently eradicated. Before the time_remaining period has elapsed, the destroyed resource can be recovered by setting destroyed=false. Once the time_remaining period has elapsed, the resource is permanently eradicated and can no longer be recovered.

Constraints

  • type = boolean

field name: Optional[StrictStr] = None

The new name for the resource.

VolumeSnapshotPost

pydantic model pypureclient.flasharray.VolumeSnapshotPost(*, destroyed: Optional[StrictBool] = None, suffix: Optional[StrictStr] = None)
field destroyed: Optional[StrictBool] = None

If set to true, destroys a resource. Once set to true, the time_remaining value will display the amount of time left until the destroyed resource is permanently eradicated. Before the time_remaining period has elapsed, the destroyed resource can be recovered by setting destroyed=false. Once the time_remaining period has elapsed, the resource is permanently eradicated and can no longer be recovered.

Constraints

  • type = boolean

field suffix: Optional[StrictStr] = None

The suffix that is appended to the source_name value to generate the full volume snapshot name in the form VOL.SUFFIX. If the suffix is not specified, the system constructs the snapshot name in the form VOL.NNN, where VOL is the volume name, and NNN is a monotonically increasing number.

VolumeSnapshotResponse

pydantic model pypureclient.flasharray.VolumeSnapshotResponse(*, items: Optional[ConstrainedListValue[VolumeSnapshot]] = None)
field items: Optional[ConstrainedListValue[VolumeSnapshot]] = None

Displays a list of all items after filtering. If applicable, the values are displayed for each name. If total_only=true, the items list will be empty.

VolumeSnapshotTransfer

pydantic model pypureclient.flasharray.VolumeSnapshotTransfer(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, completed: Optional[StrictInt] = None, data_transferred: Optional[StrictInt] = None, destroyed: Optional[StrictBool] = None, physical_bytes_written: Optional[StrictInt] = None, progress: Optional[Union[StrictFloat, StrictInt]] = None, started: Optional[StrictInt] = None, context: Optional[FixedReference] = None)
field completed: Optional[StrictInt] = None

The timestamp of when the snapshot replication process completed. Measured in milliseconds since the UNIX epoch.

field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field data_transferred: Optional[StrictInt] = None

The number of bytes transferred from the source to the target as part of the replication process. Measured in bytes.

field destroyed: Optional[StrictBool] = None

Returns a value of true if the snapshot has been destroyed and is pending eradication. The destroyed snapshot can be recovered by setting destroyed=false. Once the eradication pending period has elapsed, the snapshot is permanently eradicated and can no longer be recovered.

Constraints

  • type = boolean

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

field physical_bytes_written: Optional[StrictInt] = None

The amount of physical/logical data written to the target due to replication. Measured in bytes.

field progress: Optional[Union[StrictFloat, StrictInt]] = None

The percentage progress of the snapshot transfer from the source array to the target. Displayed in decimal format.

field started: Optional[StrictInt] = None

The timestamp of when the snapshot replication process started. Measured in milliseconds since the UNIX epoch.

VolumeSnapshotTransferGetResponse

pydantic model pypureclient.flasharray.VolumeSnapshotTransferGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[VolumeSnapshotTransfer]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None, total: Optional[ConstrainedListValue[VolumeSnapshotTransfer]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[VolumeSnapshotTransfer]] = None

Displays a list of all items after filtering. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total: Optional[ConstrainedListValue[VolumeSnapshotTransfer]] = None

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 field where meaningful.

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

VolumeSnapshotTransferResponse

pydantic model pypureclient.flasharray.VolumeSnapshotTransferResponse(*, items: Optional[ConstrainedListValue[VolumeSnapshotTransfer]] = None)
field items: Optional[ConstrainedListValue[VolumeSnapshotTransfer]] = None

Displays a list of all items after filtering. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

VolumeSpace

pydantic model pypureclient.flasharray.VolumeSpace(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, context: Optional[FixedReference] = None, space: Optional[VolumeSpaceCommon] = None, time: Optional[StrictInt] = None)
field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field name: Optional[StrictStr] = None

A locally unique, system-generated name. The name cannot be modified.

field space: Optional[VolumeSpaceCommon] = None

Displays size and space consumption information.

field time: Optional[StrictInt] = None

The timestamp of when the data was taken, measured in milliseconds since the UNIX epoch.

VolumeSpaceCommon

pydantic model pypureclient.flasharray.VolumeSpaceCommon(*, data_reduction: Optional[Union[StrictFloat, StrictInt]] = None, footprint: Optional[ConstrainedIntValue] = None, shared: Optional[ConstrainedIntValue] = None, snapshots: Optional[ConstrainedIntValue] = None, system: Optional[ConstrainedIntValue] = None, thin_provisioning: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None, total_physical: Optional[ConstrainedIntValue] = None, total_provisioned: Optional[ConstrainedIntValue] = None, total_reduction: Optional[Union[StrictFloat, StrictInt]] = None, total_used: Optional[ConstrainedIntValue] = None, unique: Optional[ConstrainedIntValue] = None, used_provisioned: Optional[ConstrainedIntValue] = None, virtual: Optional[ConstrainedIntValue] = None, snapshots_effective: Optional[ConstrainedIntValue] = None, total_effective: Optional[ConstrainedIntValue] = None, unique_effective: Optional[ConstrainedIntValue] = None)
field data_reduction: Optional[Union[StrictFloat, StrictInt]] = None

The ratio of mapped sectors within a volume versus the amount of physical space the data occupies after data compression and deduplication. The data reduction ratio does not include thin provisioning savings. For example, a data reduction ratio of 5&#58;1 means that for every 5 MB the host writes to the array, 1 MB is stored on the array’s flash modules.

field footprint: Optional[ConstrainedIntValue] = None

The maximum amount of physical space the container consumes on an array, ignoring any data shared outside the container, measured in bytes. On Evergreen//One arrays, this is the maximum amount of effective used space. The footprint metric is mostly used for capacity planning. This field will be null in non-container contexts.

Constraints

  • minimum = 0

field shared: Optional[ConstrainedIntValue] = None

The physical space occupied by deduplicated data, meaning that the space is shared with other volumes and snapshots as a result of data deduplication. Measured in bytes. On Evergreen//One arrays, this is the effective space contributed by data that is not unique to a specific volume, managed directory, or snapshot, measured in bytes.

Constraints

  • minimum = 0

field snapshots: Optional[ConstrainedIntValue] = None

The physical space occupied by data unique to one or more snapshots. Measured in bytes. On Evergreen//One arrays, this is the effective space contributed by data unique to one or more snapshots, measured in bytes.

Constraints

  • minimum = 0

field snapshots_effective: Optional[ConstrainedIntValue] = None

This field has been deprecated. The effective space contributed by data unique to one or more snapshots, measured in bytes. Use the snapshots field in the future, as it contains the same information for Evergreen//One arrays.

Constraints

  • minimum = 0

field system: Optional[ConstrainedIntValue] = None

The physical space occupied by internal array metadata. Measured in bytes.

Constraints

  • minimum = 0

field thin_provisioning: Optional[Union[ConstrainedFloatValue, ConstrainedIntValue]] = None

The percentage of volume sectors that do not contain host-written data because the hosts have not written data to them or the sectors have been explicitly trimmed.

field total_effective: Optional[ConstrainedIntValue] = None

This field has been deprecated. The total effective space contributed by customer data, measured in bytes. Use the total_physical field in the future, as it contains the same information for Evergreen//One arrays.

Constraints

  • minimum = 0

field total_physical: Optional[ConstrainedIntValue] = None

This field has been deprecated. Use the total_used field, as it contains the same information.

Constraints

  • minimum = 0

field total_provisioned: Optional[ConstrainedIntValue] = None

The provisioned size of a volume for a single volume, host or host group, protocol endpoint, managed directory, and containers can be infinite or measured in bytes. Infinite is represented by null. The provisioned size for a host or host group, includes all volumes that are connected to the resource. The provisioned size for a protocol endpoint is null’. The provisioned size for a managed directory is the quota limit if it or its parent has a managed directory configured, otherwise it defaults to `null. The provisioned size for a container is the sum of the total_provisioned of the object it contains, capped by the container’s quota limit (or the container’s used_provisioned if current usage is above the quota limit), if any. Provisioned size represents the storage capacity reported to hosts.

Constraints

  • minimum = 0

field total_reduction: Optional[Union[StrictFloat, StrictInt]] = None

The ratio of provisioned sectors within a volume versus the amount of physical space the data occupies after reduction via data compression and deduplication and with thin provisioning savings. Total reduction is data reduction with thin provisioning savings. For example, a total reduction ratio of 10&#58;1 means that for every 10 MB of provisioned space, 1 MB is stored on the array’s flash modules.

field total_used: Optional[ConstrainedIntValue] = None

The total space contributed by customer data, measured in bytes.

Constraints

  • minimum = 0

field unique: Optional[ConstrainedIntValue] = None

The unique physical space occupied by customer data. Unique physical space does not include shared space, snapshots, and internal array metadata. Measured in bytes. On Evergreen//One arrays, this is the effective space contributed by unique customer data, measured in bytes. Unique data does not include shared space, snapshots, and internal array metadata.

Constraints

  • minimum = 0

field unique_effective: Optional[ConstrainedIntValue] = None

This field has been deprecated. The effective space contributed by unique customer data. Unique data does not include shared space, snapshots, and internal array metadata, measured in bytes. Use the unique field in the future, as it contains the same information for Evergreen//One arrays.

Constraints

  • minimum = 0

field used_provisioned: Optional[ConstrainedIntValue] = None

The amount of logical space a container has consumed, compared against the quota limit if the container has one configured. Used provisioned does not include destroyed objects inside the container. Used provisioned can include destroyed objects for a destroyed container and represents how much logical space it would take to recover the container.

Constraints

  • minimum = 0

field virtual: Optional[ConstrainedIntValue] = None

The amount of logically written data that a volume or a snapshot references. Measured in bytes.

Constraints

  • minimum = 0

VolumeSpaceGetResponse

pydantic model pypureclient.flasharray.VolumeSpaceGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None, items: Optional[ConstrainedListValue[VolumeSpace]] = None, total: Optional[ConstrainedListValue[VolumeSpace]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[VolumeSpace]] = None

Displays a list of all items after filtering. If applicable, the values are displayed for each name. If total_only=true, the items list will be empty.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total: Optional[ConstrainedListValue[VolumeSpace]] = None

The aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. If applicable, the values are displayed for each field.

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

VolumesBatchResponse

pydantic model pypureclient.flasharray.VolumesBatchResponse(*, items: Optional[ConstrainedListValue[Volume]] = None)
field items: Optional[ConstrainedListValue[Volume]] = None

Displays a list of all items. If applicable, the values are displayed for each name.

VolumesDiffGetResponse

pydantic model pypureclient.flasharray.VolumesDiffGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[VolumeDiff]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[VolumeDiff]] = None

A list of different chunks between specified volumes.

field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

VolumesDiffResponse

pydantic model pypureclient.flasharray.VolumesDiffResponse(*, items: Optional[ConstrainedListValue[VolumeDiff]] = None)
field items: Optional[ConstrainedListValue[VolumeDiff]] = None

A list of different chunks between specified volumes.

Workload

pydantic model pypureclient.flasharray.Workload(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, context: Optional[FixedReference] = None, created: Optional[StrictInt] = None, destroyed: Optional[StrictBool] = None, preset: Optional[WorkloadPreset] = None, status: Optional[StrictStr] = None, status_details: Optional[ConstrainedListValue[StrictStr]] = None, time_remaining: Optional[StrictInt] = None)
field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field created: Optional[StrictInt] = None

The workload creation time, measured in milliseconds since the UNIX epoch.

field destroyed: Optional[StrictBool] = None

Returns a value of true if the workload has been destroyed and is pending eradication. The time_remaining displays the amount of time left until the destroyed workload is permanently eradicated. Before the time_remaining period has elapsed, the destroyed workload can be recovered by setting destroyed=false. Once the time_remaining period has elapsed, the workload is permanently eradicated and can no longer be recovered.

Constraints

  • type = boolean

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field name: Optional[StrictStr] = None

A user-specified name. The name must be locally unique and can be changed.

field preset: Optional[WorkloadPreset] = None

A reference to the preset the workload was deployed from. If the preset has since been destroyed, name will be null.

field status: Optional[StrictStr] = None

The status of the workload. Supported values are creating, ready, destroying, destroyed, eradicating and recovering.

field status_details: Optional[ConstrainedListValue[StrictStr]] = None

Additional information about the workload status. For example, if the workload status is creating, status details might describe what resources are currently being created.

field time_remaining: Optional[StrictInt] = None

The amount of time left until the destroyed workload is permanently eradicated, measured in milliseconds. Before the time_remaining period has elapsed, the destroyed workload can be recovered by setting destroyed=false.

WorkloadConfigurationFixedReference

pydantic model pypureclient.flasharray.WorkloadConfigurationFixedReference(*, workload: Optional[WorkloadConfigurationFixedReferenceWorkload] = None)
field workload: Optional[WorkloadConfigurationFixedReferenceWorkload] = None

WorkloadConfigurationFixedReferenceWorkload

pydantic model pypureclient.flasharray.WorkloadConfigurationFixedReferenceWorkload(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, resource_type: Optional[StrictStr] = None, configuration: Optional[StrictStr] = None)

A reference to the workload that is managing this resource. The name parameter might show as an empty string briefly after controller failover.

field configuration: Optional[StrictStr] = None

The name of the preset configuration object.

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified.

field name: Optional[StrictStr] = None

The resource name, such as volume name, pod name, snapshot name, and so on.

field resource_type: Optional[StrictStr] = None

Type of the object (full name of the endpoint). Valid values include hosts, host-groups, network-interfaces, pods, ports, pod-replica-links, subnets, volumes, volume-snapshots, volume-groups, directories, policies/nfs, policies/smb, policies/snapshot, and policies/quota, etc.

WorkloadConfigurationReference

pydantic model pypureclient.flasharray.WorkloadConfigurationReference(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, resource_type: Optional[StrictStr] = None, configuration: Optional[StrictStr] = None)
field configuration: Optional[StrictStr] = None

The name of the preset configuration object.

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified.

field name: Optional[StrictStr] = None

The resource name, such as volume name, pod name, snapshot name, and so on.

field resource_type: Optional[StrictStr] = None

Type of the object (full name of the endpoint). Valid values are hosts, host-groups, network-interfaces, pods, ports, pod-replica-links, subnets, volumes, volume-snapshots, volume-groups, directories, policies/nfs, policies/smb, and policies/snapshot, etc.

WorkloadGetResponse

pydantic model pypureclient.flasharray.WorkloadGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, items: Optional[ConstrainedListValue[Workload]] = None, errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query parameter to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination, then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field errors: Optional[ConstrainedListValue[ErrorcontextresponseErrors]] = None

The list of errors encountered when attempting to perform an operation.

field items: Optional[ConstrainedListValue[Workload]] = None

Displays a list of all items after filtering. If applicable, the values are displayed for each name.

field more_items_remaining: Optional[StrictBool] = None

Displays a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

WorkloadParameter

pydantic model pypureclient.flasharray.WorkloadParameter(*, name: Optional[StrictStr] = None, value: Optional[WorkloadParameterValue] = None)

The name and value of a single parameter.

field name: Optional[StrictStr] = None

The name of the parameter.

field value: Optional[WorkloadParameterValue] = None

WorkloadParameterValue

pydantic model pypureclient.flasharray.WorkloadParameterValue(*, boolean: Optional[StrictBool] = None, integer: Optional[StrictInt] = None, resource_reference: Optional[WorkloadParameterValueResourceReference] = None, string: Optional[StrictStr] = None)

The value of the parameter.

field boolean: Optional[StrictBool] = None

The value for a boolean parameter.

Constraints

  • type = boolean

field integer: Optional[StrictInt] = None

The value for an integer parameter.

field resource_reference: Optional[WorkloadParameterValueResourceReference] = None
field string: Optional[StrictStr] = None

The value for a string parameter.

WorkloadParameterValueResourceReference

pydantic model pypureclient.flasharray.WorkloadParameterValueResourceReference(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, resource_type: Optional[StrictStr] = None)

The value for a resource reference parameter.

field id: Optional[StrictStr] = None

The id of the resource to reference. One of id or name must be set, but they cannot be set together.

field name: Optional[StrictStr] = None

The name of the resource to reference. One of id or name must be set, but they cannot be set together.

field resource_type: Optional[StrictStr] = None

The type of the resource to reference. Resource type is optional, and will be automatically determined by the server if not set.

WorkloadPatch

pydantic model pypureclient.flasharray.WorkloadPatch(*, destroyed: Optional[StrictBool] = None, name: Optional[StrictStr] = None)
field destroyed: Optional[StrictBool] = None

If set to true, destroys a resource. Once set to true, the time_remaining value will display the amount of time left until the destroyed resource is permanently eradicated. Before the time_remaining period has elapsed, the destroyed resource can be recovered by setting destroyed=false. Once the time_remaining period has elapsed, the resource is permanently eradicated and can no longer be recovered.

Constraints

  • type = boolean

field name: Optional[StrictStr] = None

The new name for the resource.

WorkloadPlacementRecommendation

pydantic model pypureclient.flasharray.WorkloadPlacementRecommendation(*, context: Optional[FixedReference] = None, additional_constraints: Optional[WorkloadPlacementRecommendationAdditionalConstraints] = None, created: Optional[StrictInt] = None, expires: Optional[StrictInt] = None, id: Optional[StrictStr] = None, more_results_available: Optional[StrictBool] = None, name: Optional[StrictStr] = None, parameters: Optional[ConstrainedListValue[WorkloadParameter]] = None, placement_names: Optional[ConstrainedListValue[StrictStr]] = None, preset: Optional[FixedReference] = None, progress: Optional[Union[StrictFloat, StrictInt]] = None, projection_months: Optional[StrictInt] = None, results: Optional[ConstrainedListValue[WorkloadPlacementRecommendationResult]] = None, results_limit: Optional[StrictInt] = None, status: Optional[StrictStr] = None)
field additional_constraints: Optional[WorkloadPlacementRecommendationAdditionalConstraints] = None
field context: Optional[FixedReference] = None

The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet. If the array is not a member of a fleet, context will always implicitly be set to the array that received the request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided context.

field created: Optional[StrictInt] = None

The time the recommendation was made, measured in milliseconds since the UNIX epoch.

field expires: Optional[StrictInt] = None

The time when recommendation expires, measured in milliseconds since the UNIX epoch.

field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.

field more_results_available: Optional[StrictBool] = None
Constraints

  • type = boolean

field name: Optional[StrictStr] = None

A globally unique, system-generated name. The name cannot be modified and cannot refer to another resource.

field parameters: Optional[ConstrainedListValue[WorkloadParameter]] = None

The parameter values to pass to the preset. Value must be supplied for all parameters that do not have a default defined in the preset.

field placement_names: Optional[ConstrainedListValue[StrictStr]] = None
field preset: Optional[FixedReference] = None
field progress: Optional[Union[StrictFloat, StrictInt]] = None

The percentage progress of the recommendation computation. The percentage is displayed as a decimal value, starting at 0.00 and ending at 1.00.

field projection_months: Optional[StrictInt] = None

The number of months to compute the projections. If not specified, defaults to 1 month.

field results: Optional[ConstrainedListValue[WorkloadPlacementRecommendationResult]] = None

The results of the recommendation.

field results_limit: Optional[StrictInt] = None

The maximum number of results to return. If not specified, defaults to 10 results.

field status: Optional[StrictStr] = None

The status of the recommendation. Possible values are processing, completed, and failed.

WorkloadPlacementRecommendationAdditionalConstraints

pydantic model pypureclient.flasharray.WorkloadPlacementRecommendationAdditionalConstraints(*, required_resource_references: Optional[ConstrainedListValue[WorkloadPlacementRecommendationResourceReference]] = None, targets: Optional[ConstrainedListValue[ReferenceWithType]] = None)

The list of targets considered for workload placement must satisfy the requirements imposed by the preset. It is also possible to specify additional constraints to further restrict the list of targets for consideration.

field required_resource_references: Optional[ConstrainedListValue[WorkloadPlacementRecommendationResourceReference]] = None

Defines a group of resources. At least one resource from each item should be present on this target for the target to be considered an acceptable candidate for workload placement

field targets: Optional[ConstrainedListValue[ReferenceWithType]] = None

If specified, only consider these targets when computing placement recommendations. If not specified, the whole fleet is used to compute the recommendation.

WorkloadPlacementRecommendationGetResponse

pydantic model pypureclient.flasharray.WorkloadPlacementRecommendationGetResponse(*, continuation_token: Optional[StrictStr] = None, more_items_remaining: Optional[StrictBool] = None, total_item_count: Optional[StrictInt] = None, items: Optional[ConstrainedListValue[WorkloadPlacementRecommendation]] = None)
field continuation_token: Optional[StrictStr] = None

Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified).

field items: Optional[ConstrainedListValue[WorkloadPlacementRecommendation]] = None
field more_items_remaining: Optional[StrictBool] = None

Returns a value of true if subsequent items can be retrieved.

Constraints

  • type = boolean

field total_item_count: Optional[StrictInt] = None

The total number of records after applying all filter query parameters. The total_item_count will be calculated if and only if the corresponding query parameter total_item_count is set to true. If this query parameter is not set or set to false, a value of null will be returned.

WorkloadPlacementRecommendationPlacement

pydantic model pypureclient.flasharray.WorkloadPlacementRecommendationPlacement(*, name: Optional[StrictStr] = None, targets: Optional[ConstrainedListValue[WorkloadPlacementRecommendationTarget]] = None)

Placement data in the recommendation result.

field name: Optional[StrictStr] = None

The name of the placement.

field targets: Optional[ConstrainedListValue[WorkloadPlacementRecommendationTarget]] = None

The targets for the placement.

WorkloadPlacementRecommendationProjection

pydantic model pypureclient.flasharray.WorkloadPlacementRecommendationProjection(*, end: Optional[Union[StrictFloat, StrictInt]] = None, start: Optional[Union[StrictFloat, StrictInt]] = None)
field end: Optional[Union[StrictFloat, StrictInt]] = None

The projection for the end of the projection period. Length of the projection period is defined by ‘projection_months’. The percentage is displayed as a decimal value, starting at 0.00 and ending at 1.00.

field start: Optional[Union[StrictFloat, StrictInt]] = None

The projection for the start of the projection period (i.e., immediately after the creation of the workload on this target). The percentage is displayed as a decimal value, starting at 0.00 and ending at 1.00.

WorkloadPlacementRecommendationResourceReference

pydantic model pypureclient.flasharray.WorkloadPlacementRecommendationResourceReference(*, allowed_values: ConstrainedListValue[ReferenceWithType])

Defines a group of resources. At least one of them should be present on this target to use it for computation of a recommendation. Currently only hosts or host groups could be used.

field allowed_values: ConstrainedListValue[ReferenceWithType] [Required]

A list of allowed values for the resource reference. For hosts and host groups, each item does not define a specific object on some target, but defines a pattern which should be matched by the target. For example, { type: host, name: host1 } will match all targets that have a host with name host1.

WorkloadPlacementRecommendationResponse

pydantic model pypureclient.flasharray.WorkloadPlacementRecommendationResponse(*, items: Optional[ConstrainedListValue[WorkloadPlacementRecommendation]] = None)
field items: Optional[ConstrainedListValue[WorkloadPlacementRecommendation]] = None

WorkloadPlacementRecommendationResult

pydantic model pypureclient.flasharray.WorkloadPlacementRecommendationResult(*, placements: Optional[ConstrainedListValue[WorkloadPlacementRecommendationPlacement]] = None, score: Optional[StrictStr] = None)

Single workload placement recommendation result.

field placements: Optional[ConstrainedListValue[WorkloadPlacementRecommendationPlacement]] = None

The placements of the preset.

field score: Optional[StrictStr] = None

The score of the recommendation from Pure1. Possible values include optimal, optimal-with-warnings, and acceptable.

WorkloadPlacementRecommendationTarget

pydantic model pypureclient.flasharray.WorkloadPlacementRecommendationTarget(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, resource_type: Optional[StrictStr] = None, capacity: Optional[StrictInt] = None, capacity_used_projections: Optional[WorkloadPlacementRecommendationTargetCapacityUsedProjections] = None, load_projections: Optional[WorkloadPlacementRecommendationTargetLoadProjections] = None, model: Optional[StrictStr] = None, warnings: Optional[ConstrainedListValue[WorkloadPlacementRecommendationWarning]] = None)

Data for a target in a workload placement recommendation. Target is a FlashArray, which may be used for workload placement.

field capacity: Optional[StrictInt] = None

The usable capacity of the target, measured in bytes.

field capacity_used_projections: Optional[WorkloadPlacementRecommendationTargetCapacityUsedProjections] = None
field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified.

field load_projections: Optional[WorkloadPlacementRecommendationTargetLoadProjections] = None
field model: Optional[StrictStr] = None

The model of the target. For example, FA-X20R2.

field name: Optional[StrictStr] = None

The resource name, such as volume name, pod name, snapshot name, and so on.

field resource_type: Optional[StrictStr] = None

Type of the object (full name of the endpoint). Valid values are hosts, host-groups, network-interfaces, pods, ports, pod-replica-links, subnets, volumes, volume-snapshots, volume-groups, directories, policies/nfs, policies/smb, and policies/snapshot, etc.

field warnings: Optional[ConstrainedListValue[WorkloadPlacementRecommendationWarning]] = None

The warnings for the target.

WorkloadPlacementRecommendationTargetCapacityUsedProjections

pydantic model pypureclient.flasharray.WorkloadPlacementRecommendationTargetCapacityUsedProjections(*, days_until_full: Optional[StrictInt] = None, projection: Optional[WorkloadPlacementRecommendationProjection] = None)

Projections for the capacity consumed by customer data.

field days_until_full: Optional[StrictInt] = None

The number of days until the target is at full capacity.

field projection: Optional[WorkloadPlacementRecommendationProjection] = None

The projection of the used capacity, assuming the workload is provisioned on this target.

WorkloadPlacementRecommendationTargetLoadProjections

pydantic model pypureclient.flasharray.WorkloadPlacementRecommendationTargetLoadProjections(*, projection_avg: Optional[WorkloadPlacementRecommendationProjection] = None, projection_blended_max: Optional[WorkloadPlacementRecommendationProjection] = None)

Load depicts the storage system utilization as a percentage from 0, when the system is completely idle, to 100, when the system is completely saturated.

field projection_avg: Optional[WorkloadPlacementRecommendationProjection] = None

The projected average load on the target.

field projection_blended_max: Optional[WorkloadPlacementRecommendationProjection] = None

The projected blended maximum load on the target.

WorkloadPlacementRecommendationWarning

pydantic model pypureclient.flasharray.WorkloadPlacementRecommendationWarning(*, code: Optional[StrictStr] = None, message: Optional[StrictStr] = None)
field code: Optional[StrictStr] = None

The warning code. Possible values include limit_volumes_count, limit_pods_count, etc.

field message: Optional[StrictStr] = None

The warning message. Possible values include Adding the workload on the array would exceed the limit on volumes, Adding the workload on the array would exceed the limit on pods, etc.

WorkloadPost

pydantic model pypureclient.flasharray.WorkloadPost(*, parameters: Optional[ConstrainedListValue[WorkloadParameter]] = None)
field parameters: Optional[ConstrainedListValue[WorkloadParameter]] = None

The parameter values to pass to the preset when creating the workload. Value must be supplied for all parameters that do not have a default defined in the preset.

WorkloadPreset

pydantic model pypureclient.flasharray.WorkloadPreset(*, id: Optional[StrictStr] = None, name: Optional[StrictStr] = None, resource_type: Optional[StrictStr] = None, revision: Optional[StrictInt] = None)
field id: Optional[StrictStr] = None

A globally unique, system-generated ID. The ID cannot be modified.

field name: Optional[StrictStr] = None

The resource name, such as volume name, pod name, snapshot name, and so on.

field resource_type: Optional[StrictStr] = None

Type of the object (full name of the endpoint). Valid values include hosts, host-groups, network-interfaces, pods, ports, pod-replica-links, subnets, volumes, volume-snapshots, volume-groups, directories, policies/nfs, policies/smb, policies/snapshot, and policies/quota, etc.

field revision: Optional[StrictInt] = None

The revision of the preset from which the workload was deployed.

WorkloadResponse

pydantic model pypureclient.flasharray.WorkloadResponse(*, items: Optional[ConstrainedListValue[Workload]] = None)
field items: Optional[ConstrainedListValue[Workload]] = None

Displays a list of all items after filtering. If applicable, the values are displayed for each name.