pypureclient.flasharray.FA_2_34 package

Subpackages

Submodules

pypureclient.flasharray.FA_2_34.api_client module

FlashArray REST API

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: 2.34

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.flasharray.FA_2_34.api_client.ApiClient(configuration=None, header_name=None, header_value=None, cookie=None)

Bases: object

Generic API client for Swagger client library builds.

Swagger generic API client. This client handles the client- server communication, and is invariant across implementations. Specifics of the methods and models for each application are generated from the Swagger templates.

Parameters

  • configuration – .Configuration object for this client

  • header_name – a header to pass when making calls to the API.

  • header_value – a header value to pass when making calls to the API.

  • cookie – a cookie to include in the header when making calls to the API

NATIVE_TYPES_MAPPING = {'bool': <class 'bool'>, 'date': <class 'datetime.date'>, 'datetime': <class 'datetime.datetime'>, 'float': <class 'float'>, 'int': <class 'int'>, 'long': <class 'int'>, 'object': <class 'object'>, 'str': <class 'str'>}
PRIMITIVE_TYPES = (<class 'float'>, <class 'bool'>, <class 'bytes'>, <class 'str'>, <class 'int'>)
call_api(resource_path, method, path_params=None, query_params=None, header_params=None, body=None, post_params=None, files=None, response_type=None, auth_settings=None, async_req=None, _return_http_data_only=None, collection_formats=None, _preload_content=True, _request_timeout=None)

Makes the HTTP request (synchronous) and returns deserialized data.

To make an async request, set the async_req parameter.

Parameters

  • resource_path – Path to method endpoint.

  • method – Method to call.

  • path_params – Path parameters in the url.

  • query_params – Query parameters in the url.

  • header_params – Header parameters to be placed in the request header.

  • body – Request body.

  • dict (files) – Request post form parameters, for application/x-www-form-urlencoded, multipart/form-data.

  • list (auth_settings) – Auth Settings names for the request.

  • response – Response data type.

  • dict – key -> filename, value -> filepath, for multipart/form-data.

  • bool (async_req) – execute request asynchronously

  • _return_http_data_only – response data without head status code and headers

  • collection_formats – dict of collection formats for path, query, header, and post parameters.

  • _preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

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

Returns

If async_req parameter is True, the request will be called asynchronously. The method will return the request thread. If parameter async_req is False or missing, then the method will return the response directly.

close()
deserialize(response, response_type)

Deserializes response into an object.

Parameters

  • response – RESTResponse object to be deserialized.

  • response_type – class literal for deserialized object, or string of class name.

Returns

deserialized object.

extract_object_dict_from_object(obj)

Convert model obj to dict, using swagger_types and use attribute_map to determine json keys.

parameters_to_tuples(params, collection_formats)

Get parameters as list of tuples, formatting collections.

Parameters

  • params – Parameters as dict or list of two-tuples

  • collection_formats (dict) – Parameter collection formats

Returns

Parameters as list of tuples, collections formatted

prepare_post_parameters(post_params=None, files=None)

Builds form parameters.

Parameters

  • post_params – Normal form parameters.

  • files – File parameters.

Returns

Form parameters with files.

request(method, url, query_params=None, headers=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)

Makes the HTTP request using RESTClient.

sanitize_for_serialization(obj)

Builds a JSON POST object.

If obj is None, return None. If obj is str, int, long, float, bool, return directly. If obj is datetime.datetime, datetime.date

convert to string in iso8601 format.

If obj is list, sanitize each element in the list. If obj is dict, return the dict. If obj is swagger model, return the properties dict.

Parameters

obj – The data to serialize.

Returns

The serialized form of data.

select_header_accept(accepts)

Returns Accept based on an array of accepts provided.

Parameters

accepts – List of headers.

Returns

Accept (e.g. application/json).

select_header_content_type(content_types)

Returns Content-Type based on an array of content_types provided.

Parameters

content_types – List of content-types.

Returns

Content-Type (e.g. application/json).

set_default_header(header_name, header_value)
update_params_for_auth(headers, querys, auth_settings)

Updates header and query params based on authentication setting.

Parameters

  • headers – Header parameters dict to be updated.

  • querys – Query parameters tuple list to be updated.

  • auth_settings – Authentication setting identifiers list.

property user_agent

User agent for this API client

pypureclient.flasharray.FA_2_34.client module

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)

Bases: object

DEFAULT_RETRIES = 5
USER_AGENT = 'pypureclient/1.57.0/FA/2.34/Linux/5.4.0-169-generic'
__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(references: Optional[List[ReferenceType]] = None, names: Optional[List[str]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, local_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Deletes one or more specified Active Directory accounts.

Parameters

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

Deletes the specified administrator.

Parameters

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

Deletes the API tokens of the specified administrators.

Parameters

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_admins_cache(remove_all_entries: Optional[bool] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Deletes all entries from the administrator cache.

Parameters

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

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

Parameters

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_alerts_rules(code: Optional[int] = None, parameter: Optional[str] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Deletes a custom alert rule.

Parameters

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

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

Parameters

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

Deletes the connection between this array and the specified array.

Parameters

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_arrays(authorization: Optional[str] = None, x_request_id: Optional[str] = None, eradicate_all_data: Optional[bool] = None, factory_reset_token: Optional[int] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_arrays_cloud_provider_tags(authorization: Optional[str] = None, x_request_id: Optional[str] = None, keys: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

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

Parameters

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

  • keys (list[str], optional) – A list of tag keys.

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_arrays_erasures(authorization: Optional[str] = None, x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Deletes the factory reset process when it is failed.

Parameters

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

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

Parameters

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_arrays_tags(authorization: Optional[str] = None, x_request_id: Optional[str] = None, keys: Optional[List[str]] = None, namespaces: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Deletes specified tags on array objects.

Parameters

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

  • keys (list[str], optional) – A list of tag keys.

  • namespaces (list[str], optional) – A list of namespaces.

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

Deletes a specific certificate object.

Parameters

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_connections(host_groups: Optional[List[ReferenceType]] = None, hosts: Optional[List[ReferenceType]] = None, volumes: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, host_group_names: Optional[List[str]] = None, host_names: Optional[List[str]] = None, volume_names: Optional[List[str]] = None, volume_ids: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Deletes 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

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

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

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

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

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

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

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

  • member_ids (list[str], optional) – 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], optional) – 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], optional) – 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], optional) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

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

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

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

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

  • member_ids (list[str], optional) – 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], optional) – 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], optional) – 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], optional) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

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

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

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

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

  • member_ids (list[str], optional) – 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], optional) – 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], optional) – 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], optional) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

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

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

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

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

  • member_ids (list[str], optional) – 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], optional) – 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], optional) – 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], optional) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

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

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

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

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

  • member_ids (list[str], optional) – 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], optional) – 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], optional) – 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], optional) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_directory_exports(directories: Optional[List[ReferenceType]] = None, exports: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, directory_ids: Optional[List[str]] = None, directory_names: Optional[List[str]] = None, export_names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

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

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

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

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

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

  • directory_ids (list[str], optional) – 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], optional) – 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], optional) – Performs the operation on the export names specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • policy_ids (list[str], optional) – 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], optional) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_directory_services_local_groups(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, sids: Optional[List[str]] = None, gids: Optional[List[int]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

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

Parameters

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

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_directory_services_local_groups_members(groups: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, group_names: Optional[List[str]] = None, group_sids: Optional[List[str]] = None, group_gids: Optional[List[int]] = None, member_names: Optional[List[str]] = None, member_sids: Optional[List[str]] = None, member_ids: Optional[List[int]] = None, member_types: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

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

Parameters

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

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

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

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

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

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

  • member_names (list[str], optional) – 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], optional) – 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_ids (list[int], optional) – 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_types (list[str], optional) – 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) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_directory_services_local_users(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, sids: Optional[List[str]] = None, uids: Optional[List[int]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

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

Parameters

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

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

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

  • sids (list[str], optional) – 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], optional) – A list of local user IDs (UIDs). Enter multiple local user IDs in comma- separated format. For example, 423,51234.

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_directory_services_local_users_members(groups: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, group_names: Optional[List[str]] = None, group_sids: Optional[List[str]] = None, group_gids: Optional[List[int]] = None, member_names: Optional[List[str]] = None, member_sids: Optional[List[str]] = None, member_ids: Optional[List[int]] = None, member_types: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

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

Parameters

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

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

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

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

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

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

  • member_names (list[str], optional) – 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], optional) – 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_ids (list[int], optional) – 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_types (list[str], optional) – 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) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

Delete a group to role mapping

Parameters

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

Deletes DNS configuration identified by configuration name.

Parameters

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

Deletes a host group. The names query parameter is required.

Parameters

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_host_groups_hosts(groups: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, group_names: Optional[List[str]] = None, member_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Removes a host from a host group. Removing a host 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

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

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

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

  • group_names (list[str], optional) – 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], optional) – 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) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_host_groups_protection_groups(groups: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, group_ids: Optional[List[str]] = None, group_names: Optional[List[str]] = None, member_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

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

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

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

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

  • group_ids (list[str], optional) – A list of group IDs.

  • group_names (list[str], optional) – 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], optional) – 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) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_host_groups_tags(resources: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, keys: Optional[List[str]] = None, namespaces: Optional[List[str]] = None, resource_ids: Optional[List[str]] = None, resource_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Deletes specified tags on host group objects.

Parameters

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

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

  • keys (list[str], optional) – A list of tag keys.

  • namespaces (list[str], optional) – A list of namespaces.

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_hosts_host_groups(groups: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, group_names: Optional[List[str]] = None, member_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Removes a host from a host group. Removing a host 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

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

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

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

  • group_names (list[str], optional) – 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], optional) – 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) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_hosts_protection_groups(groups: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, group_ids: Optional[List[str]] = None, group_names: Optional[List[str]] = None, member_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

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

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

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

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

  • group_ids (list[str], optional) – A list of group IDs.

  • group_names (list[str], optional) – 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], optional) – 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) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_hosts_tags(resources: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, keys: Optional[List[str]] = None, namespaces: Optional[List[str]] = None, resource_ids: Optional[List[str]] = None, resource_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Deletes specified tags on host objects.

Parameters

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

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

  • keys (list[str], optional) – A list of tag keys.

  • namespaces (list[str], optional) – A list of namespaces.

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

Deletes KMIP server objects.

Parameters

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

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

Parameters

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

Deletes a network interface on a controller.

Parameters

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

Deletes an offload target.

Parameters

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

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

  • local_pods (list[FixedReference], optional) – A list of local_pods to query for. Overrides local_pod_ids and local_pod_names keyword arguments.

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

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

  • ids (list[str], optional) – Performs the operation on the unique resource IDs specified. 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], optional) – A 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], optional) – A 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], optional) – A 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], optional) – A 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) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_pods(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, eradicate_contents: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

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

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_pods_arrays(groups: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, group_names: Optional[List[str]] = None, group_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, member_ids: Optional[List[str]] = None, with_unknown: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Unstretches a pod from 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 restretch 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 restretch can 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.

Parameters

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

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

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

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

  • group_ids (list[str], optional) – A list of group IDs.

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

  • with_unknown (bool, optional) – If set to true, unstretches the specified pod from the specified array by force. Use the with_unknown parameter in the following rare event&#58; 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) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

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

Parameters

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

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

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

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

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

  • member_ids (list[str], optional) – 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], optional) – 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], optional) – 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], optional) – 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], optional) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

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

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

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

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

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

  • policy_ids (list[str], optional) – 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], optional) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

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

Parameters

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

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

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

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

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

  • member_ids (list[str], optional) – 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], optional) – 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], optional) – 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], optional) – 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], optional) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

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

Parameters

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

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

Parameters

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

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

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

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

  • policy_ids (list[str], optional) – 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], optional) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

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

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

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

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

  • member_ids (list[str], optional) – 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], optional) – 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], optional) – 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], optional) – 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], optional) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

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

Parameters

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

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

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

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

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

  • member_ids (list[str], optional) – 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], optional) – 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], optional) – 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], optional) – 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], optional) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

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

Parameters

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

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

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

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

  • policy_ids (list[str], optional) – 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], optional) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

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

Parameters

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

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

Parameters

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

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

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

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

  • policy_ids (list[str], optional) – 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], optional) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

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

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

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

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

  • member_ids (list[str], optional) – 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], optional) – 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], optional) – 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], optional) – 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], optional) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

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

Parameters

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

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

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

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

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

  • member_ids (list[str], optional) – 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], optional) – 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], optional) – 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], optional) – 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], optional) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

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

Parameters

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

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

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

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

  • policy_ids (list[str], optional) – 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], optional) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_protection_groups_host_groups(groups: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, group_ids: Optional[List[str]] = None, group_names: Optional[List[str]] = None, member_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

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

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

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

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

  • group_ids (list[str], optional) – A list of group IDs.

  • group_names (list[str], optional) – 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], optional) – 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) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_protection_groups_hosts(groups: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, group_ids: Optional[List[str]] = None, group_names: Optional[List[str]] = None, member_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

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

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

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

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

  • group_ids (list[str], optional) – A list of group IDs.

  • group_names (list[str], optional) – 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], optional) – 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) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_protection_groups_targets(groups: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, group_ids: Optional[List[str]] = None, group_names: Optional[List[str]] = None, member_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Deletes an array 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 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

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

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

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

  • group_ids (list[str], optional) – A list of group IDs.

  • group_names (list[str], optional) – 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], optional) – 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) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_protection_groups_volumes(groups: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, group_ids: Optional[List[str]] = None, group_names: Optional[List[str]] = None, member_names: Optional[List[str]] = None, member_ids: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

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

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

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

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

  • group_ids (list[str], optional) – A list of group IDs.

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_remote_protection_group_snapshots(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, ids: Optional[List[str]] = None, on: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

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

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

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

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

  • on (str, optional) – Performs the operation on the target name specified. For example, targetName01.

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_remote_protection_groups(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, on: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

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

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

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

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

  • on (str, optional) – Performs the operation on the target name specified. For example, targetName01.

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_remote_volume_snapshots(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, on: Optional[str] = None, replication_snapshot: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Deletes (eradicates) 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 (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

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

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

  • on (str, optional) – Performs the operation on the target name specified. For example, targetName01.

  • replication_snapshot (bool, optional) – 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) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

Deletes the SNMP manager object and stops communication with specified managers.

Parameters

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_software(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, software_versions: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

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

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

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

  • software_versions (list[str], optional) – A list of target software versions.

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_software_check(softwares: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, software_versions: Optional[List[str]] = None, software_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Deletes a 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 (list[FixedReference], optional) – A list of softwares to query for. Overrides software_names keyword arguments.

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

  • software_versions (list[str], optional) – A list of target software versions.

  • software_names (list[str], optional) – A list of software names.

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

Deletes SAML2 SSO configurations.

Parameters

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

Deletes a configured syslog server and stop forwarding syslog messages.

Parameters

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_vchost_connections(protocol_endpoints: Optional[List[ReferenceType]] = None, vchosts: Optional[List[ReferenceType]] = None, all_vchosts: Optional[bool] = None, authorization: Optional[str] = None, protocol_endpoint_ids: Optional[List[str]] = None, protocol_endpoint_names: Optional[List[str]] = None, x_request_id: Optional[str] = None, vchost_ids: Optional[List[str]] = None, vchost_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

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

  • protocol_endpoints (list[FixedReference], optional) – A list of protocol_endpoints to query for. Overrides protocol_endpoint_ids and protocol_endpoint_names keyword arguments.

  • vchosts (list[FixedReference], optional) – A list of vchosts to query for. Overrides vchost_ids and vchost_names keyword arguments.

  • all_vchosts (bool, optional) – 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], optional) – A 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], optional) – A 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.

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

  • vchost_ids (list[str], optional) – A 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], optional) – A 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) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

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

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

Parameters

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

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

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

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

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

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

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

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

Returns

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

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

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

  • TypeError – If invalid or missing parameters are used.

delete_vchosts_certificates(references: Optional[List[ReferenceType]] = None, vchosts: Optional[List[ReferenceType]] = None, certificates: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, vchost_names: Optional[List[str]] = None, vchost_ids: Optional[List[str]] = None, certificate_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

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

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

  • vchosts (list[FixedReference], optional) – A list of vchosts to query for. Overrides vchost_names and vchost_ids keyword arguments.

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – 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_names (list[str], optional) – Performs the operation on the unique vchost name specified. Enter multiple names in a comma-separated format. For example, vchost01,vchost02.

  • vchost_ids (list[str], optional) – Performs the operation on the unique vchost IDs specified. Enter multiple vchost IDs in a comma-separated format. For example, vchostid01,vchostid02.

  • certificate_names (list[str], optional) – The names of one or more certificates. Enter multiple names in comma-separated format. For example, cert01,cert02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

delete_vchosts_endpoints(references: Optional[List[ReferenceType]] = None, vchosts: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, vchost_names: Optional[List[str]] = None, vchost_ids: Optional[List[str]] = None, endpoints: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Deletes an 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

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids keyword arguments.

  • vchosts (list[FixedReference], optional) – A list of vchosts to query for. Overrides vchost_names and vchost_ids keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – 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_names (list[str], optional) – Performs the operation on the unique vchost name specified. Enter multiple names in a comma-separated format. For example, vchost01,vchost02.

  • vchost_ids (list[str], optional) – Performs the operation on the unique vchost IDs specified. Enter multiple vchost IDs in a comma-separated format. For example, vchostid01,vchostid02.

  • endpoints (list[str], optional) – Performs the operation on the unique endpoints specified. Enter multiple endpoints in a comma-separated format.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

delete_volume_groups(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, eradicate_contents: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

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 (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • eradicate_contents (bool, optional) – Set to true to eradicate contents (e.g., volumes, protection groups, snapshots) and containers (e.g., pods, volume groups). This enables you to eradicate containers with contents.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

delete_volume_snapshots(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, replication_snapshot: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

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 (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • replication_snapshot (bool, optional) – 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) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

delete_volume_snapshots_tags(resources: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, keys: Optional[List[str]] = None, namespaces: Optional[List[str]] = None, resource_ids: Optional[List[str]] = None, resource_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Deletes specified tags.

Parameters

  • resources (list[FixedReference], optional) – A list of resources to query for. Overrides resource_ids and resource_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • keys (list[str], optional) – A list of tag keys.

  • namespaces (list[str], optional) – A list of namespaces. Only one namespace is allowed per delete request.

  • resource_ids (list[str], optional) – A list of resource IDs. The resource_ids or resource_names parameter is required, but they cannot be set together.

  • resource_names (list[str], optional) – A list of resource names. The resource_ids or resource_names parameter is required, but they cannot be set together.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

delete_volumes(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

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 (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

delete_volumes_protection_groups(groups: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, group_ids: Optional[List[str]] = None, group_names: Optional[List[str]] = None, member_names: Optional[List[str]] = None, member_ids: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Deletes a 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

  • groups (list[FixedReference], optional) – A list of groups to query for. Overrides group_ids and group_names keyword arguments.

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_names and member_ids keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • group_ids (list[str], optional) – A list of group IDs.

  • group_names (list[str], optional) – 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], optional) – 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_ids (list[str], optional) – 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.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

delete_volumes_tags(resources: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, keys: Optional[List[str]] = None, namespaces: Optional[List[str]] = None, resource_ids: Optional[List[str]] = None, resource_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

Deletes specified tags.

Parameters

  • resources (list[FixedReference], optional) – A list of resources to query for. Overrides resource_ids and resource_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • keys (list[str], optional) – A list of tag keys.

  • namespaces (list[str], optional) – A list of namespaces. Only one namespace is allowed per delete request.

  • resource_ids (list[str], optional) – A list of resource IDs. The resource_ids or resource_names parameter is required, but they cannot be set together.

  • resource_names (list[str], optional) – A list of resource names. The resource_ids or resource_names parameter is required, but they cannot be set together.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_access_token(refresh=False)

Get the last used access token.

Parameters

refresh (bool, optional) – Whether to retrieve a new access token. Defaults to False.

Returns

str

Raises

PureError – If there was an error retrieving an access token.

get_active_directory(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ActiveDirectoryGetResponse

Displays configured Active Directory accounts.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_admins(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, expose_api_token: Optional[bool] = None, expose_public_key: Optional[bool] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → AdminGetResponse

Displays a list of administrators.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • expose_api_token (bool, optional) – If true, exposes the API token of the current user.

  • expose_public_key (bool, optional) – If true, exposes the public key of the current user.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_admins_api_tokens(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, expose_api_token: Optional[bool] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → AdminApiTokenGetResponse

Displays API tokens for the specified administrators.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • expose_api_token (bool, optional) – If true, exposes the API token of the current user.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_admins_cache(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → AdminCacheGetResponse

Displays entries in the administrator cache.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_admins_settings(authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → AdminSettingsResponse

Displays the global administrator settings for the array.

Parameters

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_alert_watchers(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → AlertWatcherGetResponse

Displays alert watcher email addressess and indicates whether they are enabled.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_alert_watchers_test(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → TestResultWithResourceGetResponse

Displays alert watcher email test results.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_alerts(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, flagged: Optional[bool] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → AlertGetResponse

Displays a list of alerts.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • flagged (bool, optional) – 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], optional) – 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_alerts_events(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, flagged: Optional[bool] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → AlertEventGetResponse

Displays a list of alert events.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • flagged (bool, optional) – 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], optional) – 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. 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, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_alerts_rules(authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, code: Optional[int] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → AlertRulesGetResponse

Displays a list of custom alert rules.

Parameters

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • code (int, optional) – The alert code to display.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_alerts_rules_catalog(authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, code: Optional[int] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → AlertRulesCatalogGetResponse

Displays a list of available customizable alert codes.

Parameters

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • code (int, optional) – The alert code to display.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_api_clients(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ApiClientGetResponse

Returns a list of API clients.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_apps(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → AppGetResponse

Displays a list of installed apps.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_apps_nodes(apps: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, app_names: Optional[List[str]] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → AppNodeGetResponse

Displays a list of installed apps and their nodes.

Parameters

  • apps (list[FixedReference], optional) – A list of apps to query for. Overrides app_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • app_names (list[str], optional) – The name of the installed app. Enter multiple names in comma-separated format.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_array_connections(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ArrayConnectionGetResponse

Displays a list of connected arrays.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_array_connections_connection_key(authorization: Optional[str] = None, x_request_id: Optional[str] = None, encrypted: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ArrayConnectionKeyGetResponse

Displays the connection key for the array.

Parameters

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • encrypted (bool, optional) – 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) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_array_connections_path(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ArrayConnectionPathGetResponse

Displays the connection path from the array to which the connection was made.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_arrays(authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ArrayGetResponse

Displays general array properties including the array name, login banner, idle timeout for management sessions, and NTP servers.

Parameters

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_arrays_cloud_capacity(authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → CloudCapacityGetResponse

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_arrays_cloud_capacity_supported_steps(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → CloudCapacityStepsGetResponse

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_arrays_cloud_provider_tags(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → CloudProviderTagGetResponse

Displays the list of user tags on deployed cloud resources of a CBS array.

Parameters

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_arrays_erasures(authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ArrayErasureGetResponse

Displays a list of factory reset processes.

Parameters

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_arrays_eula(authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → EulaGetResponse

Displays the End User Agreement and signature.

Parameters

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_arrays_factory_reset_token(authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ArrayFactoryResetTokenGetResponse

Displays a list of tokens used to perform a factory reset on the array.

Parameters

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_arrays_ntp_test(authorization: Optional[str] = None, x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → TestResultGetResponse

Displays test results for configured NTP servers.

Parameters

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_arrays_performance(authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, end_time: Optional[int] = None, resolution: Optional[int] = None, start_time: Optional[int] = None, protocol: Optional[str] = None, protocol_group: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ArrayPerformanceGetResponse

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • end_time (int, optional) – 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.

  • resolution (int, optional) – 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.

  • start_time (int, optional) – 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.

  • protocol (str, optional) – Protocol type. Valid values are nfs, smb, and all.

  • protocol_group (str, optional) – Protocol group type. Valid values are block, file, and all.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • end_time (int, optional) – 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.

  • resolution (int, optional) – 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.

  • start_time (int, optional) – 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.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_arrays_space(authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, end_time: Optional[int] = None, resolution: Optional[int] = None, start_time: Optional[int] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ArraySpaceGetResponse

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • end_time (int, optional) – 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.

  • resolution (int, optional) – 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.

  • start_time (int, optional) – 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.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_arrays_tags(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, namespaces: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → TagGetResponse

Displays the list of tags on array objects.

Parameters

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • namespaces (list[str], optional) – A list of namespaces.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_audits(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → AuditGetResponse

Displays a list of audits.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_certificates(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → CertificateGetResponse

Displays certificate attributes.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_connections(host_groups: Optional[List[ReferenceType]] = None, hosts: Optional[List[ReferenceType]] = None, protocol_endpoints: Optional[List[ReferenceType]] = None, volumes: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, host_group_names: Optional[List[str]] = None, host_names: Optional[List[str]] = None, limit: Optional[int] = None, offset: Optional[int] = None, protocol_endpoint_ids: Optional[List[str]] = None, protocol_endpoint_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, volume_names: Optional[List[str]] = None, volume_ids: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ConnectionGetResponse

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

  • host_groups (list[FixedReference], optional) – A list of host_groups to query for. Overrides host_group_names keyword arguments.

  • hosts (list[FixedReference], optional) – A list of hosts to query for. Overrides host_names keyword arguments.

  • protocol_endpoints (list[FixedReference], optional) – A list of protocol_endpoints to query for. Overrides protocol_endpoint_ids and protocol_endpoint_names keyword arguments.

  • volumes (list[FixedReference], optional) – A list of volumes to query for. Overrides volume_names and volume_ids keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • host_group_names (list[str], optional) – 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], optional) – 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – 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], optional) – 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], optional) – 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[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • volume_names (list[str], optional) – 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).

  • volume_ids (list[str], optional) – 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.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_container_default_protections(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ContainerDefaultProtectionGetResponse

Displays a list of containers with its default protections.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – Performs the operation on the 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], optional) – 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.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_controllers(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ControllerGetResponse

Displays the name, mode, FlashArray model, Purity//FA software version, and status of each controller in the array.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_directories(file_systems: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, file_system_ids: Optional[List[str]] = None, file_system_names: Optional[List[str]] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → DirectoryGetResponse

Displays a list of directories, including those pending eradication.

Parameters

  • file_systems (list[FixedReference], optional) – A list of file_systems to query for. Overrides file_system_ids and file_system_names keyword arguments.

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • file_system_ids (list[str], optional) – 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], optional) – Performs the operation on the file system name specified. Enter multiple file system names in comma-separated format. For example, filesystem01,filesystem02.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • total_only (bool, optional) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_directories_performance(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, end_time: Optional[int] = None, resolution: Optional[int] = None, start_time: Optional[int] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, protocol: Optional[str] = None, protocol_group: Optional[str] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → DirectoryPerformanceGetResponse

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 (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • end_time (int, optional) – 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.

  • resolution (int, optional) – 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.

  • start_time (int, optional) – 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.

  • ids (list[str], optional) – 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • protocol (str, optional) – Protocol type. Valid values are nfs, smb, and all.

  • protocol_group (str, optional) – Protocol group type. Valid values are block, file, and all.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • total_only (bool, optional) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_directories_policies(members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberGetResponse

Displays a list of policies that are attached to directories.

Parameters

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • member_ids (list[str], optional) – 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], optional) – 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], optional) – 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], optional) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_directories_policies_autodir(members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberGetResponse

Displays a list of auto managed directory policies that are attached to directories.

Parameters

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • member_ids (list[str], optional) – 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], optional) – 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], optional) – 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], optional) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_directories_policies_nfs(members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberExportGetResponse

Displays a list of NFS policies that are attached to directories.

Parameters

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • member_ids (list[str], optional) – 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], optional) – 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], optional) – 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], optional) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_directories_policies_quota(members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberGetResponse

Displays a list of quota policies that are attached to directories.

Parameters

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • member_ids (list[str], optional) – 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], optional) – 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], optional) – 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], optional) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_directories_policies_smb(members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberExportGetResponse

Displays a list of SMB policies that are attached to directories.

Parameters

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • member_ids (list[str], optional) – 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], optional) – 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], optional) – 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], optional) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_directories_policies_snapshot(members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberGetResponse

Displays a list of snapshot policies that are attached to directories.

Parameters

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • member_ids (list[str], optional) – 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], optional) – 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], optional) – 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], optional) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_directories_space(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, end_time: Optional[int] = None, resolution: Optional[int] = None, start_time: Optional[int] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ResourceDirectorySpaceGetResponse

Displays physical storage consumption data for each directory.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • end_time (int, optional) – 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.

  • resolution (int, optional) – 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.

  • start_time (int, optional) – 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.

  • ids (list[str], optional) – 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • total_only (bool, optional) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_directory_exports(directories: Optional[List[ReferenceType]] = None, exports: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, directory_ids: Optional[List[str]] = None, directory_names: Optional[List[str]] = None, export_names: Optional[List[str]] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → DirectoryExportGetResponse

Displays a list of directory exports.

Parameters

  • directories (list[FixedReference], optional) – A list of directories to query for. Overrides directory_ids and directory_names keyword arguments.

  • exports (list[FixedReference], optional) – A list of exports to query for. Overrides export_names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • directory_ids (list[str], optional) – 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], optional) – 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], optional) – Performs the operation on the export names specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • policy_ids (list[str], optional) – 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], optional) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_directory_quotas(directories: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, directory_ids: Optional[List[str]] = None, directory_names: Optional[List[str]] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → DirectoryQuotasGetResponse

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

  • directories (list[FixedReference], optional) – A list of directories to query for. Overrides directory_ids and directory_names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • directory_ids (list[str], optional) – 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], optional) – 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 (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • policy_ids (list[str], optional) – 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], optional) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_directory_services(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → DirectoryServiceGetResponse

Displays the directory services configuration settings for manageability.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_directory_services_local_groups(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, ids: Optional[List[str]] = None, gids: Optional[List[int]] = None, sids: Optional[List[str]] = None, names: Optional[List[str]] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → LocalGroupGetResponse

Displays a list of local groups.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • ids (list[str], optional) – 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.

  • gids (list[int], optional) – Performs the operation on the specified GIDs. Enter multiple GIDs in comma- separated format. For example, 4234235,9681923.

  • sids (list[str], optional) – 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.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_directory_services_local_groups_members(groups: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, group_names: Optional[List[str]] = None, group_sids: Optional[List[str]] = None, group_gids: Optional[List[int]] = None, member_names: Optional[List[str]] = None, member_sids: Optional[List[str]] = None, member_ids: Optional[List[int]] = None, member_types: Optional[List[str]] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → LocalMembershipGetResponse

Displays a list of local group memberships.

Parameters

  • groups (list[FixedReference], optional) – A list of groups to query for. Overrides group_names keyword arguments.

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_names and member_ids keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • group_names (list[str], optional) – Performs the operation on the group names specified. Enter multiple group names in comma-separated format. For example, group1,group2.

  • group_sids (list[str], optional) – 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.

  • group_gids (list[int], optional) – Performs the operation on the specified GIDs. Enter multiple GIDs in comma- separated format. For example, 4234235,9681923.

  • member_names (list[str], optional) – 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], optional) – 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_ids (list[int], optional) – 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_types (list[str], optional) – 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.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_directory_services_local_users(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, ids: Optional[List[str]] = None, uids: Optional[List[int]] = None, sids: Optional[List[str]] = None, names: Optional[List[str]] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → LocalUserGetResponse

Displays a list of local users.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • ids (list[str], optional) – 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.

  • uids (list[int], optional) – A list of local user IDs (UIDs). Enter multiple local user IDs in comma- separated format. For example, 423,51234.

  • sids (list[str], optional) – 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.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_directory_services_local_users_members(groups: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, group_names: Optional[List[str]] = None, group_sids: Optional[List[str]] = None, group_gids: Optional[List[int]] = None, member_names: Optional[List[str]] = None, member_sids: Optional[List[str]] = None, member_ids: Optional[List[int]] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → LocalMembershipGetResponse

Displays a list of local user memberships.

Parameters

  • groups (list[FixedReference], optional) – A list of groups to query for. Overrides group_names keyword arguments.

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_names and member_ids keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • group_names (list[str], optional) – Performs the operation on the group names specified. Enter multiple group names in comma-separated format. For example, group1,group2.

  • group_sids (list[str], optional) – 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.

  • group_gids (list[int], optional) – Performs the operation on the specified GIDs. Enter multiple GIDs in comma- separated format. For example, 4234235,9681923.

  • member_names (list[str], optional) – 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], optional) – 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_ids (list[int], optional) – 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.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_directory_services_roles(references: Optional[List[ReferenceType]] = None, roles: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, names: Optional[List[str]] = None, limit: Optional[int] = None, offset: Optional[int] = None, role_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → DirectoryServiceRoleGetResponse

Displays the role-based access control (RBAC) group role settings.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • roles (list[FixedReference], optional) – A list of roles to query for. Overrides role_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • names (list[str], optional) – Performs the operation on the unique names specified. For example, GroupRoleMappingName. Enter multiple names in comma-separated format.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • role_names (list[str], optional) – Performs the operation on the unique roles specified. For example, array_admin. Enter multiple roles in comma-separated format.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_directory_services_test(references: Optional[List[ReferenceType]] = None, names: Optional[List[str]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → TestResultWithResourceResponse

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

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • names (list[str], required) – Performs the operation on the unique name specified. For example, name01. Enter multiple names in comma-separated format.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_directory_snapshots(references: Optional[List[ReferenceType]] = None, sources: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, source_ids: Optional[List[str]] = None, source_names: Optional[List[str]] = None, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → DirectorySnapshotGetResponse

Displays a list of directory snapshots, including those pending eradication.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • sources (list[FixedReference], optional) – A list of sources to query for. Overrides source_ids and source_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • source_ids (list[str], optional) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

  • source_names (list[str], optional) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • total_only (bool, optional) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_dns(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → DnsGetResponse

Displays the current DNS configurations and their parameters including domain suffix, the list of DNS name server IP addresses, and the list of services that DNS parameters apply to.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_drives(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → DriveGetResponse

Displays a list of flash, NVRAM, and cache modules that are installed in the array along with their attributes and status.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_file_systems(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → FileSystemGetResponse

Displays a list of file systems, including those pending eradication.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_hardware(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → HardwareGetResponse

Displays a list of hardware slots and bays and status of installed components.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_host_groups(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → HostGroupGetResponse

Displays a list of host groups.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_host_groups_hosts(groups: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, group_names: Optional[List[str]] = None, limit: Optional[int] = None, member_names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → MemberNoIdAllGetResponse

Returns a list of host groups that are associated with hosts.

Parameters

  • groups (list[FixedReference], optional) – A list of groups to query for. Overrides group_names keyword arguments.

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • group_names (list[str], optional) – 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • member_names (list[str], optional) – 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, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_host_groups_performance(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, end_time: Optional[int] = None, resolution: Optional[int] = None, start_time: Optional[int] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ResourcePerformanceNoIdGetResponse

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 (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • end_time (int, optional) – 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.

  • resolution (int, optional) – 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.

  • start_time (int, optional) – 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.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • total_only (bool, optional) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_host_groups_performance_by_array(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, end_time: Optional[int] = None, resolution: Optional[int] = None, start_time: Optional[int] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ResourcePerformanceNoIdByArrayGetResponse

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 (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • end_time (int, optional) – 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.

  • resolution (int, optional) – 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.

  • start_time (int, optional) – 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.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • total_only (bool, optional) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_host_groups_protection_groups(groups: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, group_ids: Optional[List[str]] = None, group_names: Optional[List[str]] = None, limit: Optional[int] = None, member_names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → MemberNoIdMemberGetResponse

Displays a list of host group members that belong to one or more protection groups.

Parameters

  • groups (list[FixedReference], optional) – A list of groups to query for. Overrides group_ids and group_names keyword arguments.

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • group_ids (list[str], optional) – A list of group IDs.

  • group_names (list[str], optional) – 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • member_names (list[str], optional) – 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, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_host_groups_space(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ResourceSpaceNoIdGetResponse

Displays provisioned size and physical storage consumption data for each host group.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_host_groups_tags(resources: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, namespaces: Optional[List[str]] = None, offset: Optional[int] = None, resource_ids: Optional[List[str]] = None, resource_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → TagGetResponse

Displays the list of tags on host group objects.

Parameters

  • resources (list[FixedReference], optional) – A list of resources to query for. Overrides resource_ids and resource_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • namespaces (list[str], optional) – A list of namespaces.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • resource_ids (list[str], optional) – A list of resource IDs. The resource_ids or resource_names parameter is required, but they cannot be set together.

  • resource_names (list[str], optional) – A list of resource names. The resource_ids or resource_names parameter is required, but they cannot be set together.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_hosts(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → HostGetResponse

Displays a list of hosts.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_hosts_host_groups(groups: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, group_names: Optional[List[str]] = None, limit: Optional[int] = None, member_names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → MemberNoIdAllGetResponse

Returns a list of hosts that are associated with host groups.

Parameters

  • groups (list[FixedReference], optional) – A list of groups to query for. Overrides group_names keyword arguments.

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • group_names (list[str], optional) – 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • member_names (list[str], optional) – 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, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_hosts_performance(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, end_time: Optional[int] = None, resolution: Optional[int] = None, start_time: Optional[int] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ResourcePerformanceNoIdGetResponse

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 (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • end_time (int, optional) – 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.

  • resolution (int, optional) – 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.

  • start_time (int, optional) – 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.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • total_only (bool, optional) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_hosts_performance_balance(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → HostPerformanceBalanceGetResponse

Displays the I/O balance statistics for host paths.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_hosts_performance_by_array(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, end_time: Optional[int] = None, resolution: Optional[int] = None, start_time: Optional[int] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ResourcePerformanceNoIdByArrayGetResponse

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 (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • end_time (int, optional) – 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.

  • resolution (int, optional) – 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.

  • start_time (int, optional) – 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.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • total_only (bool, optional) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_hosts_protection_groups(groups: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, group_ids: Optional[List[str]] = None, group_names: Optional[List[str]] = None, limit: Optional[int] = None, member_names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → MemberNoIdMemberGetResponse

Displays a list of host members that belong to one or more protection groups.

Parameters

  • groups (list[FixedReference], optional) – A list of groups to query for. Overrides group_ids and group_names keyword arguments.

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • group_ids (list[str], optional) – A list of group IDs.

  • group_names (list[str], optional) – 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • member_names (list[str], optional) – 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, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_hosts_space(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ResourceSpaceNoIdGetResponse

Displays provisioned size and physical storage consumption data for each host.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_hosts_tags(resources: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, namespaces: Optional[List[str]] = None, offset: Optional[int] = None, resource_ids: Optional[List[str]] = None, resource_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → TagGetResponse

Displays the list of tags on host objects.

Parameters

  • resources (list[FixedReference], optional) – A list of resources to query for. Overrides resource_ids and resource_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • namespaces (list[str], optional) – A list of namespaces.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • resource_ids (list[str], optional) – A list of resource IDs. The resource_ids or resource_names parameter is required, but they cannot be set together.

  • resource_names (list[str], optional) – A list of resource names. The resource_ids or resource_names parameter is required, but they cannot be set together.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_kmip(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → KmipGetResponse

Displays the list of KMIP server objects.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_kmip_test(references: Optional[List[ReferenceType]] = None, names: Optional[List[str]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → KmipTestResultGetResponse

Displays communication data between a FlashArray and KMIP server.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • names (list[str], required) – Performs the operation on the unique name specified. For example, name01. Enter multiple names in comma-separated format.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_maintenance_windows(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → MaintenanceWindowsGetResponse

Displays maintenance window details, including start time, end time, and maintenance type.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_network_interfaces(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → NetworkInterfaceGetResponse

Displays all network interfaces for all controllers on the array.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_network_interfaces_neighbors(local_ports: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, local_port_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → NetworkInterfaceNeighborGetResponse

Displays all neighbors for all network interfaces on the array.

Parameters

  • local_ports (list[FixedReference], optional) – A list of local_ports to query for. Overrides local_port_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • local_port_names (list[str], optional) – 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[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_network_interfaces_performance(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, end_time: Optional[int] = None, resolution: Optional[int] = None, start_time: Optional[int] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → NetworkInterfacePerformanceGetResponse

Displays network statistics, historical bandwidth, and error reporting for all specified network interfaces.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • end_time (int, optional) – 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.

  • resolution (int, optional) – 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.

  • start_time (int, optional) – 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.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • total_only (bool, optional) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_network_interfaces_port_details(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → NetworkInterfacesPortDetailsGetResponse

Displays Ethernet and Fibre Channel SFP details.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_offloads(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, protocol: Optional[str] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → OffloadGetResponse

Displays a list of offload targets that are connected to the array.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • protocol (str, optional) – Protocol type. Valid values are azure, google-cloud, nfs, and s3.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • total_only (bool, optional) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

Displays the list of pod replica links that are configured between arrays.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids keyword arguments.

  • local_pods (list[FixedReference], optional) – A list of local_pods to query for. Overrides local_pod_ids and local_pod_names keyword arguments.

  • remotes (list[FixedReference], optional) – A list of remotes to query for. Overrides remote_ids and remote_names keyword arguments.

  • remote_pods (list[FixedReference], optional) – A list of remote_pods to query for. Overrides remote_pod_ids and remote_pod_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • local_pod_ids (list[str], optional) – A 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], optional) – A 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, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • remote_ids (list[str], optional) – A list of remote array IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_names query parameter.

  • remote_names (list[str], optional) – A list of remote array names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_ids query parameter.

  • remote_pod_ids (list[str], optional) – A 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], optional) – A 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[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

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

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids keyword arguments.

  • local_pods (list[FixedReference], optional) – A list of local_pods to query for. Overrides local_pod_ids and local_pod_names keyword arguments.

  • remotes (list[FixedReference], optional) – A list of remotes to query for. Overrides remote_ids and remote_names keyword arguments.

  • remote_pods (list[FixedReference], optional) – A list of remote_pods to query for. Overrides remote_pod_ids and remote_pod_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – 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.

  • end_time (int, optional) – 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.

  • resolution (int, optional) – 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.

  • start_time (int, optional) – 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.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • local_pod_ids (list[str], optional) – A 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], optional) – A 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, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • remote_ids (list[str], optional) – A list of remote array IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_names query parameter.

  • remote_names (list[str], optional) – A list of remote array names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_ids query parameter.

  • remote_pod_ids (list[str], optional) – A 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], optional) – A 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[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

Displays a list of policy mappings.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids keyword arguments.

  • local_pods (list[FixedReference], optional) – A list of local_pods to query for. Overrides local_pod_ids and local_pod_names keyword arguments.

  • pod_replica_links (list[FixedReference], optional) – A list of pod_replica_links to query for. Overrides pod_replica_link_ids keyword arguments.

  • remotes (list[FixedReference], optional) – A list of remotes to query for. Overrides remote_ids and remote_names keyword arguments.

  • remote_pods (list[FixedReference], optional) – A list of remote_pods to query for. Overrides remote_pod_ids and remote_pod_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • local_pod_ids (list[str], optional) – A 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], optional) – A 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, optional) – 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], optional) – A 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], optional) – A list of remote array IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_names query parameter.

  • remote_names (list[str], optional) – A list of remote array names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_ids query parameter.

  • remote_pod_ids (list[str], optional) – A 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], optional) – A 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[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids keyword arguments.

  • local_pods (list[FixedReference], optional) – A list of local_pods to query for. Overrides local_pod_ids and local_pod_names keyword arguments.

  • remotes (list[FixedReference], optional) – A list of remotes to query for. Overrides remote_ids and remote_names keyword arguments.

  • remote_pods (list[FixedReference], optional) – A list of remote_pods to query for. Overrides remote_pod_ids and remote_pod_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • end_time (int, optional) – 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.

  • resolution (int, optional) – 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.

  • start_time (int, optional) – 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.

  • ids (list[str], optional) – 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • local_pod_ids (list[str], optional) – A 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], optional) – A 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, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • remote_ids (list[str], optional) – A list of remote array IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_names query parameter.

  • remote_names (list[str], optional) – A list of remote array names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_ids query parameter.

  • remote_pod_ids (list[str], optional) – A 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], optional) – A 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[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • total_only (bool, optional) – 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) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_pods(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PodGetResponse

Displays a list of pods that are stretched to this array.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • total_only (bool, optional) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_pods_arrays(groups: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, group_names: Optional[List[str]] = None, group_ids: Optional[List[str]] = None, limit: Optional[int] = None, member_names: Optional[List[str]] = None, member_ids: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → MemberGetResponse

Returns a list of pods and the local and remote arrays over which the pods are stretched. 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.

Parameters

  • groups (list[FixedReference], optional) – A list of groups to query for. Overrides group_names and group_ids keyword arguments.

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_names and member_ids keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • group_names (list[str], optional) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

  • group_ids (list[str], optional) – A list of group IDs.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • member_names (list[str], optional) – 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_ids (list[str], optional) – 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.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_pods_performance(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, end_time: Optional[int] = None, resolution: Optional[int] = None, start_time: Optional[int] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, protocol: Optional[str] = None, protocol_group: Optional[str] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PodPerformanceGetResponse

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 (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • end_time (int, optional) – 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.

  • resolution (int, optional) – 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.

  • start_time (int, optional) – 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.

  • ids (list[str], optional) – 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • protocol (str, optional) – Protocol type. Valid values are nfs, smb, and all.

  • protocol_group (str, optional) – Protocol group type. Valid values are block, file, and all.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • total_only (bool, optional) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_pods_performance_by_array(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, end_time: Optional[int] = None, resolution: Optional[int] = None, start_time: Optional[int] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, protocol: Optional[str] = None, protocol_group: Optional[str] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PodPerformanceByArrayGetResponse

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 (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • end_time (int, optional) – 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.

  • resolution (int, optional) – 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.

  • start_time (int, optional) – 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.

  • ids (list[str], optional) – 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • protocol (str, optional) – Protocol type. Valid values are nfs, smb, and all.

  • protocol_group (str, optional) – Protocol group type. Valid values are block, file, and all.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • total_only (bool, optional) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_pods_performance_replication(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, end_time: Optional[int] = None, resolution: Optional[int] = None, start_time: Optional[int] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PodPerformanceReplicationGetResponse

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 (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • end_time (int, optional) – 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.

  • resolution (int, optional) – 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.

  • start_time (int, optional) – 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.

  • ids (list[str], optional) – 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • total_only (bool, optional) – 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) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_pods_performance_replication_by_array(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, end_time: Optional[int] = None, resolution: Optional[int] = None, start_time: Optional[int] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PodPerformanceReplicationByArrayGetResponse

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 (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • end_time (int, optional) – 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.

  • resolution (int, optional) – 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.

  • start_time (int, optional) – 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.

  • ids (list[str], optional) – 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • total_only (bool, optional) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_pods_space(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, end_time: Optional[int] = None, resolution: Optional[int] = None, start_time: Optional[int] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ResourcePodSpaceGetResponse

Displays provisioned size and physical storage consumption data for each pod on the local array.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • end_time (int, optional) – 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.

  • resolution (int, optional) – 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.

  • start_time (int, optional) – 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.

  • ids (list[str], optional) – 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • total_only (bool, optional) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_policies(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyGetResponse

Displays a list of policies.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_policies_alert_watcher(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyGetResponse

Displays a list of alert-watcher policies.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_policies_alert_watcher_members(members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, member_types: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberGetResponse

Displays a list of alert-watcher policy members.

Parameters

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • member_ids (list[str], optional) – 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], optional) – 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], optional) – 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], optional) – 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], optional) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_policies_alert_watcher_rules(references: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyRuleAlertWatcherGetResponse

Displays a list of alert-watcher policy rules.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • policy_ids (list[str], optional) – 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], optional) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_policies_alert_watcher_rules_test(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → TestResultWithResourceGetResponse

Displays alert-watcher policy rule email test results.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_policies_autodir(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyGetResponse

Displays a list of auto managed directory policies.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_policies_autodir_members(members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, member_types: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberGetResponse

Displays a list of auto managed directory policy members.

Parameters

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • member_ids (list[str], optional) – 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], optional) – 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], optional) – 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], optional) – 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], optional) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_policies_members(members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, member_types: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberGetResponse

Displays a list of policy members.

Parameters

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • member_ids (list[str], optional) – 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], optional) – 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], optional) – 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], optional) – 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], optional) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_policies_nfs(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyNfsGetResponse

Displays a list of NFS policies.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_policies_nfs_client_rules(references: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyRuleNfsClientGetResponse

Displays a list of NFS client policy rules.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • policy_ids (list[str], optional) – 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], optional) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_policies_nfs_members(members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, member_types: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberExportGetResponse

Displays a list of NFS policy members.

Parameters

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • member_ids (list[str], optional) – 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], optional) – 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], optional) – 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], optional) – 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], optional) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_policies_password(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyPasswordGetResponse

Displays a list of password policies.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_policies_quota(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyGetResponse

Displays a list of quota policies.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_policies_quota_members(members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, member_types: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberGetResponse

Displays a list of quota policy members.

Parameters

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • member_ids (list[str], optional) – 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], optional) – 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], optional) – 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], optional) – 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], optional) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_policies_quota_rules(references: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyRuleQuotaGetResponse

Displays a list of quota policy rules.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • policy_ids (list[str], optional) – 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], optional) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_policies_smb(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicySmbGetResponse

Displays a list of SMB policies.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_policies_smb_client_rules(references: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyRuleSmbClientGetResponse

Displays a list of SMB client policy rules.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • policy_ids (list[str], optional) – 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], optional) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_policies_smb_members(members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, member_types: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberExportGetResponse

Displays a list of SMB policy members.

Parameters

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • member_ids (list[str], optional) – 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], optional) – 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], optional) – 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], optional) – 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], optional) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_policies_snapshot(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyGetResponse

Displays a list of snapshot policies.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_policies_snapshot_members(members: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, member_types: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberGetResponse

Displays a list of snapshot policy members.

Parameters

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • member_ids (list[str], optional) – 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], optional) – 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], optional) – 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], optional) – 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], optional) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_policies_snapshot_rules(references: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyRuleSnapshotGetResponse

Displays a list of snapshot policy rules.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • policy_ids (list[str], optional) – 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], optional) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_ports(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PortGetResponse

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 (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_ports_initiators(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PortInitiatorsGetResponse

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 (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_protection_group_snapshots(references: Optional[List[ReferenceType]] = None, sources: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, limit: Optional[int] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, source_names: Optional[List[str]] = None, source_ids: Optional[List[str]] = None, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ProtectionGroupSnapshotGetResponse

Displays a list of protection group snapshots, including those pending eradication.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • sources (list[FixedReference], optional) – A list of sources to query for. Overrides source_names and source_ids keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • ids (list[str], optional) – 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], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • source_names (list[str], optional) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

  • source_ids (list[str], optional) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • total_only (bool, optional) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_protection_group_snapshots_transfer(references: Optional[List[ReferenceType]] = None, sources: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, source_ids: Optional[List[str]] = None, source_names: Optional[List[str]] = None, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ProtectionGroupSnapshotTransferGetResponse

Displays a list of protection group snapshots and corresponding transfer statistics.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • sources (list[FixedReference], optional) – A list of sources to query for. Overrides source_ids and source_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • source_ids (list[str], optional) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

  • source_names (list[str], optional) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • total_only (bool, optional) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_protection_groups(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ProtectionGroupGetResponse

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 (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • total_only (bool, optional) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_protection_groups_host_groups(groups: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, group_ids: Optional[List[str]] = None, group_names: Optional[List[str]] = None, limit: Optional[int] = None, member_names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → MemberNoIdMemberGetResponse

Displays a list of protection groups that have host group members.

Parameters

  • groups (list[FixedReference], optional) – A list of groups to query for. Overrides group_ids and group_names keyword arguments.

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • group_ids (list[str], optional) – A list of group IDs.

  • group_names (list[str], optional) – 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • member_names (list[str], optional) – 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, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_protection_groups_hosts(groups: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, group_ids: Optional[List[str]] = None, group_names: Optional[List[str]] = None, limit: Optional[int] = None, member_names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → MemberNoIdMemberGetResponse

Displays a list of protection groups that have host members.

Parameters

  • groups (list[FixedReference], optional) – A list of groups to query for. Overrides group_ids and group_names keyword arguments.

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • group_ids (list[str], optional) – A list of group IDs.

  • group_names (list[str], optional) – 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • member_names (list[str], optional) – 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, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_protection_groups_performance_replication(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, end_time: Optional[int] = None, resolution: Optional[int] = None, start_time: Optional[int] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ProtectionGroupPerformanceResponse

Displays the total number of bytes of replication data transmitted and received per second. The data is grouped by protection group.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • end_time (int, optional) – 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.

  • resolution (int, optional) – 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.

  • start_time (int, optional) – 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.

  • ids (list[str], optional) – 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], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_protection_groups_performance_replication_by_array(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, end_time: Optional[int] = None, resolution: Optional[int] = None, start_time: Optional[int] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ProtectionGroupPerformanceArrayResponse

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 (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • end_time (int, optional) – 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.

  • resolution (int, optional) – 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.

  • start_time (int, optional) – 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.

  • ids (list[str], optional) – 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], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_protection_groups_space(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, limit: Optional[int] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ResourceSpaceGetResponse

Displays provisioned size and physical storage consumption data for each protection group.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • ids (list[str], optional) – 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], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • total_only (bool, optional) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_protection_groups_targets(groups: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, group_ids: Optional[List[str]] = None, group_names: Optional[List[str]] = None, limit: Optional[int] = None, member_names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ProtectionGroupTargetGetResponse

Displays a list of protection groups that have target arrays or offload targets.

Parameters

  • groups (list[FixedReference], optional) – A list of groups to query for. Overrides group_ids and group_names keyword arguments.

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • group_ids (list[str], optional) – A list of group IDs.

  • group_names (list[str], optional) – 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • member_names (list[str], optional) – 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, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_protection_groups_volumes(groups: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, group_ids: Optional[List[str]] = None, group_names: Optional[List[str]] = None, limit: Optional[int] = None, member_destroyed: Optional[bool] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ProtectionGroupsVolumesGetResponse

Displays a list of protection groups that have volume members.

Parameters

  • groups (list[FixedReference], optional) – A list of groups to query for. Overrides group_ids and group_names keyword arguments.

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • group_ids (list[str], optional) – 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], optional) – 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • member_destroyed (bool, optional) – 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], optional) – 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], optional) – 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, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_remote_pods(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, on: Optional[List[str]] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → RemotePodsResponse

Returns a list of pods that that are on connected arrays but not stretched to this array.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • on (list[str], optional) – Performs the operation on the target name specified. Enter multiple target names in comma-separated format. For example, targetName01,targetName02.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_remote_protection_group_snapshots(references: Optional[List[ReferenceType]] = None, sources: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, limit: Optional[int] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, on: Optional[List[str]] = None, sort: Optional[List[str]] = None, source_ids: Optional[List[str]] = None, source_names: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → RemoteProtectionGroupSnapshotGetResponse

Displays a list of remote protection group snapshots.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • sources (list[FixedReference], optional) – A list of sources to query for. Overrides source_ids and source_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • ids (list[str], optional) – 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], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • on (list[str], optional) – Performs the operation on the target name specified. Enter multiple target names in comma-separated format. For example, targetName01,targetName02.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • source_ids (list[str], optional) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

  • source_names (list[str], optional) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_remote_protection_group_snapshots_transfer(references: Optional[List[ReferenceType]] = None, sources: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, limit: Optional[int] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, on: Optional[List[str]] = None, sort: Optional[List[str]] = None, source_ids: Optional[List[str]] = None, source_names: Optional[List[str]] = None, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → RemoteProtectionGroupSnapshotTransferGetResponse

Displays a list of remote protection groups and their transfer statistics.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • sources (list[FixedReference], optional) – A list of sources to query for. Overrides source_ids and source_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • ids (list[str], optional) – 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], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • on (list[str], optional) – Performs the operation on the target name specified. Enter multiple target names in comma-separated format. For example, targetName01,targetName02.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • source_ids (list[str], optional) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

  • source_names (list[str], optional) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • total_only (bool, optional) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_remote_protection_groups(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, on: Optional[List[str]] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → RemoteProtectionGroupGetResponse

Returns a list of remote protection groups.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • on (list[str], optional) – Performs the operation on the target name specified. Enter multiple target names in comma-separated format. For example, targetName01,targetName02.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_remote_volume_snapshots(references: Optional[List[ReferenceType]] = None, sources: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, on: Optional[List[str]] = None, sort: Optional[List[str]] = None, source_ids: Optional[List[str]] = None, source_names: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → RemoteVolumeSnapshotGetResponse

Displays a list of remote volume snapshots.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • sources (list[FixedReference], optional) – A list of sources to query for. Overrides source_ids and source_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • on (list[str], optional) – Performs the operation on the target name specified. Enter multiple target names in comma-separated format. For example, targetName01,targetName02.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • source_ids (list[str], optional) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

  • source_names (list[str], optional) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_remote_volume_snapshots_transfer(references: Optional[List[ReferenceType]] = None, sources: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, offset: Optional[int] = None, on: Optional[List[str]] = None, sort: Optional[List[str]] = None, source_ids: Optional[List[str]] = None, source_names: Optional[List[str]] = None, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → RemoteVolumeSnapshotTransferGetResponse

Returns a list of remote volume snapshots and their transfer statistics.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • sources (list[FixedReference], optional) – A list of sources to query for. Overrides source_ids and source_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • on (list[str], optional) – Performs the operation on the target name specified. Enter multiple target names in comma-separated format. For example, targetName01,targetName02.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • source_ids (list[str], optional) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

  • source_names (list[str], optional) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • total_only (bool, optional) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_rest_version()

Get the REST API version being used by this client.

Returns

str

get_sessions(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SessionGetResponse

Displays session data for user login events performed in the Purity//FA GUI, CLI, and REST API.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_smi_s(authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SmisGetResponse

Displays the SMI-S settings, including whether SLP and WBEM-HTTPS are enabled.

Parameters

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_smtp_servers(authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SmtpServerGetResponse

Displays SMTP server attributes. Values include user_name, password, relay_host, sender_domain, sender_username, subject_prefix, body_prefix, encryption_mode, and name.

Parameters

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_snmp_agents(authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SnmpAgentGetResponse

Displays the SNMP agent name and protocol attributes.

Parameters

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_snmp_agents_mib(authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SnmpAgentMibGetResponse

Displays the SNMP MIB text.

Parameters

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_snmp_managers(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SnmpManagerGetResponse

Displays designated SNMP managers and their communication and security attributes.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_snmp_managers_test(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → TestResultWithResourceGetResponse

Displays SNMP manager test results (traps or informs).

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_software(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, versions: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SoftwareGetResponse

Displays a list of available software packages.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • versions (list[str], optional) – A list of versions.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_software_bundle(references: Optional[List[ReferenceType]] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SoftwareBundleGetResponse

Displays a list of software bundles.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_software_check(references: Optional[List[ReferenceType]] = None, softwares: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, software_versions: Optional[List[str]] = None, software_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SoftwareChecksGetResponse

Displays a list of software check tasks.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • softwares (list[FixedReference], optional) – A list of softwares to query for. Overrides software_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • software_versions (list[str], optional) – A list of target software versions.

  • software_names (list[str], optional) – A list of software names.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_software_installation_steps(references: Optional[List[ReferenceType]] = None, software_installations: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, software_installation_ids: Optional[List[str]] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SoftwareInstallationStepsGetResponse

Displays a list of currently running and completed software upgrade steps.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • software_installations (list[FixedReference], optional) – A list of software_installations to query for. Overrides software_installation_ids keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • software_installation_ids (list[str], optional) – A list of software installation IDs.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_software_installations(references: Optional[List[ReferenceType]] = None, softwares: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, software_ids: Optional[List[str]] = None, software_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SoftwareInstallationsGetResponse

Displays a list of software upgrades, including currently running and past upgrades.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • softwares (list[FixedReference], optional) – A list of softwares to query for. Overrides software_ids and software_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • software_ids (list[str], optional) – A list of software IDs.

  • software_names (list[str], optional) – A list of software names.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_software_patches(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SoftwarePatchesGetResponse

Displays a list of software patches.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_software_patches_catalog(authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SoftwarePatchesGetResponse

Displays a list of available software patches.

Parameters

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_software_versions(authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SoftwareVersionsGetResponse

Displays a list of software versions.

Parameters

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_sso_saml2_idps(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → Saml2SsoGetResponse

Displays the SAML2 SSO service provider and identity provider configuration settings in the array.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_sso_saml2_idps_test(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → TestResultWithResourceResponse

Displays the existing SAML2 SSO configurations in the array.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_subnets(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SubnetGetResponse

Displays a list of subnets with statuses and attributes.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_subscription_assets(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, names: Optional[List[str]] = None, ids: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SubscriptionAssetGetResponse

Displays information about subscription assets.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names and ids keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • ids (list[str], optional) – 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.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_subscriptions(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, ids: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SubscriptionGetResponse

Displays information about subscriptions.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • ids (list[str], optional) – 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.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_support(authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SupportGetResponse

Displays connection paths between the current array and each connected array.

Parameters

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_support_test(authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, test_type: Optional[str] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → TestResultGetResponse

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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • test_type (str, optional) – Specifies the type of test. Valid values are all, phonehome, and remote- assist. If not specified, defaults to all.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_syslog_servers(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SyslogServerGetResponse

Displays a list of configured syslog servers.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_syslog_servers_settings(authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SyslogServerSettingsGetResponse

Displays syslog settings. Values include continuation_token, items, more_items_remaining, and total_item_count.

Parameters

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_syslog_servers_test(authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → TestResultWithResourceGetResponse

Displays syslog server test results, which indicate whether the syslog is working and configured correctly.

Parameters

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_vchost_connections(protocol_endpoints: Optional[List[ReferenceType]] = None, vchosts: Optional[List[ReferenceType]] = None, all_vchosts: Optional[bool] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, protocol_endpoint_ids: Optional[List[str]] = None, protocol_endpoint_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, vchost_ids: Optional[List[str]] = None, vchost_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → VchostConnectionGetResponse

Displays a list of vchost-connections between the protocol endpoint and vchost.

Parameters

  • protocol_endpoints (list[FixedReference], optional) – A list of protocol_endpoints to query for. Overrides protocol_endpoint_ids and protocol_endpoint_names keyword arguments.

  • vchosts (list[FixedReference], optional) – A list of vchosts to query for. Overrides vchost_ids and vchost_names keyword arguments.

  • all_vchosts (bool, optional) – 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.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • protocol_endpoint_ids (list[str], optional) – A 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], optional) – A 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[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • vchost_ids (list[str], optional) – A 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], optional) – A 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) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_vchosts(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, names: Optional[List[str]] = None, ids: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → VchostGetResponse

Displays a list of vchosts.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names and ids keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • ids (list[str], optional) – 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.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_vchosts_certificates(references: Optional[List[ReferenceType]] = None, vchosts: Optional[List[ReferenceType]] = None, certificates: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, ids: Optional[List[str]] = None, vchost_names: Optional[List[str]] = None, vchost_ids: Optional[List[str]] = None, certificate_names: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → VchostCertificateGetResponse

Displays certificates that are attached to configured vchosts on at least one endpoint.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids keyword arguments.

  • vchosts (list[FixedReference], optional) – A list of vchosts to query for. Overrides vchost_names and vchost_ids keyword arguments.

  • certificates (list[FixedReference], optional) – A list of certificates to query for. Overrides certificate_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • ids (list[str], optional) – 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_names (list[str], optional) – Performs the operation on the unique vchost name specified. Enter multiple names in a comma-separated format. For example, vchost01,vchost02.

  • vchost_ids (list[str], optional) – Performs the operation on the unique vchost IDs specified. Enter multiple vchost IDs in a comma-separated format. For example, vchostid01,vchostid02.

  • certificate_names (list[str], optional) – The names of one or more certificates. Enter multiple names in comma-separated format. For example, cert01,cert02.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_vchosts_endpoints(references: Optional[List[ReferenceType]] = None, vchosts: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, ids: Optional[List[str]] = None, vchost_names: Optional[List[str]] = None, vchost_ids: Optional[List[str]] = None, endpoints: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → VchostEndpointGetResponse

Displays a list of vchost endpoints with their associated vchosts and certificates.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids keyword arguments.

  • vchosts (list[FixedReference], optional) – A list of vchosts to query for. Overrides vchost_names and vchost_ids keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • ids (list[str], optional) – 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_names (list[str], optional) – Performs the operation on the unique vchost name specified. Enter multiple names in a comma-separated format. For example, vchost01,vchost02.

  • vchost_ids (list[str], optional) – Performs the operation on the unique vchost IDs specified. Enter multiple vchost IDs in a comma-separated format. For example, vchostid01,vchostid02.

  • endpoints (list[str], optional) – Performs the operation on the unique endpoints specified. Enter multiple endpoints in a comma-separated format.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_virtual_machine_snapshots(vms: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, vm_type: Optional[str] = None, vm_ids: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → VirtualMachineGetResponse

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 (list[FixedReference], optional) – A list of vms to query for. Overrides vm_ids keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • vm_type (str, optional) – The type of virtual machine. The only valid value is vvol.

  • vm_ids (list[str], optional) – Performs the operation on the unique virtual machine IDs specified. Enter multiple resource IDs in a comma-separated format.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_virtual_machines(vms: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, vm_type: Optional[str] = None, vm_ids: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → VirtualMachineGetResponse

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 (list[FixedReference], optional) – A list of vms to query for. Overrides vm_ids keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • vm_type (str, optional) – The type of virtual machine. The only valid value is vvol.

  • vm_ids (list[str], optional) – Performs the operation on the unique virtual machine IDs specified. Enter multiple virtual machine IDs in a comma-separated format.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_volume_groups(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → VolumeGroupGetResponse

Displays a list of volume groups, including those pending eradication.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • total_only (bool, optional) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_volume_groups_performance(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, end_time: Optional[int] = None, resolution: Optional[int] = None, start_time: Optional[int] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ResourcePerformanceGetResponse

Returns 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 (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • end_time (int, optional) – 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.

  • resolution (int, optional) – 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.

  • start_time (int, optional) – 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.

  • ids (list[str], optional) – 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • total_only (bool, optional) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_volume_groups_space(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, end_time: Optional[int] = None, resolution: Optional[int] = None, start_time: Optional[int] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ResourceSpaceGetResponse

Displays the provisioned size and physical storage consumption data for each volume group.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • end_time (int, optional) – 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.

  • resolution (int, optional) – 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.

  • start_time (int, optional) – 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.

  • ids (list[str], optional) – 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • total_only (bool, optional) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_volume_groups_volumes(groups: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, group_ids: Optional[List[str]] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, group_names: Optional[List[str]] = None, member_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → MemberGetResponse

Returns a list of volume groups that contain volumes.

Parameters

  • groups (list[FixedReference], optional) – A list of groups to query for. Overrides group_ids and group_names keyword arguments.

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • group_ids (list[str], optional) – A list of group IDs.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • member_ids (list[str], optional) – 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.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • group_names (list[str], optional) – 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], optional) – 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) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_volume_snapshots(references: Optional[List[ReferenceType]] = None, sources: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, source_ids: Optional[List[str]] = None, source_names: Optional[List[str]] = None, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → VolumeSnapshotGetResponse

Displays a list of volume snapshots, including those pending eradication.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • sources (list[FixedReference], optional) – A list of sources to query for. Overrides source_ids and source_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • source_ids (list[str], optional) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

  • source_names (list[str], optional) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • total_only (bool, optional) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_volume_snapshots_tags(resources: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, namespaces: Optional[List[str]] = None, offset: Optional[int] = None, resource_destroyed: Optional[bool] = None, resource_ids: Optional[List[str]] = None, resource_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → TagGetResponse

Displays the list of tags.

Parameters

  • resources (list[FixedReference], optional) – A list of resources to query for. Overrides resource_ids and resource_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • namespaces (list[str], optional) – A list of namespaces.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • resource_destroyed (bool, optional) – 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], optional) – A list of resource IDs. The resource_ids or resource_names parameter is required, but they cannot be set together.

  • resource_names (list[str], optional) – A list of resource names. The resource_ids or resource_names parameter is required, but they cannot be set together.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_volume_snapshots_transfer(references: Optional[List[ReferenceType]] = None, sources: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, source_ids: Optional[List[str]] = None, source_names: Optional[List[str]] = None, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → VolumeSnapshotTransferGetResponse

Displays a list of volume snapshots and their transfer statistics.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • sources (list[FixedReference], optional) – A list of sources to query for. Overrides source_ids and source_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • source_ids (list[str], optional) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

  • source_names (list[str], optional) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • total_only (bool, optional) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_volumes(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → VolumeGetResponse

Displays a list of volumes, including those pending eradication.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • ids (list[str], optional) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • total_only (bool, optional) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_volumes_diff(references: Optional[List[ReferenceType]] = None, segment_length: Optional[int] = None, block_size: Optional[int] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, names: Optional[List[str]] = None, ids: Optional[List[str]] = None, base_name: Optional[str] = None, base_id: Optional[str] = None, segment_offset: Optional[int] = None, next_allocated_block_hint: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → VolumesDiffGetResponse

Displays block differences for the specified volumes.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names and ids keyword arguments.

  • segment_length (int, required) – Length of the segment, in bytes, to compare.

  • block_size (int, required) – Granularity at which to compare, in bytes. Must be a multiple of 512.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • ids (list[str], optional) – 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.

  • base_name (str, optional) – 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.

  • base_id (str, optional) – 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.

  • segment_offset (int, optional) – Absolute offset, in bytes, of the segment to compare. Must be a multiple of block_size.

  • next_allocated_block_hint (bool, optional) – 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.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_volumes_performance(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, end_time: Optional[int] = None, resolution: Optional[int] = None, start_time: Optional[int] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ResourcePerformanceGetResponse

Returns 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 (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • end_time (int, optional) – 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.

  • resolution (int, optional) – 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.

  • start_time (int, optional) – 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.

  • ids (list[str], optional) – 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • total_only (bool, optional) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_volumes_performance_by_array(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, end_time: Optional[int] = None, resolution: Optional[int] = None, start_time: Optional[int] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ResourcePerformanceByArrayGetResponse

Return 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 (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • end_time (int, optional) – 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.

  • resolution (int, optional) – 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.

  • start_time (int, optional) – 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.

  • ids (list[str], optional) – 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • total_only (bool, optional) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_volumes_protection_groups(groups: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, group_ids: Optional[List[str]] = None, group_names: Optional[List[str]] = None, limit: Optional[int] = None, member_destroyed: Optional[bool] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ProtectionGroupsVolumesGetResponse

Displays a list of volume members that belong to one or more protection groups.

Parameters

  • groups (list[FixedReference], optional) – A list of groups to query for. Overrides group_ids and group_names keyword arguments.

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • group_ids (list[str], optional) – A list of group IDs.

  • group_names (list[str], optional) – 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • member_destroyed (bool, optional) – 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], optional) – 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], optional) – 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, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_volumes_space(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, destroyed: Optional[bool] = None, filter: Optional[str] = None, end_time: Optional[int] = None, resolution: Optional[int] = None, start_time: Optional[int] = None, ids: Optional[List[str]] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, total_only: Optional[bool] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → VolumeSpaceGetResponse

Displays the provisioned size and physical storage consumption data for each volume.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • destroyed (bool, optional) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • end_time (int, optional) – 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.

  • resolution (int, optional) – 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.

  • start_time (int, optional) – 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.

  • ids (list[str], optional) – 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, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • total_only (bool, optional) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_volumes_tags(resources: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, limit: Optional[int] = None, namespaces: Optional[List[str]] = None, offset: Optional[int] = None, resource_destroyed: Optional[bool] = None, resource_ids: Optional[List[str]] = None, resource_names: Optional[List[str]] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → TagGetResponse

Displays the list of tags.

Parameters

  • resources (list[FixedReference], optional) – A list of resources to query for. Overrides resource_ids and resource_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • namespaces (list[str], optional) – A list of namespaces.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • resource_destroyed (bool, optional) – 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], optional) – A list of resource IDs. The resource_ids or resource_names parameter is required, but they cannot be set together.

  • resource_names (list[str], optional) – A list of resource names. The resource_ids or resource_names parameter is required, but they cannot be set together.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

get_volumes_volume_groups(groups: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, continuation_token: Optional[str] = None, filter: Optional[str] = None, group_ids: Optional[List[str]] = None, limit: Optional[int] = None, member_ids: Optional[List[str]] = None, offset: Optional[int] = None, sort: Optional[List[str]] = None, total_item_count: Optional[bool] = None, group_names: Optional[List[str]] = None, member_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → MemberGetResponse

Returns a list of volumes that are in a volume group.

Parameters

  • groups (list[FixedReference], optional) – A list of groups to query for. Overrides group_ids and group_names keyword arguments.

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • continuation_token (str, optional) – An opaque token to iterate over a collection of resources.

  • filter (Filter, optional) – A filter to include only resources that match the specified criteria.

  • group_ids (list[str], optional) – A list of group IDs.

  • limit (int, optional) – Limit the number of resources in the response. If not specified, defaults to 1000.

  • member_ids (list[str], optional) – 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.

  • offset (int, optional) – The starting position based on the results of the query in relation to the full set of response objects returned.

  • sort (list[Property], optional) – Sort the response by the specified Properties. Can also be a single element.

  • total_item_count (bool, optional) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

  • group_names (list[str], optional) – 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], optional) – 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) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_active_directory(references: Optional[List[ReferenceType]] = None, names: Optional[List[str]] = None, active_directory: Optional[ActiveDirectoryPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ActiveDirectoryResponse

Modifies specified Active Directory account.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • names (list[str], required) – Performs the operation on the unique name specified. For example, name01. Enter multiple names in comma-separated format.

  • active_directory (ActiveDirectoryPatch, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_admins(references: Optional[List[ReferenceType]] = None, admin: Optional[AdminPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → AdminResponse

Modifies properties for the specified administrator.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • admin (AdminPatch, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_admins_settings(admin_settings: Optional[AdminSettings] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → AdminSettingsResponse

Modifies the global administrator settings for the array.

Parameters

  • admin_settings (AdminSettings, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_alert_watchers(references: Optional[List[ReferenceType]] = None, names: Optional[List[str]] = None, alert_watcher: Optional[AlertWatcherPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → AlertWatcherResponse

Modify alert watcher email address by enabling or disabling it.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • names (list[str], required) – Performs the operation on the unique name specified. For example, name01. Enter multiple names in comma-separated format.

  • alert_watcher (AlertWatcherPatch, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_alerts(references: Optional[List[ReferenceType]] = None, alert: Optional[Alert] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → AlertResponse

Modifies one or more alerts and display updated information about these alerts.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • alert (Alert, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – 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], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_alerts_rules(code: Optional[int] = None, parameter: Optional[str] = None, alert_rule: Optional[AlertRules] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → AlertRulesResponse

Modifies a custom alert rule to a new value.

Parameters

  • code (int, required) – The alert code that the rule applies to. Available alert codes for customization can be found in the alert rules catalog.

  • parameter (str, required) – 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.

  • alert_rule (AlertRules, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_api_clients(references: Optional[List[ReferenceType]] = None, api_clients: Optional[ApiClientPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ApiClientResponse

Enables or disables an API client. The ids or names parameter is required, but they cannot be set together.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • api_clients (ApiClientPatch, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_apps(references: Optional[List[ReferenceType]] = None, names: Optional[List[str]] = None, app: Optional[App] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → AppResponse

Modifies an installed app or modifies Virtual Network Computing (VNC) access for apps that are being patched.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • names (list[str], required) – Performs the operation on the unique name specified. For example, name01. Enter multiple names in comma-separated format.

  • app (App, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_array_connections(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, refresh: Optional[bool] = None, renew_encryption_key: Optional[bool] = None, array_connection: Optional[ArrayConnectionPatch] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ArrayConnectionResponse

Modifies attributes for an array connection.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • refresh (bool, optional) – 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, optional) – 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, optional) –

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_arrays(array: Optional[Arrays] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ArrayResponse

Modifies general array properties such as the array name, login banner, idle timeout for management sessions, and NTP servers.

Parameters

  • array (Arrays, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_arrays_cloud_capacity(capacity: Optional[CloudCapacityStatus] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → CloudCapacityPatchResponse

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, required) – The requested capacity of the CBS array.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_arrays_erasures(delete_sanitization_certificate: Optional[bool] = None, eradicate_all_data: Optional[bool] = None, finalize: Optional[bool] = None, reinstall_image: Optional[bool] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, erasure_patch: Optional[ArrayErasurePatch] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ArrayErasureResponse

Modifies the factory reset process to finalize.

Parameters

  • delete_sanitization_certificate (bool, required) – Set to true to finalize factory reset and acknowledge the deletion of sanitization certificate.

  • eradicate_all_data (bool, required) – Set to true to perform a factory reset.

  • finalize (bool, required) – Must be true to finalize factory reset.

  • reinstall_image (bool, required) – Set to true to reinstall image, or false to skip reinstalling image.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • erasure_patch (ArrayErasurePatch, optional) –

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_arrays_eula(authorization: Optional[str] = None, x_request_id: Optional[str] = None, eula: Optional[Eula] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → EulaResponse

Modifies the signature on the End User Agreement.

Parameters

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • eula (Eula, optional) –

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_certificates(references: Optional[List[ReferenceType]] = None, certificate: Optional[CertificatePost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, generate_new_key: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → CertificateResponse

Modifies certificate attributes. When you modify the attributes of a self-signed certificate, Purity//FA replaces the existing certificate with a new certificate, which is generated with the specified attributes.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • certificate (CertificatePost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • generate_new_key (bool, optional) – 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.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_container_default_protections(references: Optional[List[ReferenceType]] = None, container_default_protection: Optional[ContainerDefaultProtection] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ContainerDefaultProtectionResponse

Modifies a container’s default protections. To modify, set default_protections to the new list.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • container_default_protection (ContainerDefaultProtection, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – Performs the operation on the 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], optional) – 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) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_directories(references: Optional[List[ReferenceType]] = None, directory: Optional[DirectoryPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → DirectoryResponse

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

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • directory (DirectoryPatch, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_directory_exports(directories: Optional[List[ReferenceType]] = None, exports: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, export: Optional[DirectoryExportPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, directory_ids: Optional[List[str]] = None, directory_names: Optional[List[str]] = None, export_names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → DirectoryExportResponse

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

  • directories (list[FixedReference], optional) – A list of directories to query for. Overrides directory_ids and directory_names keyword arguments.

  • exports (list[FixedReference], optional) – A list of exports to query for. Overrides export_names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • export (DirectoryExportPatch, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • directory_ids (list[str], optional) – 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], optional) – 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], optional) – Performs the operation on the export names specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • policy_ids (list[str], optional) – 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], optional) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_directory_services(references: Optional[List[ReferenceType]] = None, names: Optional[List[str]] = None, directory_service: Optional[DirectoryService] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → DirectoryServiceResponse

Modifies the directory service configuration.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • names (list[str], required) – Performs the operation on the unique name specified. For example, name01. Enter multiple names in comma-separated format.

  • directory_service (DirectoryService, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_directory_services_local_groups(references: Optional[List[ReferenceType]] = None, local_group: Optional[LocalGroup] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, sids: Optional[List[str]] = None, gids: Optional[List[int]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → LocalGroupResponse

Modifies local groups.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • local_group (LocalGroup, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • sids (list[str], optional) – 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.

  • gids (list[int], optional) – Performs the operation on the specified GIDs. Enter multiple GIDs in comma- separated format. For example, 4234235,9681923.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_directory_services_local_users(references: Optional[List[ReferenceType]] = None, local_user: Optional[LocalUserPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, keep_open_sessions: Optional[bool] = None, sids: Optional[List[str]] = None, uids: Optional[List[int]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → LocalUserResponse

Modifies a local user.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • local_user (LocalUserPatch, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • keep_open_sessions (bool, optional) – 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.

  • sids (list[str], optional) – 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], optional) – A list of local user IDs (UIDs). Enter multiple local user IDs in comma- separated format. For example, 423,51234.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_directory_services_roles(references: Optional[List[ReferenceType]] = None, roles: Optional[List[ReferenceType]] = None, names: Optional[List[str]] = None, directory_service_roles: Optional[DirectoryServiceRole] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, role_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → DirectoryServiceRoleResponse

Modifies group to role mapping entries

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • roles (list[FixedReference], optional) – A list of roles to query for. Overrides role_names keyword arguments.

  • names (list[str], required) – Performs the operation on the unique names specified. For example, GroupRoleMappingName. Enter multiple names in comma-separated format.

  • directory_service_roles (DirectoryServiceRole, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • role_names (list[str], optional) – Performs the operation on the unique roles specified. For example, array_admin. Enter multiple roles in comma-separated format.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_directory_snapshots(references: Optional[List[ReferenceType]] = None, directory_snapshot: Optional[DirectorySnapshotPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → DirectorySnapshotResponse

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

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • directory_snapshot (DirectorySnapshotPatch, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_dns(references: Optional[List[ReferenceType]] = None, dns: Optional[DnsPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → DnsResponse

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

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • dns (DnsPatch, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_drives(authorization: Optional[str] = None, x_request_id: Optional[str] = None, admit: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → DriveResponse

Modifies flash and NVRAM modules that have been added or connected but not yet admitted to the array.

Parameters

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • admit (bool, optional) – If true, admits any unadmitted drives into the system.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_file_systems(references: Optional[List[ReferenceType]] = None, file_system: Optional[FileSystemPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → FileSystemResponse

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

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • file_system (FileSystemPatch, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – 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], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_hardware(references: Optional[List[ReferenceType]] = None, hardware: Optional[HardwarePatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → HardwareResponse

Modifies the visual identification of a specified hardware component, and causing the ID LED to turn on or off.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • hardware (HardwarePatch, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_host_groups(references: Optional[List[ReferenceType]] = None, host_group: Optional[HostGroupPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → HostGroupResponse

Modifies a host group. The names query parameter is required.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • host_group (HostGroupPatch, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_hosts(references: Optional[List[ReferenceType]] = None, host: Optional[HostPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → HostResponse

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

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • host (HostPatch, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_kmip(references: Optional[List[ReferenceType]] = None, kmip: Optional[KmipPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → KmipResponse

Modifies one or more attributes of KMIP server objects.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • kmip (KmipPatch, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_network_interfaces(references: Optional[List[ReferenceType]] = None, network: Optional[NetworkInterfacePatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → NetworkInterfaceResponse

Modifies a network interface on a controller.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • network (NetworkInterfacePatch, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

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

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids keyword arguments.

  • local_pods (list[FixedReference], optional) – A list of local_pods to query for. Overrides local_pod_ids and local_pod_names keyword arguments.

  • remotes (list[FixedReference], optional) – A list of remotes to query for. Overrides remote_ids and remote_names keyword arguments.

  • remote_pods (list[FixedReference], optional) – A list of remote_pods to query for. Overrides remote_pod_ids and remote_pod_names keyword arguments.

  • pod_replica_link (PodReplicaLinkPatch, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – Performs the operation on the unique resource IDs specified. 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], optional) – A 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], optional) – A 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], optional) – A list of remote array IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_names query parameter.

  • remote_names (list[str], optional) – A list of remote array names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_ids query parameter.

  • remote_pod_ids (list[str], optional) – A 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], optional) – A 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) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

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

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids keyword arguments.

  • local_pods (list[FixedReference], optional) – A list of local_pods to query for. Overrides local_pod_ids and local_pod_names keyword arguments.

  • pod_replica_links (list[FixedReference], optional) – A list of pod_replica_links to query for. Overrides pod_replica_link_ids keyword arguments.

  • remotes (list[FixedReference], optional) – A list of remotes to query for. Overrides remote_ids and remote_names keyword arguments.

  • remote_pods (list[FixedReference], optional) – A list of remote_pods to query for. Overrides remote_pod_ids and remote_pod_names keyword arguments.

  • remote_policies (list[FixedReference], optional) – A list of remote_policies to query for. Overrides remote_policy_ids and remote_policy_names keyword arguments.

  • mapping (MappingPolicyPatch, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – Performs the operation on the unique resource IDs specified. 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], optional) – A 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], optional) – A 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], optional) – A 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], optional) – A list of remote array IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_names query parameter.

  • remote_names (list[str], optional) – A list of remote array names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_ids query parameter.

  • remote_pod_ids (list[str], optional) – A 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], optional) – A 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], optional) – A 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], optional) – A 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) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_pods(references: Optional[List[ReferenceType]] = None, pod: Optional[PodPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, abort_quiesce: Optional[bool] = None, quiesce: Optional[bool] = None, skip_quiesce: Optional[bool] = None, promote_from: Optional[str] = None, destroy_contents: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PodResponse

Modifies pod details.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • pod (PodPatch, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • abort_quiesce (bool, optional) – 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.

  • quiesce (bool, optional) – 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, optional) – 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.

  • promote_from (str, optional) – 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.

  • destroy_contents (bool, optional) – Set to true to destroy contents (e.g., volumes, protection groups, snapshots) and containers (e.g., pods, volume groups). This enables you to destroy containers with contents.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_policies_alert_watcher(references: Optional[List[ReferenceType]] = None, policy: Optional[PolicyPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyResponse

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

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • policy (PolicyPatch, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – 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], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_policies_alert_watcher_rules(references: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, rules: Optional[PolicyRuleAlertWatcherPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyRuleAlertWatcherResponse

Modifies alert-watcher policy rules.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • rules (PolicyRuleAlertWatcherPatch, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • policy_ids (list[str], optional) – 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], optional) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_policies_autodir(references: Optional[List[ReferenceType]] = None, policy: Optional[PolicyPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyResponse

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

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • policy (PolicyPatch, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – 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], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_policies_nfs(references: Optional[List[ReferenceType]] = None, policy: Optional[PolicyNfsPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyNfsResponse

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

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • policy (PolicyNfsPatch, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_policies_password(references: Optional[List[ReferenceType]] = None, policy: Optional[PolicyPassword] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyPasswordResponse

Modifies one or more password policies. To enable a policy, set enabled=true. To disable a policy, set enabled=false.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • policy (PolicyPassword, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_policies_quota(references: Optional[List[ReferenceType]] = None, policy: Optional[PolicyPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, ignore_usage: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyResponse

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

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • policy (PolicyPatch, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – 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], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • ignore_usage (bool, optional) – 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.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_policies_quota_rules(references: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, rules: Optional[PolicyRuleQuotaPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, ignore_usage: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyRuleQuotaResponse

Modifies quota policy rules.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • rules (PolicyRuleQuotaPatch, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • policy_ids (list[str], optional) – 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], optional) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

  • ignore_usage (bool, optional) – 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.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_policies_smb(references: Optional[List[ReferenceType]] = None, policy: Optional[PolicySmbPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicySmbResponse

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 rename a policy, set name to the new name. The ids or names parameter is required, but they cannot be set together.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • policy (PolicySmbPatch, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_policies_snapshot(references: Optional[List[ReferenceType]] = None, policy: Optional[PolicyPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyResponse

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

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • policy (PolicyPatch, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – 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], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_protection_group_snapshots(references: Optional[List[ReferenceType]] = None, protection_group_snapshot: Optional[ProtectionGroupSnapshotPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ProtectionGroupSnapshotResponse

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

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • protection_group_snapshot (ProtectionGroupSnapshotPatch, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_protection_groups(references: Optional[List[ReferenceType]] = None, protection_group: Optional[ProtectionGroup] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ProtectionGroupResponse

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

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • protection_group (ProtectionGroup, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_protection_groups_targets(groups: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, target: Optional[TargetProtectionGroupPostPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, group_ids: Optional[List[str]] = None, group_names: Optional[List[str]] = None, member_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ProtectionGroupTargetResponse

Modifies the source array to replicate protection group data to the target array, or disallows the source array from replicating protection group data to the target array. 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

  • groups (list[FixedReference], optional) – A list of groups to query for. Overrides group_ids and group_names keyword arguments.

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_names keyword arguments.

  • target (TargetProtectionGroupPostPatch, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • group_ids (list[str], optional) – A list of group IDs.

  • group_names (list[str], optional) – 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], optional) – 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) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_remote_protection_group_snapshots(references: Optional[List[ReferenceType]] = None, remote_protection_group_snapshot: Optional[DestroyedPatchPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, ids: Optional[List[str]] = None, on: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → RemoteProtectionGroupSnapshotResponse

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

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names and ids keyword arguments.

  • remote_protection_group_snapshot (DestroyedPatchPost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • ids (list[str], optional) – 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.

  • on (str, optional) – Performs the operation on the target name specified. For example, targetName01.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_remote_protection_groups(references: Optional[List[ReferenceType]] = None, remote_protection_group: Optional[RemoteProtectionGroup] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, on: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → RemoteProtectionGroupResponse

Configures 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

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • remote_protection_group (RemoteProtectionGroup, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • on (str, optional) – Performs the operation on the target name specified. For example, targetName01.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_remote_volume_snapshots(references: Optional[List[ReferenceType]] = None, remote_volume_snapshot: Optional[DestroyedPatchPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, on: Optional[str] = None, replication_snapshot: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → RemoteVolumeSnapshotResponse

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

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • remote_volume_snapshot (DestroyedPatchPost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • on (str, optional) – Performs the operation on the target name specified. For example, targetName01.

  • replication_snapshot (bool, optional) – 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) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_smi_s(smi_s: Optional[Smis] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SmisResponse

Modifies the Service Location Protocol (SLP) and the SMI-S provider, enabling or disabling them.

Parameters

  • smi_s (Smis, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_smtp_servers(smtp: Optional[SmtpServer] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SmtpServerResponse

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) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_snmp_agents(snmp_agent: Optional[SnmpAgentPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SnmpAgentResponse

Modifies the name or the protocol attributes of the SNMP agent.

Parameters

  • snmp_agent (SnmpAgentPatch, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_snmp_managers(references: Optional[List[ReferenceType]] = None, snmp_manager: Optional[SnmpManagerPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SnmpManagerResponse

Modifies the name or the protocol attributes of the specified SNMP manager.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • snmp_manager (SnmpManagerPatch, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_software_installations(command: Optional[str] = None, current_step_id: Optional[str] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, software_installations: Optional[SoftwareInstallationPatch] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SoftwareInstallationsResponse

Modifies a software upgrade by continuing, retrying, or aborting it. All override_checks are updated before the command being issued if add_override_checks is present. The override_checks parameter is valid when command is continue or retry.

Parameters

  • command (str, required) – 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.

  • current_step_id (str, required) – The current step id of the installation.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • software_installations (SoftwareInstallationPatch, optional) –

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_sso_saml2_idps(references: Optional[List[ReferenceType]] = None, idp: Optional[Saml2SsoPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → Saml2SsoResponse

Modifies one or more attributes of SAML2 SSO configurations.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • idp (Saml2SsoPatch, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_sso_saml2_idps_test(references: Optional[List[ReferenceType]] = None, idp: Optional[Saml2SsoPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → TestResultWithResourcePatchResponse

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

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • idp (Saml2SsoPost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_subnets(references: Optional[List[ReferenceType]] = None, subnet: Optional[SubnetPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SubnetResponse

Modifies one or more specified subnet properties.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • subnet (SubnetPatch, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_support(support: Optional[SupportPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SupportResponse

Creates a connection path from the array to another array.

Parameters

  • support (SupportPatch, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_syslog_servers(references: Optional[List[ReferenceType]] = None, syslog_server: Optional[SyslogServer] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SyslogServerResponse

Modifies the URI of a configured syslog server.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • syslog_server (SyslogServer, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_syslog_servers_settings(syslog_server_settings: Optional[SyslogServerSettings] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SyslogServerSettingsResponse

Modifies syslog settings. Values include continuation_token, items, more_items_remaining, and total_item_count.

Parameters

  • syslog_server_settings (SyslogServerSettings, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_vchosts(references: Optional[List[ReferenceType]] = None, vchost: Optional[VchostPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, ids: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → VchostResponse

Modifies an existing vchost. The names or ids query parameter is required.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names and ids keyword arguments.

  • vchost (VchostPatch, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • ids (list[str], optional) – 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.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_vchosts_certificates(references: Optional[List[ReferenceType]] = None, vchosts: Optional[List[ReferenceType]] = None, certificates: Optional[List[ReferenceType]] = None, certificate: Optional[VchostCertificatePatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, vchost_names: Optional[List[str]] = None, vchost_ids: Optional[List[str]] = None, certificate_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → VchostCertificateResponse

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

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids keyword arguments.

  • vchosts (list[FixedReference], optional) – A list of vchosts to query for. Overrides vchost_names and vchost_ids keyword arguments.

  • certificates (list[FixedReference], optional) – A list of certificates to query for. Overrides certificate_names keyword arguments.

  • certificate (VchostCertificatePatch, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

  • vchost_names (list[str], optional) – Performs the operation on the unique vchost name specified. Enter multiple names in a comma-separated format. For example, vchost01,vchost02.

  • vchost_ids (list[str], optional) – Performs the operation on the unique vchost IDs specified. Enter multiple vchost IDs in a comma-separated format. For example, vchostid01,vchostid02.

  • certificate_names (list[str], optional) – The names of one or more certificates. Enter multiple names in comma-separated format. For example, cert01,cert02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_vchosts_endpoints(references: Optional[List[ReferenceType]] = None, vchosts: Optional[List[ReferenceType]] = None, endpoint: Optional[VchostEndpointPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, vchost_names: Optional[List[str]] = None, vchost_ids: Optional[List[str]] = None, endpoints: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → VchostEndpointResponse

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

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids keyword arguments.

  • vchosts (list[FixedReference], optional) – A list of vchosts to query for. Overrides vchost_names and vchost_ids keyword arguments.

  • endpoint (VchostEndpointPatch, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

  • vchost_names (list[str], optional) – Performs the operation on the unique vchost name specified. Enter multiple names in a comma-separated format. For example, vchost01,vchost02.

  • vchost_ids (list[str], optional) – Performs the operation on the unique vchost IDs specified. Enter multiple vchost IDs in a comma-separated format. For example, vchostid01,vchostid02.

  • endpoints (list[str], optional) – Performs the operation on the unique endpoints specified. Enter multiple endpoints in a comma-separated format.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_virtual_machines(virtual_machine: Optional[VirtualMachinePost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → VirtualMachineResponse

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) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_volume_groups(references: Optional[List[ReferenceType]] = None, volume_group: Optional[VolumeGroupPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, destroy_contents: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → VolumeGroupResponse

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

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • volume_group (VolumeGroupPatch, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • destroy_contents (bool, optional) – Set to true to destroy contents (e.g., volumes, protection groups, snapshots) and containers (e.g., pods, volume groups). This enables you to destroy containers with contents.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_volume_snapshots(references: Optional[List[ReferenceType]] = None, volume_snapshot: Optional[VolumeSnapshotPatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, replication_snapshot: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → VolumeSnapshotResponse

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

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • volume_snapshot (VolumeSnapshotPatch, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • ids (list[str], optional) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • replication_snapshot (bool, optional) – 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) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

patch_volumes(add_to_protection_groups: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, remove_from_protection_groups: Optional[List[ReferenceType]] = None, volume: Optional[VolumePatch] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, add_to_protection_group_ids: Optional[List[str]] = None, add_to_protection_group_names: Optional[List[str]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, remove_from_protection_group_ids: Optional[List[str]] = None, remove_from_protection_group_names: Optional[List[str]] = None, truncate: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → VolumeResponse

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

  • add_to_protection_groups (list[FixedReference], 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.

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • remove_from_protection_groups (list[FixedReference], 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.

  • volume (VolumePatch, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • add_to_protection_group_ids (list[str], optional) – 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], optional) – 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.

  • ids (list[str], optional) – 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], optional) – 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], optional) – 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], optional) – 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, optional) – 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) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_active_directory(references: Optional[List[ReferenceType]] = None, names: Optional[List[str]] = None, active_directory: Optional[ActiveDirectoryPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, join_existing_account: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ActiveDirectoryResponse

Creates one or more Active Directory accounts. The user and password provided are used to join the array to the specified domain.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • names (list[str], required) – Performs the operation on the unique name specified. For example, name01. Enter multiple names in comma-separated format.

  • active_directory (ActiveDirectoryPost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • join_existing_account (bool, optional) – If specified as true, the domain is searched for a pre-existing computer account to join to, and no new account will be created within the domain. The user specified when joining 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) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_admins(references: Optional[List[ReferenceType]] = None, admin: Optional[AdminPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → AdminResponse

Creates an administrator.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • admin (AdminPost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_admins_api_tokens(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, timeout: Optional[int] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → AdminApiTokenResponse

Creates API tokens for the specified administrators.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • timeout (int, optional) – The duration of API token validity, in milliseconds.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_alert_watchers(references: Optional[List[ReferenceType]] = None, names: Optional[List[str]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, alert_watcher: Optional[AlertWatcherPost] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → AlertWatcherResponse

Creates one or more alert watcher email addresses, adding them to the list of alert watchers.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • names (list[str], required) – Performs the operation on the unique name specified. For example, name01. Enter multiple names in comma-separated format.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • alert_watcher (AlertWatcherPost, optional) –

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_alerts_rules(code: Optional[int] = None, parameter: Optional[str] = None, alert_rule: Optional[AlertRules] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → AlertRulesResponse

Creates an alert rule with a custom value.

Parameters

  • code (int, required) – The alert code that the rule applies to. Available alert codes for customization can be found in the alert rules catalog.

  • parameter (str, required) – 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.

  • alert_rule (AlertRules, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_api_clients(references: Optional[List[ReferenceType]] = None, api_clients: Optional[ApiClientPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ApiClientResponse

Creates an API client. Newly created API clients are disabled by default. Enable an API client through the PATCH method. The names, max_role, issuer, and public_key parameters are required.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • api_clients (ApiClientPost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_array_connections(array_connection: Optional[ArrayConnectionPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ArrayConnectionResponse

Creates a connection between this array and the specified array.

Parameters

  • array_connection (ArrayConnectionPost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_arrays_erasures(eradicate_all_data: Optional[bool] = None, preserve_configuration_data: Optional[List[str]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, skip_phonehome_check: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ArrayErasureResponse

Creates the initiation of the factory reset process

Parameters

  • eradicate_all_data (bool, required) – Set to true to perform a factory reset.

  • preserve_configuration_data (list[str], required) – A list of configuration data types to preserve. A value of all will preserve all configuration data types. Valid values include all.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • skip_phonehome_check (bool, optional) – 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) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_arrays_factory_reset_token(authorization: Optional[str] = None, x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ArrayFactoryResetTokenResponse

Creates a token that can be used to perform a factory reset on the array. Factory reset tokens can only be created after the array has been prepared for reset (e.g., all 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

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_certificates(references: Optional[List[ReferenceType]] = None, certificate: Optional[CertificatePost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → CertificateResponse

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

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • certificate (CertificatePost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_certificates_certificate_signing_requests(certificate: Optional[CertificateSigningRequestPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → CertificateSigningRequestResponse

Creates a certificate signing request based on the certificate type and parameters.

Parameters

  • certificate (CertificateSigningRequestPost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_connections(host_groups: Optional[List[ReferenceType]] = None, hosts: Optional[List[ReferenceType]] = None, volumes: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, host_group_names: Optional[List[str]] = None, host_names: Optional[List[str]] = None, volume_names: Optional[List[str]] = None, volume_ids: Optional[List[str]] = None, connection: Optional[ConnectionPost] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ConnectionResponse

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

  • host_groups (list[FixedReference], optional) – A list of host_groups to query for. Overrides host_group_names keyword arguments.

  • hosts (list[FixedReference], optional) – A list of hosts to query for. Overrides host_names keyword arguments.

  • volumes (list[FixedReference], optional) – A list of volumes to query for. Overrides volume_names and volume_ids keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • host_group_names (list[str], optional) – 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], optional) – 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_names (list[str], optional) – 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).

  • volume_ids (list[str], optional) – 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.

  • connection (ConnectionPost, optional) –

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_directories(references: Optional[List[ReferenceType]] = None, file_systems: Optional[List[ReferenceType]] = None, directory: Optional[DirectoryPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, file_system_names: Optional[List[str]] = None, file_system_ids: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → DirectoryResponse

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

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • file_systems (list[FixedReference], optional) – A list of file_systems to query for. Overrides file_system_names and file_system_ids keyword arguments.

  • directory (DirectoryPost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • file_system_names (list[str], optional) – Performs the operation on the file system name specified. Enter multiple file system names in comma-separated format. For example, filesystem01,filesystem02.

  • file_system_ids (list[str], optional) – 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.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_directories_locks_nlm_reclamations(x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → DirectoryLockNlmReclamationResponse

NLM reclamation is a system-wide operation, affecting all clients, and so only one may be in progress at a time. Attempting to initiate reclamation while one is in progress will result in an error. When NLM reclamation is initiated, all NLM locks are deleted and client applications are notified that they can reacquire their locks within a grace period.

Parameters

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_directories_policies_autodir(members: Optional[List[ReferenceType]] = None, policies: Optional[DirectoryPolicyPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberResponse

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

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

  • policies (DirectoryPolicyPost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • member_ids (list[str], optional) – 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], optional) – 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) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_directories_policies_nfs(members: Optional[List[ReferenceType]] = None, policies: Optional[DirectoryPolicyExportPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberExportResponse

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

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

  • policies (DirectoryPolicyExportPost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • member_ids (list[str], optional) – 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], optional) – 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) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_directories_policies_quota(members: Optional[List[ReferenceType]] = None, policies: Optional[DirectoryPolicyPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, ignore_usage: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberResponse

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

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

  • policies (DirectoryPolicyPost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • member_ids (list[str], optional) – 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], optional) – 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.

  • ignore_usage (bool, optional) – 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.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_directories_policies_smb(members: Optional[List[ReferenceType]] = None, policies: Optional[DirectoryPolicyExportPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberExportResponse

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

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

  • policies (DirectoryPolicyExportPost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • member_ids (list[str], optional) – 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], optional) – 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) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_directories_policies_snapshot(members: Optional[List[ReferenceType]] = None, policies: Optional[DirectoryPolicyPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, member_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberResponse

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

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_ids and member_names keyword arguments.

  • policies (DirectoryPolicyPost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • member_ids (list[str], optional) – 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], optional) – 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) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_directory_exports(directories: Optional[List[ReferenceType]] = None, policies: Optional[List[ReferenceType]] = None, exports: Optional[DirectoryExportPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, directory_ids: Optional[List[str]] = None, directory_names: Optional[List[str]] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → DirectoryExportResponse

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

  • directories (list[FixedReference], optional) – A list of directories to query for. Overrides directory_ids and directory_names keyword arguments.

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • exports (DirectoryExportPost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • directory_ids (list[str], optional) – 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], optional) – 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], optional) – 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], optional) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_directory_services_local_groups(references: Optional[List[ReferenceType]] = None, names: Optional[List[str]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, local_group: Optional[LocalGroupPost] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → LocalGroupResponse

Creates a local group.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • names (list[str], required) – Performs the operation on the unique name specified. For example, name01. Enter multiple names in comma-separated format.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • local_group (LocalGroupPost, optional) –

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_directory_services_local_groups_members(groups: Optional[List[ReferenceType]] = None, local_membership: Optional[LocalGroupMembershipPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, group_names: Optional[List[str]] = None, group_sids: Optional[List[str]] = None, group_gids: Optional[List[int]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → LocalMembershipResponse

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

  • groups (list[FixedReference], optional) – A list of groups to query for. Overrides group_names keyword arguments.

  • local_membership (LocalGroupMembershipPost, required) – The member_names, member_sids, or member_gids parameter is required, but cannot be set together.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • group_names (list[str], optional) – Performs the operation on the group names specified. Enter multiple group names in comma-separated format. For example, group1,group2.

  • group_sids (list[str], optional) – 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.

  • group_gids (list[int], optional) – Performs the operation on the specified GIDs. Enter multiple GIDs in comma- separated format. For example, 4234235,9681923.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_directory_services_local_users(references: Optional[List[ReferenceType]] = None, names: Optional[List[str]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, local_user: Optional[LocalUserPost] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → LocalUserResponse

Creates a local user.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • names (list[str], required) – Performs the operation on the unique name specified. For example, name01. Enter multiple names in comma-separated format.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • local_user (LocalUserPost, optional) –

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_directory_services_local_users_members(members: Optional[List[ReferenceType]] = None, local_membership: Optional[LocalUserMembershipPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, member_names: Optional[List[str]] = None, member_sids: Optional[List[str]] = None, member_ids: Optional[List[int]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → LocalMembershipResponse

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

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_names and member_ids keyword arguments.

  • local_membership (LocalUserMembershipPost, required) – The group_names, group_sids, or group_gids parameter is required, but cannot be set together.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • member_names (list[str], optional) – 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], optional) – 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_ids (list[int], optional) – 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.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_directory_services_roles(references: Optional[List[ReferenceType]] = None, names: Optional[List[str]] = None, directory_service_roles: Optional[DirectoryServiceRole] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → DirectoryServiceRoleResponse

Add group to role mapping

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • names (list[str], required) – Performs the operation on the unique names specified. For example, GroupRoleMappingName. Enter multiple names in comma-separated format.

  • directory_service_roles (DirectoryServiceRole, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_directory_snapshots(sources: Optional[List[ReferenceType]] = None, directory_snapshot: Optional[DirectorySnapshotPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, source_ids: Optional[List[str]] = None, source_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → DirectorySnapshotResponse

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

  • sources (list[FixedReference], optional) – A list of sources to query for. Overrides source_ids and source_names keyword arguments.

  • directory_snapshot (DirectorySnapshotPost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • source_ids (list[str], optional) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

  • source_names (list[str], optional) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_dns(references: Optional[List[ReferenceType]] = None, dns: Optional[DnsPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → DnsResponse

Creates new DNS configuration with parameters including the domain suffix, the list of DNS name server IP addresses, and the list of services that DNS parameters apply to.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • dns (DnsPost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_file_systems(references: Optional[List[ReferenceType]] = None, names: Optional[List[str]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → FileSystemResponse

Creates one or more file systems.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • names (list[str], required) – Performs the operation on the unique name specified. For example, name01. Enter multiple names in comma-separated format.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_files(directories: Optional[List[ReferenceType]] = None, source_file: Optional[FilePost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, directory_ids: Optional[List[str]] = None, directory_names: Optional[List[str]] = None, paths: Optional[List[str]] = None, overwrite: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → None

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

  • directories (list[FixedReference], optional) – A list of directories to query for. Overrides directory_ids and directory_names keyword arguments.

  • source_file (FilePost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • directory_ids (list[str], optional) – 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], optional) – 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.

  • paths (list[str], optional) – 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.

  • overwrite (bool, optional) – 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) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_host_groups(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → HostGroupResponse

Creates a host group. The names query parameter is required.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_host_groups_hosts(groups: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, group_names: Optional[List[str]] = None, member_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → MemberNoIdAllResponse

Adds a host to a host group. Adding a host 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

  • groups (list[FixedReference], optional) – A list of groups to query for. Overrides group_names keyword arguments.

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • group_names (list[str], optional) – 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], optional) – 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) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_host_groups_protection_groups(groups: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, group_ids: Optional[List[str]] = None, group_names: Optional[List[str]] = None, member_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → MemberNoIdMemberResponse

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

  • groups (list[FixedReference], optional) – A list of groups to query for. Overrides group_ids and group_names keyword arguments.

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • group_ids (list[str], optional) – A list of group IDs.

  • group_names (list[str], optional) – 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], optional) – 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) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_hosts(references: Optional[List[ReferenceType]] = None, host: Optional[HostPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → HostResponse

Creates a host. The names query parameter is required.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • host (HostPost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_hosts_host_groups(groups: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, group_names: Optional[List[str]] = None, member_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → MemberNoIdAllResponse

Adds a host to a host group. Adding a host 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

  • groups (list[FixedReference], optional) – A list of groups to query for. Overrides group_names keyword arguments.

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • group_names (list[str], optional) – 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], optional) – 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) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_hosts_protection_groups(groups: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, group_ids: Optional[List[str]] = None, group_names: Optional[List[str]] = None, member_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → MemberNoIdMemberResponse

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

  • groups (list[FixedReference], optional) – A list of groups to query for. Overrides group_ids and group_names keyword arguments.

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • group_ids (list[str], optional) – A list of group IDs.

  • group_names (list[str], optional) – 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], optional) – 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) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_kmip(references: Optional[List[ReferenceType]] = None, kmip: Optional[KmipPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → KmipResponse

Creates KMIP server objects.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • kmip (KmipPost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_maintenance_windows(references: Optional[List[ReferenceType]] = None, maintenance_window: Optional[MaintenanceWindowPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → MaintenanceWindowsResponse

Creates a maintenance window that suppresses alerts for a specified period of time. A maintenance window can be manually closed at any time. The names and timeout parameters are required. Set the names parameter to environment.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • maintenance_window (MaintenanceWindowPost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_network_interfaces(references: Optional[List[ReferenceType]] = None, network: Optional[NetworkInterfacePost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → NetworkInterfaceResponse

Creates a network interface on a controller on the array.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • network (NetworkInterfacePost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_offloads(references: Optional[List[ReferenceType]] = None, offload: Optional[OffloadPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, initialize: Optional[bool] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → OffloadResponse

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

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • offload (OffloadPost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • initialize (bool, optional) – 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], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

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

  • local_pods (list[FixedReference], optional) – A list of local_pods to query for. Overrides local_pod_ids and local_pod_names keyword arguments.

  • remotes (list[FixedReference], optional) – A list of remotes to query for. Overrides remote_ids and remote_names keyword arguments.

  • remote_pods (list[FixedReference], optional) – A list of remote_pods to query for. Overrides remote_pod_ids and remote_pod_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • local_pod_ids (list[str], optional) – A 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], optional) – A 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], optional) – A list of remote array IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_names query parameter.

  • remote_names (list[str], optional) – A list of remote array names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_ids query parameter.

  • remote_pod_ids (list[str], optional) – A 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], optional) – A 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) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_pods(references: Optional[List[ReferenceType]] = None, pod: Optional[PodPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, allow_throttle: Optional[bool] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PodResponse

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

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • pod (PodPost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_throttle (bool, optional) – If set to true, allows operation to fail if array health is not optimal.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_pods_arrays(groups: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, group_names: Optional[List[str]] = None, group_ids: Optional[List[str]] = None, member_names: Optional[List[str]] = None, member_ids: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → MemberResponse

Stretches a pod 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.

Parameters

  • groups (list[FixedReference], optional) – A list of groups to query for. Overrides group_names and group_ids keyword arguments.

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_names and member_ids keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • group_names (list[str], optional) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

  • group_ids (list[str], optional) – A list of group IDs.

  • member_names (list[str], optional) – 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_ids (list[str], optional) – 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.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_pods_test(references: Optional[List[ReferenceType]] = None, pod: Optional[PodPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, allow_throttle: Optional[bool] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → TestResultWithResourceWithIdPostResponse

Creates an attempt to clone a pod on the local array without actually cloning it, to test if the pod can be successfully cloned. It does not suppport pod creation.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • pod (PodPost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_throttle (bool, optional) – If set to true, allows operation to fail if array health is not optimal.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_policies_alert_watcher(references: Optional[List[ReferenceType]] = None, sources: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, source_ids: Optional[List[str]] = None, source_names: Optional[List[str]] = None, policy: Optional[PolicyPost] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyResponse

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

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • sources (list[FixedReference], optional) – A list of sources to query for. Overrides source_ids and source_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • source_ids (list[str], optional) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

  • source_names (list[str], optional) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

  • policy (PolicyPost, optional) –

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_policies_alert_watcher_members(policies: Optional[List[ReferenceType]] = None, members: Optional[PolicyMemberPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberResponse

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

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • members (PolicyMemberPost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • policy_ids (list[str], optional) – 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], optional) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_policies_alert_watcher_rules(policies: Optional[List[ReferenceType]] = None, rules: Optional[PolicyRuleAlertWatcherPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyRuleAlertWatcherResponse

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

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • rules (PolicyRuleAlertWatcherPost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • policy_ids (list[str], optional) – 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], optional) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_policies_autodir(references: Optional[List[ReferenceType]] = None, sources: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, source_ids: Optional[List[str]] = None, source_names: Optional[List[str]] = None, policy: Optional[PolicyPost] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyResponse

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

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • sources (list[FixedReference], optional) – A list of sources to query for. Overrides source_ids and source_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • source_ids (list[str], optional) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

  • source_names (list[str], optional) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

  • policy (PolicyPost, optional) –

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_policies_autodir_members(policies: Optional[List[ReferenceType]] = None, members: Optional[PolicyMemberPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberResponse

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

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • members (PolicyMemberPost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • policy_ids (list[str], optional) – 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], optional) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_policies_nfs(references: Optional[List[ReferenceType]] = None, sources: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, source_ids: Optional[List[str]] = None, source_names: Optional[List[str]] = None, policy: Optional[PolicyNfsPost] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyNfsResponse

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

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • sources (list[FixedReference], optional) – A list of sources to query for. Overrides source_ids and source_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • source_ids (list[str], optional) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

  • source_names (list[str], optional) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

  • policy (PolicyNfsPost, optional) –

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_policies_nfs_client_rules(policies: Optional[List[ReferenceType]] = None, rules: Optional[PolicyRuleNfsClientPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyRuleNfsClientResponse

Creates one or more NFS client policy rules. The policy_ids or policy_names parameter is required, but cannot be set together.

Parameters

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • rules (PolicyRuleNfsClientPost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • policy_ids (list[str], optional) – 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], optional) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_policies_nfs_members(policies: Optional[List[ReferenceType]] = None, members: Optional[PolicyMemberExportPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberExportResponse

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

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • members (PolicyMemberExportPost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • policy_ids (list[str], optional) – 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], optional) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_policies_quota(references: Optional[List[ReferenceType]] = None, sources: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, source_ids: Optional[List[str]] = None, source_names: Optional[List[str]] = None, policy: Optional[PolicyPost] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyResponse

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

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • sources (list[FixedReference], optional) – A list of sources to query for. Overrides source_ids and source_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • source_ids (list[str], optional) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

  • source_names (list[str], optional) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

  • policy (PolicyPost, optional) –

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_policies_quota_members(policies: Optional[List[ReferenceType]] = None, members: Optional[PolicyMemberPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, ignore_usage: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberResponse

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

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • members (PolicyMemberPost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • policy_ids (list[str], optional) – 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], optional) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

  • ignore_usage (bool, optional) – 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.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_policies_quota_rules(policies: Optional[List[ReferenceType]] = None, rules: Optional[PolicyRuleQuotaPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, ignore_usage: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyRuleQuotaResponse

Creates one or more quota policy rules. The policy_ids or policy_names parameter is required, but cannot be set together.

Parameters

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • rules (PolicyRuleQuotaPost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • policy_ids (list[str], optional) – 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], optional) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

  • ignore_usage (bool, optional) – 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.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_policies_smb(references: Optional[List[ReferenceType]] = None, sources: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, source_ids: Optional[List[str]] = None, source_names: Optional[List[str]] = None, policy: Optional[PolicySmbPost] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicySmbResponse

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.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • sources (list[FixedReference], optional) – A list of sources to query for. Overrides source_ids and source_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • source_ids (list[str], optional) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

  • source_names (list[str], optional) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

  • policy (PolicySmbPost, optional) –

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_policies_smb_client_rules(policies: Optional[List[ReferenceType]] = None, rules: Optional[PolicyRuleSmbClientPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyRuleSmbClientResponse

Creates one or more SMB client policy rules. The policy_ids or policy_names parameter is required, but cannot be set together.

Parameters

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • rules (PolicyRuleSmbClientPost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • policy_ids (list[str], optional) – 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], optional) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_policies_smb_members(policies: Optional[List[ReferenceType]] = None, members: Optional[PolicyMemberExportPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberExportResponse

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

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • members (PolicyMemberExportPost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • policy_ids (list[str], optional) – 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], optional) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_policies_snapshot(references: Optional[List[ReferenceType]] = None, sources: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, source_ids: Optional[List[str]] = None, source_names: Optional[List[str]] = None, policy: Optional[PolicyPost] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyResponse

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

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • sources (list[FixedReference], optional) – A list of sources to query for. Overrides source_ids and source_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • source_ids (list[str], optional) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

  • source_names (list[str], optional) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

  • policy (PolicyPost, optional) –

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_policies_snapshot_members(policies: Optional[List[ReferenceType]] = None, members: Optional[PolicyMemberPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyMemberResponse

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

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • members (PolicyMemberPost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • policy_ids (list[str], optional) – 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], optional) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_policies_snapshot_rules(policies: Optional[List[ReferenceType]] = None, rules: Optional[PolicyRuleSnapshotPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, policy_ids: Optional[List[str]] = None, policy_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → PolicyRuleSnapshotResponse

Creates one or more snapshot policy rules. The policy_ids or policy_names parameter is required, but cannot be set together.

Parameters

  • policies (list[FixedReference], optional) – A list of policies to query for. Overrides policy_ids and policy_names keyword arguments.

  • rules (PolicyRuleSnapshotPost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • policy_ids (list[str], optional) – 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], optional) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_protection_group_snapshots(sources: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, apply_retention: Optional[bool] = None, for_replication: Optional[bool] = None, replicate: Optional[bool] = None, replicate_now: Optional[bool] = None, allow_throttle: Optional[bool] = None, source_ids: Optional[List[str]] = None, source_names: Optional[List[str]] = None, protection_group_snapshot: Optional[ProtectionGroupSnapshotPost] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ProtectionGroupSnapshotResponse

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 (list[FixedReference], optional) – A list of sources to query for. Overrides source_ids and source_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • apply_retention (bool, optional) – If true, applies the local and remote retention policy to the snapshots.

  • for_replication (bool, optional) – If true, destroys and eradicates the snapshot after 1 hour.

  • replicate (bool, optional) – 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, optional) – If set to true, replicates the snapshots to each allowed target. The replicate and replicate_now parameters cannot be used together.

  • allow_throttle (bool, optional) – If set to true, allows snapshot to fail if array health is not optimal.

  • source_ids (list[str], optional) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

  • source_names (list[str], optional) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

  • protection_group_snapshot (ProtectionGroupSnapshotPost, optional) –

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_protection_group_snapshots_replica(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, convert_source_to_baseline: Optional[bool] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, on: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ProtectionGroupSnapshotReplicaResponse

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 (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • convert_source_to_baseline (bool, optional) – Set to true to have the snapshot be eradicated when it is no longer baseline on source.

  • ids (list[str], optional) – 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], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • on (list[str], optional) – 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) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_protection_group_snapshots_test(sources: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, apply_retention: Optional[bool] = None, for_replication: Optional[bool] = None, replicate: Optional[bool] = None, replicate_now: Optional[bool] = None, allow_throttle: Optional[bool] = None, source_ids: Optional[List[str]] = None, source_names: Optional[List[str]] = None, protection_group_snapshot: Optional[ProtectionGroupSnapshotPost] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → TestResultWithResourceWithIdPostResponse

Creates an attempt to take the protection group snapshot, without actually taking it, to test if the snapshot can be successfully taken.

Parameters

  • sources (list[FixedReference], optional) – A list of sources to query for. Overrides source_ids and source_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • apply_retention (bool, optional) – If true, applies the local and remote retention policy to the snapshots.

  • for_replication (bool, optional) – If true, destroys and eradicates the snapshot after 1 hour.

  • replicate (bool, optional) – 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, optional) – If set to true, replicates the snapshots to each allowed target. The replicate and replicate_now parameters cannot be used together.

  • allow_throttle (bool, optional) – If set to true, allows snapshot to fail if array health is not optimal.

  • source_ids (list[str], optional) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

  • source_names (list[str], optional) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

  • protection_group_snapshot (ProtectionGroupSnapshotPost, optional) –

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_protection_groups(references: Optional[List[ReferenceType]] = None, sources: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, source_ids: Optional[List[str]] = None, source_names: Optional[List[str]] = None, overwrite: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ProtectionGroupResponse

Creates a protection group on the local array for asynchronous replication.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • sources (list[FixedReference], optional) – A list of sources to query for. Overrides source_ids and source_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • source_ids (list[str], optional) – 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], optional) – 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.

  • overwrite (bool, optional) – 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) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_protection_groups_host_groups(groups: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, group_ids: Optional[List[str]] = None, group_names: Optional[List[str]] = None, member_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → MemberNoIdMemberResponse

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

  • groups (list[FixedReference], optional) – A list of groups to query for. Overrides group_ids and group_names keyword arguments.

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • group_ids (list[str], optional) – A list of group IDs.

  • group_names (list[str], optional) – 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], optional) – 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) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_protection_groups_hosts(groups: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, group_ids: Optional[List[str]] = None, group_names: Optional[List[str]] = None, member_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → MemberNoIdMemberResponse

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

  • groups (list[FixedReference], optional) – A list of groups to query for. Overrides group_ids and group_names keyword arguments.

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • group_ids (list[str], optional) – A list of group IDs.

  • group_names (list[str], optional) – 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], optional) – 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) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_protection_groups_targets(groups: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, group_ids: Optional[List[str]] = None, group_names: Optional[List[str]] = None, member_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ProtectionGroupTargetResponse

Creates an action to add an array 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 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

  • groups (list[FixedReference], optional) – A list of groups to query for. Overrides group_ids and group_names keyword arguments.

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • group_ids (list[str], optional) – A list of group IDs.

  • group_names (list[str], optional) – 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], optional) – 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) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_protection_groups_volumes(groups: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, group_ids: Optional[List[str]] = None, group_names: Optional[List[str]] = None, member_names: Optional[List[str]] = None, member_ids: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ProtectionGroupsVolumesResponse

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

  • groups (list[FixedReference], optional) – A list of groups to query for. Overrides group_ids and group_names keyword arguments.

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_names and member_ids keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • group_ids (list[str], optional) – A list of group IDs.

  • group_names (list[str], optional) – 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], optional) – 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_ids (list[str], optional) – 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.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_remote_protection_group_snapshots(references: Optional[List[ReferenceType]] = None, sources: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, apply_retention: Optional[bool] = None, convert_source_to_baseline: Optional[bool] = None, for_replication: Optional[bool] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, replicate: Optional[bool] = None, replicate_now: Optional[bool] = None, allow_throttle: Optional[bool] = None, source_names: Optional[List[str]] = None, source_ids: Optional[List[str]] = None, on: Optional[str] = None, remote_protection_group_snapshot: Optional[RemoteProtectionGroupSnapshotPost] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → RemoteProtectionGroupSnapshotResponse

Creates remote protection group snapshots.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • sources (list[FixedReference], optional) – A list of sources to query for. Overrides source_names and source_ids keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • apply_retention (bool, optional) – If true, applies the local and remote retention policy to the snapshots.

  • convert_source_to_baseline (bool, optional) – Set to true to have the snapshot be eradicated when it is no longer baseline on source.

  • for_replication (bool, optional) – If true, destroys and eradicates the snapshot after 1 hour.

  • ids (list[str], optional) – 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], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • replicate (bool, optional) – 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, optional) – If set to true, replicates the snapshots to each allowed target. The replicate and replicate_now parameters cannot be used together.

  • allow_throttle (bool, optional) – If set to true, allows snapshot to fail if array health is not optimal.

  • source_names (list[str], optional) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

  • source_ids (list[str], optional) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

  • on (str, optional) – Performs the operation on the target name specified. For example, targetName01.

  • remote_protection_group_snapshot (RemoteProtectionGroupSnapshotPost, optional) –

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_remote_protection_group_snapshots_test(references: Optional[List[ReferenceType]] = None, sources: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, apply_retention: Optional[bool] = None, convert_source_to_baseline: Optional[bool] = None, for_replication: Optional[bool] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, replicate: Optional[bool] = None, replicate_now: Optional[bool] = None, allow_throttle: Optional[bool] = None, source_ids: Optional[List[str]] = None, source_names: Optional[List[str]] = None, on: Optional[str] = None, remote_protection_group_snapshot: Optional[RemoteProtectionGroupSnapshotPost] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → TestResultWithResourceWithIdPostResponse

Create an attempt to take a remote protection group snapshot without actually taking it, to test if the snapshot can be successfully taken.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides ids and names keyword arguments.

  • sources (list[FixedReference], optional) – A list of sources to query for. Overrides source_ids and source_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • apply_retention (bool, optional) – If true, applies the local and remote retention policy to the snapshots.

  • convert_source_to_baseline (bool, optional) – Set to true to have the snapshot be eradicated when it is no longer baseline on source.

  • for_replication (bool, optional) – If true, destroys and eradicates the snapshot after 1 hour.

  • ids (list[str], optional) – 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], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • replicate (bool, optional) – 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, optional) – If set to true, replicates the snapshots to each allowed target. The replicate and replicate_now parameters cannot be used together.

  • allow_throttle (bool, optional) – If set to true, allows snapshot to fail if array health is not optimal.

  • source_ids (list[str], optional) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

  • source_names (list[str], optional) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

  • on (str, optional) – Performs the operation on the target name specified. For example, targetName01.

  • remote_protection_group_snapshot (RemoteProtectionGroupSnapshotPost, optional) –

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_remote_volume_snapshots(sources: Optional[List[ReferenceType]] = None, remote_volume_snapshot: Optional[RemoteVolumeSnapshotPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, source_ids: Optional[List[str]] = None, source_names: Optional[List[str]] = None, on: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → RemoteVolumeSnapshotResponse

Creates a volume snapshot on the specified connected remote target or offload target.

Parameters

  • sources (list[FixedReference], optional) – A list of sources to query for. Overrides source_ids and source_names keyword arguments.

  • remote_volume_snapshot (RemoteVolumeSnapshotPost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • source_ids (list[str], optional) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

  • source_names (list[str], optional) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

  • on (str, optional) – Performs the operation on the target name specified. For example, targetName01.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_snmp_managers(references: Optional[List[ReferenceType]] = None, snmp_manager: Optional[SnmpManagerPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SnmpManagerResponse

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

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • snmp_manager (SnmpManagerPost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_software(software: Optional[SoftwarePost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SoftwareResponse

Creates a software package download.

Parameters

  • software (SoftwarePost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_software_bundle(source: Optional[SoftwareBundlePost] = None, x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SoftwareBundleResponse

Creates and initiates a software bundle download.

Parameters

  • source (SoftwareBundlePost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_software_check(softwares: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, software_versions: Optional[List[str]] = None, software_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SoftwareChecksResponse

Creates a software check task. 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 (list[FixedReference], optional) – A list of softwares to query for. Overrides software_names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • software_versions (list[str], optional) – A list of target software versions.

  • software_names (list[str], optional) – A list of software names.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_software_installations(softwares: Optional[List[ReferenceType]] = None, software_ids: Optional[List[str]] = None, software_installations: Optional[SoftwareInstallationPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SoftwareInstallationsResponse

Creates and initiates a software upgrade.

Parameters

  • softwares (list[FixedReference], optional) – A list of softwares to query for. Overrides software_ids keyword arguments.

  • software_ids (list[str], required) – A list of software IDs.

  • software_installations (SoftwareInstallationPost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_software_patches(name: Optional[str] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, allow_ha_reduction: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SoftwarePatchesResponse

Creates software patch download and installation.

Parameters

  • name (str, required) – Name of software patch to install

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_ha_reduction (bool, optional) – 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) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_sso_saml2_idps(references: Optional[List[ReferenceType]] = None, names: Optional[List[str]] = None, idp: Optional[Saml2SsoPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → Saml2SsoResponse

Creates SAML2 SSO configurations.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • names (list[str], required) – Performs the operation on the unique name specified. For example, name01. Enter multiple names in comma-separated format.

  • idp (Saml2SsoPost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_subnets(references: Optional[List[ReferenceType]] = None, names: Optional[List[str]] = None, subnet: Optional[SubnetPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SubnetResponse

Creates a subnet with the specified parameters.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • names (list[str], required) – Performs the operation on the unique name specified. For example, name01. Enter multiple names in comma-separated format.

  • subnet (SubnetPost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_syslog_servers(references: Optional[List[ReferenceType]] = None, syslog_server: Optional[SyslogServer] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → SyslogServerResponse

Creates a new syslog server. Transmission of syslog messages is enabled immediately.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • syslog_server (SyslogServer, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_vchost_connections(protocol_endpoints: Optional[List[ReferenceType]] = None, vchosts: Optional[List[ReferenceType]] = None, all_vchosts: Optional[bool] = None, allow_stretched_multi_vchost: Optional[bool] = None, authorization: Optional[str] = None, protocol_endpoint_names: Optional[List[str]] = None, protocol_endpoint_ids: Optional[List[str]] = None, x_request_id: Optional[str] = None, vchost_ids: Optional[List[str]] = None, vchost_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → VchostConnectionResponse

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

  • protocol_endpoints (list[FixedReference], optional) – A list of protocol_endpoints to query for. Overrides protocol_endpoint_names and protocol_endpoint_ids keyword arguments.

  • vchosts (list[FixedReference], optional) – A list of vchosts to query for. Overrides vchost_ids and vchost_names keyword arguments.

  • all_vchosts (bool, optional) – 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, optional) – 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_names (list[str], optional) – A 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.

  • protocol_endpoint_ids (list[str], optional) – A 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.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • vchost_ids (list[str], optional) – A 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], optional) – A 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) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_vchosts(references: Optional[List[ReferenceType]] = None, vchost: Optional[VchostPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → VchostResponse

Creates a vchost. The names query parameter is required.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • vchost (VchostPost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_vchosts_certificates(vchosts: Optional[List[ReferenceType]] = None, certificate: Optional[VchostCertificatePost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, vchost_names: Optional[List[str]] = None, vchost_ids: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → VchostCertificateResponse

Creates an association between a certificate and vchost on one or more endpoints. The vchost_names or vchost_ids query parameter is required.

Parameters

  • vchosts (list[FixedReference], optional) – A list of vchosts to query for. Overrides vchost_names and vchost_ids keyword arguments.

  • certificate (VchostCertificatePost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • vchost_names (list[str], optional) – Performs the operation on the unique vchost name specified. Enter multiple names in a comma-separated format. For example, vchost01,vchost02.

  • vchost_ids (list[str], optional) – Performs the operation on the unique vchost IDs specified. Enter multiple vchost IDs in a comma-separated format. For example, vchostid01,vchostid02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_vchosts_endpoints(vchosts: Optional[List[ReferenceType]] = None, endpoint: Optional[VchostEndpointPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, vchost_names: Optional[List[str]] = None, vchost_ids: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → VchostEndpointResponse

Creates a vchost endpoint. Either the vchost_names or vchost_ids query parameter is required.

Parameters

  • vchosts (list[FixedReference], optional) – A list of vchosts to query for. Overrides vchost_names and vchost_ids keyword arguments.

  • endpoint (VchostEndpointPost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • vchost_names (list[str], optional) – Performs the operation on the unique vchost name specified. Enter multiple names in a comma-separated format. For example, vchost01,vchost02.

  • vchost_ids (list[str], optional) – Performs the operation on the unique vchost IDs specified. Enter multiple vchost IDs in a comma-separated format. For example, vchostid01,vchostid02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_virtual_machines(virtual_machine: Optional[VirtualMachinePost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, overwrite: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → VirtualMachineResponse

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) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • overwrite (bool, optional) – 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) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_volume_groups(references: Optional[List[ReferenceType]] = None, volume_group: Optional[VolumeGroupPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → VolumeGroupResponse

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

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • volume_group (VolumeGroupPost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_volume_snapshots(sources: Optional[List[ReferenceType]] = None, volume_snapshot: Optional[VolumeSnapshotPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, on: Optional[str] = None, allow_throttle: Optional[bool] = None, source_ids: Optional[List[str]] = None, source_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → VolumeSnapshotResponse

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

  • sources (list[FixedReference], optional) – A list of sources to query for. Overrides source_ids and source_names keyword arguments.

  • volume_snapshot (VolumeSnapshotPost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • on (str, optional) – Performs the operation on the target name specified. For example, targetName01.

  • allow_throttle (bool, optional) – If set to true, allows snapshot to fail if array health is not optimal.

  • source_ids (list[str], optional) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

  • source_names (list[str], optional) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_volume_snapshots_test(sources: Optional[List[ReferenceType]] = None, volume_snapshot: Optional[VolumeSnapshotPost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, on: Optional[str] = None, allow_throttle: Optional[bool] = None, source_ids: Optional[List[str]] = None, source_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → TestResultWithResourcePostResponse

Creates the volume snapshot path without actually taking a volume snapshot.

Parameters

  • sources (list[FixedReference], optional) – A list of sources to query for. Overrides source_ids and source_names keyword arguments.

  • volume_snapshot (VolumeSnapshotPost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • on (str, optional) – Performs the operation on the target name specified. For example, targetName01.

  • allow_throttle (bool, optional) – If set to true, allows snapshot to fail if array health is not optimal.

  • source_ids (list[str], optional) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

  • source_names (list[str], optional) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_volumes(add_to_protection_groups: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, volume: Optional[VolumePost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, add_to_protection_group_ids: Optional[List[str]] = None, add_to_protection_group_names: Optional[List[str]] = None, allow_throttle: Optional[bool] = None, names: Optional[List[str]] = None, overwrite: Optional[bool] = None, with_default_protection: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → VolumeResponse

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

  • add_to_protection_groups (list[FixedReference], 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.

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • volume (VolumePost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • add_to_protection_group_ids (list[str], optional) – 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], optional) – 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, optional) – If set to true, allows operation to fail if array health is not optimal.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • overwrite (bool, optional) – 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, optional) – 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) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_volumes_batch(volume: Optional[List[VolumeBatchPost]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, allow_throttle: Optional[bool] = None, overwrite: Optional[bool] = None, with_default_protection: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → VolumesBatchResponse

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], required) – A list of volumes to be created or copied.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_throttle (bool, optional) – If set to true, allows operation to fail if array health is not optimal.

  • overwrite (bool, optional) – 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, optional) – 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) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_volumes_batch_test(volume: Optional[List[VolumeBatchPost]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, allow_throttle: Optional[bool] = None, overwrite: Optional[bool] = None, with_default_protection: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → TestResultWithResourceWithIdPostResponse

Creates a dry run attempt to see if copying a list of virtual storage volumes would succeed. No virtual volumes are actually copied or created in this process.

Parameters

  • volume (list[VolumeBatchPost], required) – A list of volumes to be copied.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • allow_throttle (bool, optional) – If set to true, allows operation to fail if array health is not optimal.

  • overwrite (bool, optional) – 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, optional) – 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) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_volumes_protection_groups(groups: Optional[List[ReferenceType]] = None, members: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, group_ids: Optional[List[str]] = None, group_names: Optional[List[str]] = None, member_names: Optional[List[str]] = None, member_ids: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → ProtectionGroupsVolumesResponse

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

  • groups (list[FixedReference], optional) – A list of groups to query for. Overrides group_ids and group_names keyword arguments.

  • members (list[FixedReference], optional) – A list of members to query for. Overrides member_names and member_ids keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • group_ids (list[str], optional) – A list of group IDs.

  • group_names (list[str], optional) – 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], optional) – 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_ids (list[str], optional) – 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.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

post_volumes_test(add_to_protection_groups: Optional[List[ReferenceType]] = None, references: Optional[List[ReferenceType]] = None, volume: Optional[VolumePost] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, add_to_protection_group_ids: Optional[List[str]] = None, add_to_protection_group_names: Optional[List[str]] = None, allow_throttle: Optional[bool] = None, names: Optional[List[str]] = None, overwrite: Optional[bool] = None, with_default_protection: Optional[bool] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → TestResultWithResourceWithIdPostResponse

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

  • add_to_protection_groups (list[FixedReference], 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.

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • volume (VolumePost, required) –

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • add_to_protection_group_ids (list[str], optional) – 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], optional) – 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, optional) – If set to true, allows operation to fail if array health is not optimal.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • overwrite (bool, optional) – 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, optional) – 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) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

put_admins_cache(references: Optional[List[ReferenceType]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → AdminCacheResponse

Updates entries in the cache for administrators who currently do not have a cache entry, otherwise refreshes the existing entry.

Parameters

  • references (list[FixedReference], optional) – A list of references to query for. Overrides names keyword arguments.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • names (list[str], optional) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

put_arrays_cloud_provider_tags_batch(tag: Optional[List[CloudProviderTag]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → CloudProviderTagResponse

Updates users tags to deployed cloud resources of a CBS array.

Parameters

  • tag (list[CloudProviderTag], required) – A list of tags to be created or, if already existing, updated.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

put_arrays_tags(tag: Optional[List[NonCopyableTag]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → TagResponse

Updates tags.

Parameters

  • tag (list[NonCopyableTag], required) – A list of tags to be created or, if already existing, updated.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

put_host_groups_tags_batch(resources: Optional[List[ReferenceType]] = None, tag: Optional[List[NonCopyableTag]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, resource_ids: Optional[List[str]] = None, resource_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → TagResponse

Updates tags.

Parameters

  • resources (list[FixedReference], optional) – A list of resources to query for. Overrides resource_ids and resource_names keyword arguments.

  • tag (list[NonCopyableTag], required) – A list of tags to be created or, if already existing, updated.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • resource_ids (list[str], optional) – A list of resource IDs. The resource_ids or resource_names parameter is required, but they cannot be set together.

  • resource_names (list[str], optional) – A list of resource names. The resource_ids or resource_names parameter is required, but they cannot be set together.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

put_hosts_tags_batch(resources: Optional[List[ReferenceType]] = None, tag: Optional[List[NonCopyableTag]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, resource_ids: Optional[List[str]] = None, resource_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → TagResponse

Updates tags.

Parameters

  • resources (list[FixedReference], optional) – A list of resources to query for. Overrides resource_ids and resource_names keyword arguments.

  • tag (list[NonCopyableTag], required) – A list of tags to be created or, if already existing, updated.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • resource_ids (list[str], optional) – A list of resource IDs. The resource_ids or resource_names parameter is required, but they cannot be set together.

  • resource_names (list[str], optional) – A list of resource names. The resource_ids or resource_names parameter is required, but they cannot be set together.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

put_volume_snapshots_tags_batch(resources: Optional[List[ReferenceType]] = None, tag: Optional[List[Tag]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, resource_ids: Optional[List[str]] = None, resource_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → TagResponse

Updates tags.

Parameters

  • resources (list[FixedReference], optional) – A list of resources to query for. Overrides resource_ids and resource_names keyword arguments.

  • tag (list[Tag], required) – A list of tags to be created or modified.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • resource_ids (list[str], optional) – A list of resource IDs. The resource_ids or resource_names parameter is required, but they cannot be set together.

  • resource_names (list[str], optional) – A list of resource names. The resource_ids or resource_names parameter is required, but they cannot be set together.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

put_volumes_tags_batch(resources: Optional[List[ReferenceType]] = None, tag: Optional[List[Tag]] = None, authorization: Optional[str] = None, x_request_id: Optional[str] = None, resource_ids: Optional[List[str]] = None, resource_names: Optional[List[str]] = None, async_req: bool = False, _return_http_data_only: bool = False, _preload_content: bool = True, _request_timeout: Optional[int] = None) → TagResponse

Updates tags.

Parameters

  • resources (list[FixedReference], optional) – A list of resources to query for. Overrides resource_ids and resource_names keyword arguments.

  • tag (list[Tag], required) – A list of tags to be created or, if already existing, updated.

  • x_request_id (str, optional) – A header to provide to track the API call. Generated by the server if not provided.

  • resource_ids (list[str], optional) – A list of resource IDs. The resource_ids or resource_names parameter is required, but they cannot be set together.

  • resource_names (list[str], optional) – A list of resource names. The resource_ids or resource_names parameter is required, but they cannot be set together.

  • async_req (bool, optional) – Request runs in separate thread and method returns multiprocessing.pool.ApplyResult.

  • _return_http_data_only (bool, optional) – Returns only data field.

  • _preload_content (bool, optional) – Response is converted into objects.

  • _request_timeout (int, optional) – Total request timeout in seconds.

Returns

If the call was successful. ErrorResponse: If the call was not successful.

Return type

ValidResponse

Raises

  • PureError – If calling the API fails.

  • ValueError – If a parameter is of an invalid type.

  • TypeError – If invalid or missing parameters are used.

pypureclient.flasharray.FA_2_34.configuration module

FlashArray REST API

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: 2.34

Generated by: https://github.com/swagger-api/swagger-codegen.git

class pypureclient.flasharray.FA_2_34.configuration.Configuration

Bases: object

__init__()

Constructor

auth_settings()

Gets Auth Settings dict for api client.

Returns

The Auth Settings information dict.

property debug

Debug status

Parameters

value – The debug status, True or False.

Type

bool

get_api_key_with_prefix(identifier)

Gets API key (with prefix if set).

Parameters

identifier – The identifier of apiKey.

Returns

The token for api key authentication.

get_basic_auth_token()

Gets HTTP basic authentication header (string).

Returns

The token for basic HTTP authentication.

property logger_file

The logger file.

If the logger_file is None, then add stream handler and remove file handler. Otherwise, add file handler and remove stream handler.

Parameters

value – The logger_file path.

Type

str

property logger_format

The logger format.

The logger_formatter will be updated when sets logger_format.

Parameters

value – The format string.

Type

str

to_debug_report()

Gets the essential information for debugging.

Returns

The report for debugging.

class pypureclient.flasharray.FA_2_34.configuration.TypeWithDefault(name, bases, dct)

Bases: type

set_default(default)

pypureclient.flasharray.FA_2_34.rest module

FlashArray REST API

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: 2.34

Generated by: https://github.com/swagger-api/swagger-codegen.git

exception pypureclient.flasharray.FA_2_34.rest.ApiException(status=None, reason=None, http_resp=None)

Bases: Exception

__str__()

Custom error messages for exception

class pypureclient.flasharray.FA_2_34.rest.RESTClientObject(configuration, pools_size=4, maxsize=None)

Bases: object

DELETE(url, headers=None, query_params=None, body=None, _preload_content=True, _request_timeout=None)
GET(url, headers=None, query_params=None, _preload_content=True, _request_timeout=None)
HEAD(url, headers=None, query_params=None, _preload_content=True, _request_timeout=None)
OPTIONS(url, headers=None, query_params=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)
PATCH(url, headers=None, query_params=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)
POST(url, headers=None, query_params=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)
PUT(url, headers=None, query_params=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)
request(method, url, query_params=None, headers=None, body=None, post_params=None, _preload_content=True, _request_timeout=None)

Perform requests.

Parameters

  • method – http request method

  • url – http request url

  • query_params – query parameters in the url

  • headers – http request headers

  • body – request json body, for application/json

  • post_params – request post parameters, application/x-www-form-urlencoded and multipart/form-data

  • _preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

class pypureclient.flasharray.FA_2_34.rest.RESTResponse(resp)

Bases: IOBase

getheader(name, default=None)

Returns a given response header.

getheaders()

Returns a dictionary of the response headers.

Module contents

pypureclient.flasharray.FA_2_34.add_properties(model)